LENOVO DOCK
MANAGER APPLICATION
User Manual

Introduction

Dock Manager is designed for Lenovo Enterprise customers who are using Lenovo Dock Devices to: aid with updating the firmware of their Lenovo Dock Devices, run automatic firmware check and download, and provide user friendly prompts for update execution upon firmware download completion. This document demonstrates the transitions within screens along with the actions on how to interact with the application.

Screen Definitions

In the proceeding sections, different screens are stated along with their respective functionalities. The Dock Manager App currently has 2 existing screens: Dock Device Information Screen and Update History Screen; it also supports system tray behavior and a help button on the title bar for accessibility.
2.1 Dock Device Information Screen
The Dock Device Information Screen allows the users to view the information about their dock hardware. The screen also shows the latest firmware version released and allow users to update the firmware manually. 【Check Updates】button – upon click, will check firmware based on the latest update version.
2.2 Update History Screen
The Updates History screen shows all the history of firmware updates executed by the user. History information are also shown through WMI in order for IT Managers to query the list.

NOTE:
The Error Code here is from the dock firmware update process. Each dock has its own list of independent error codes, and the error codes may change with each dock firmware update.
2.3 System Tray Behavior
The system tray provides a convenient way to: open the Dock Manager Application when minimized, click help to access the User Manual, and click about to open the about page. 【Open Dock Manager】button – upon click, will maximize the Dock Manager application.
【About】button – upon click, will show the about page.
2.4 Title Bar Help Button 
The title bar help button is an in-app method to access the: the About section to open the about page. 【About】button – upon click, will show the about page.

2.5 Title Bar Download Button
The title bar download button is used to allow end user to check and download new software version. 【Download】button – upon click, a window will pop up to show whether there is a newer version on the server. And if there is a newer version, end user can update the software by clicking the UPDATE button in pop up window.
Note:
The download button can be hidden. Please refer to chapter 6.7 method ii.

Disable UI when installing

When installing with “DockManagerSetup_X.X.X.X.exe /verysilent /noicons /noui” command, there will not be any icon, even tray icon and it will not show any window except the pop-up window prompting user to choose whether to start the firmware upgrade.

WMI Queries

This section provides WMI queries to access WMI classes via PowerShell; created by the Dock Manager Application and Service. The WMI classes created include: Dock Device for the attached devices; DockDeviceUSB for USB device attached on the dock; DockDeviceDisplay for display device also attached on the dock; and DockManager for the Update History.
4.1 DockDevice Class
DockDevice Class is created when a supported dock is attached. Properties query-able inside the class include: Machine Type, Serial Number and Firmware Version.

NOTE:
For following docks, serial number cannot be displayed, only their MAC address will be displayed.

• ThinkPad Thunderbolt 3 Essential Dock
• ThinkPad Thunderbolt 3 Workstation Dock / ThinkPad Thunderbolt 3 Dock Gen 2
• ThinkPad USB-C Dock Gen 2
• ThinkPad Hybrid USB-C with USB-A Dock
• ThinkPad Thunderbolt 3 Dock
• ThinkPad USB-C Dock

For following docks, both serial number and MAC addresss can be displayed.

• ThinkPad Universal USB-C Dock
• ThinkPad Universal Thunderbolt 4 Dock
• ThinkPad Universal USB-C Smart Dock
• ThinkPad Universal Thunderbolt 4 Smart Dock
• Lenovo USB-C Dock (Windows Only)
• ThinkPad Universal USB-C Dock v2

4.1.1 PowerShell Query
o Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM DockDevice” |
Format-List -Property MachineType,MacAddress,SerialNumber,FWVersion

• Sample Result:

4.2 DockDeviceUSB Class
DockDeviceUSB class is created when a USB device is inserted in a supported dock. Properties query-able inside the class include: Device Type, USB PID, USB VID, and USB Device Manufacturer Name.

4.2.1 PowerShell Query
o Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM DockDeviceUSB ” |
Format-List -Property DeviceType,USB_PID,USB_VID,USBDeviceMFGName,SerialNumber,MacAddress

• Sample Result:

4.3 DockDeviceDisplayPort Class
DockDeviceDisplayPort class is created when a display device is inserted in a supported dock. Properties queryable inside the class include: Monitor EDID, Monitor Manufacturer Name, and Monitor Model Name.

4.3.1 PowerShell Query
o Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM
DockDeviceDisplayPort” | Format-List -Property MonitorEDID,MonitorMFGName,MonitorModelName

• Sample Result:

4.4 DockManager Class
DockManager class is created when user performs an update on through the Dock Manager Application.
Properties query-able inside the class include: Dock ID, Firmware Update Date, New Version, Old Version, and Update Status. 4.4.1 PowerShell Query All Update History
o Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM DockManager” |
Format-List -Property DockId,FWUpdateDate,NewVersion,OldVersion,UpdateStatus

• Sample Result:

4.4.2 PowerShell Query Specific Dock’s Update History
o Select a DockId of a specific dock. (Example: ‘1S40AVZQZ0005Q’)
o Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM DockManager WHERE DockId=’1S40AVZQZ0005Q'” | Format-List -Property DockId,FWUpdateDate,NewVersion,OldVersion,UpdateStatus
4.5 DockInfo Class
DockInfo is a newly WMI information being managed by DockManager application. Properties that can be queried inside the class include: MacAddress, SerialNumber,Date, Machine Type, FW Version, Last Update on, Last Update from, Latest FW, Available FW version, array of USB Devices Info, and array of display devices info. 4.5.1 PowerShell Query (Truncated DockInfo List)
o To get the DockInfo instances along with the truncated usb and display devices:
Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM DockInfo” | Sort-Object {$_.Date -as [datetime]} -Descending | Format-List -Property
AvailableFWVersion,Date,DisplayDevices,FWVersion,LastUpdateOn,LatestFirmwareFlag,MACAddress,Machi neType,SerialNumber,USBDevices 4.5.2 PowerShell Query
o To get the DockInfo instances along with the usb and display devices:
$infos = Get-WmiObject -Namespace “root\Lenovo\Dock_Manager” -Query “SELECT * FROM DockInfo” |
Sort-Object {$_.Date -as [datetime]} -Descending | Select-Object
foreach ($info in $infos) {
Select-Object -InputObject $info -Property
AvailableFWVersion,Date,FWVersion,LastUpdateOn,LatestFirmwareFlag,MACAddress,MachineType,SerialNu
mber;
For ($i=0;$i -lt $info.DisplayDevices.Length;$i++) {
Write-Host ‘Display'($i+1);
Select-Object -InputObject $info.DisplayDevices[$i] -Property
DeviceID,DockType,MACAddress,MonitorEDID,MonitorMFGName,MonitorModelName,SerialNumber;
}
For ($i=0;$i -lt $info.USBDevices.Length;$i++) {
Write-Host ‘USB'($i+1);
Select-Object -InputObject $info.USBDevices[$i] -Property
MACAddress,SerialNumber,DeviceType,USB_PID,USB_VID,USBDeviceMFGName;
}
}

Firmware Download and Update Behavior

The proceeding section presents illustrations that shows the notification flow when the Dock Manager pplication is hidden in the system tray. Illustrated are three types of expected behaviors: Default Behavior, No User Confirmation, and Silent Mode.
5.1 Default Behavior
The default behavior flow notifies the user to update the firmware when download is complete. The flow is illustrated below (see Figure 12. Default Behavior Flow) 5.2 No User Confirmation
When AskBeforeFirmwareUpdate is set to NO in the registry; upon firmware download completion, the downloaded firmware update will proceed to execute without prompting the users. (see Figure 13. No User Confirmation)

5.3 Silent Mode
When AskBeforeFirmwareUpdate and EnableNotifications is set to NO in the registry, the firmware update flow will proceed to download and execute update in the background without notifications and prompts for the user.
NOTE:
For following docks, default behavior need user confirm in the dialog box, and they can be configured to no user confirm or silent mode.

• Lenovo USB-C Dock (Windows Only)
• ThinkPad Thunderbolt 3 Essential Dock
• ThinkPad Thunderbolt 3 Workstation Dock / ThinkPad Thunderbolt 3 Dock Gen 2
• ThinkPad USB-C Dock Gen 2
• ThinkPad Hybrid USB-C with USB-A Dock
• ThinkPad Thunderbolt 3 Dock
• ThinkPad USB-C Dock

For following docks, default behavior is no user confirm, they don’t need to set AskBeforeFirmwareUpdate to
NO. They can be configured to silent mode.

• ThinkPad Universal USB-C Dock
• ThinkPad Universal Thunderbolt 4 Dock
• ThinkPad Universal USB-C Smart Dock
• ThinkPad Universal Thunderbolt 4 Smart Dock
• ThinkPad Universal USB-C Dock v2

Group Policy

This section is used by Administrators to enable easy configuration of the registry keys through Group Policy Management Editor; the configurations include: the Repository Location for retrieving which repository to access the firmware updates; Application configuration to edit the AskBeforeFirmwareUpdate and EnableNotifications value for changing the behaviors upon Firmware Download and Update; Managing the Logs for the max log file size and days to clean up; Configuring proxy; Configuring the Task Scheduler to set when the next scheduled task is to be executed; and pushing supported command such as Update Software.

6.1 Setup Policy Settings for Lenovo DockManager application
Before accessing the group policy, make sure to check if the IT Administrator pushed the policy settings to user’s laptop.
6.1.1 Changing the Group Policies
o To import the group policies and enable easy configuration:

• Make sure that you are accessing the computer as an administrator.
• Extract to get “Lenovo.admx” and “en-US\Lenovo.adml” by double-clicking “Policy Setup.exe” and then import admx and adml.
• On start, search for “group policy management” and press enter.
• The group policy management editor will be opened by clicking the edit context menu on the right policy and load all the created policies.
• Locate the Dock Manager Policies inside:
  Computer Configuration\Administrative Templates\Lenovo\Dock Manager\
• Inside are 3 categories: Command, General and Scheduler.

6.2 Configuring the Firmware Download and Update Behavior
To configure the download and update behavior as stated in Section 5, AskBeforeFirmwareUpdate and EnableNotification are located inside the General Category inside the Dock Manager Group Policies. 6.2.1 Enable No User Confirmation
o To enable no user confirmation:

• Ensure that” EnableNotifications” policy is set to “Not Configured” or “Enabled”
• Select “AskBeforeFirmwareUpdate” policy and set to “Disabled”.

6.2.2 Enable Silent Mode
o To enable silent mode:

• Select “EnableNotifications” policy and set to “Disabled”.
• Select “AskBeforeFirmwareUpdate” policy and set to “Disabled”.

6.3 Configure Log Settings
To configure Log Setting, all policies can be located inside the General category inside the Dock Manager Policies.
(Refer to Figure 16. Dock Manager General Policies)
6.3.1.Change Number of Days Before Log Files are Deleted
This coniguration will delete all the Log files inside “C:\ProgramData\Lenovo\DockManager\Logs\” which were modified before a number of days. (E.g. All logs modified on 6/22/2020 or before will be deleted on 6/27/2020 when the days is set to 7.)
o To change the number of days before log files are deleted:

• Select “LogfileAgeToCleanup” and set to “Enabled”.
• Enter the number of days inside textbox in the options panel. (Default: “90”)

6.3.2 Configure Log File Max Size Before Creating a New Log File
This configuration will create a new Log file inside “C:\ProgramData\Lenovo\DockManager\Logs\” based on the max file size set. Old log files will have their Log filenames appended with the current date and a new Log file will be created.
o To change the max file size before creation of new log file:

• Select “LogfileMaxSize” and set to “Enabled”.
• Enter the max file size in kb inside textbox in the options panel. (Default: “5120”)

6.4 Configure Repository Location
This configuration will edit the Lenovo repository location from where the firmware updates will be downloaded. The policy is located in the General category inside the Dock Manager Policies (Refer to Figure 16.
Dock Manager General Policies):

• Valid values:
• C:\FwRepo – For local directory location repository
• \\10.11.32.109\FwRepo\ – Shared network folder location repository

o To change the repository location:

• Select “RepositoryLocation” and set to “Enabled”.
• Enter the repository location inside the textbox in the options panel. (Default: “https://download.lenovo.com/catalog/”)

Note:
When building repository with Update Retriever, please add packages by searching dock’s machine type. The following figure 21.1 is an example. 6.5 Configure Task Scheduler
To configure Task Scheduler Setting, all policies can be located inside the Scheduler category inside the Dock Manager Policies. This configuration can edit the task scheduler to execute firmware check and update on the next scheduled task at a specific time, day, week or month. The scheduled task can scheduled on different frequencies: DAILY, WEEKLY, and MONTHLY.

6.5.1 DAILY
This configuration will schedule a firmware check daily on a specific time.
o To update the scheduled task daily:

• Select “Frequency” and set to “Enabled”.
• Set the value of the dropdown inside the options menu to “DAILY”.

• Select “RunAt” and set to “Enabled”
• Enter time in 24:MM:SS format inside the textbox in the options panel. (Default: “13:05:30”)

• The scheduled task will be updated on (Sample Result: Run every day on 13:05:30) the next scheduled firmware check. To manually update the scheduled task and execute firmware check, open Windows Task Scheduler, locate the Scheduled Task (Lenovo/Dock Manager – Task Scheduler) and run manually.

6.5.2 WEEKLY
This configuration will schedule a firmware check weekly on a specific time and day of week.
o To update the scheduled task weekly:

• Select “Frequency” and set to “Enabled”.
• Set the value of the dropdown inside the options menu to “WEEKLY”. (Refer to Figure 21.
  Frequency Dropdown)
• Select “RunAt” and set to “Enabled”.
• Enter time in 24:MM:SS format inside the textbox in the options panel. (Refer to Figure 22. RunAt Input)
• Select “RunOn” and set to “Enabled”.
• Enter day/s of week inside the textbox in the options panel. (Default: TUESDAY)

• The scheduled task will be updated on (Sample Result: Run Every Tuesday on 13:05:30) the next scheduled firmware check. To manually update the scheduled task and execute firmware check, open Windows Task Scheduler, locate the Scheduled Task (Lenovo/Dock Manager – Task Scheduler) and run manually.

6.5.3 MONTHLY (By RunDay)
This configuration will schedule a firmware check monthly on a specific day/s of a month.
o To update the scheduled task monthly by date:

• Select “Frequency” and set to “Enabled”.
• Set the value of the dropdown inside the options menu to “MONTHLY”. (Refer to Figure 21. Frequency Dropdown)
• Select “RunAt” and set to “Enabled”.
• Enter time in 24:MM:SS format inside the textbox in the options panel. (Refer to Figure 22. RunAt Input)
• Select “RunDays” and set to “Enabled”.
• Enter day/s inside the textbox in the options panel. (Default: 1)

• Select “RunMonth” and set to “Enabled”.
• Enter month/s inside the textbox in the options panel. (Default: January)

• The scheduled task will be updated on (Sample Result: Run Every January 1 on 13:05:30) the next scheduled firmware check. To manually update the scheduled task and execute firmware check, open Windows Task Scheduler, locate the Scheduled Task (Lenovo/Dock Manager – Task Scheduler) and run manually.

6.5.4 MONTHLY (By RunMonthlyOn)
This configuration will schedule a firmware check monthly on a specific order of a month.
o To update the scheduled task monthly by order:

• Select “Frequency” and set to “Enabled”.
• Set the value of the dropdown inside the options menu to “MONTHLY”. (Refer to Figure 21.
  Frequency Dropdown)
• Select “RunAt” and set to “Enabled”.
• Enter time in 24:MM:SS format inside the textbox in the options panel. (Refer to Figure 22. RunAt Input)
• Select “RunMonthlyOn” and set to “Enabled”.
• Enter order inside the textbox in the options panel. (Default: First)

• Select “RunMonth” and set to “Enabled”.
• Enter month/s inside the textbox in the options panel. (Refer to Figure 25. RunMonth Input)
• Select “RunOn” and set to “Enabled”.
• Enter day/s of week inside the textbox in the options panel. (Refer to Figure 23. RunOn Input)
• The scheduled task will be updated (Sample Result: Run Every First Tuesday of January on 13:05:30) on the next scheduled firmware check. To manually update the scheduled task and execute firmware check, open Windows Task Scheduler, locate the Scheduled Task (Lenovo/Dock Manager – Task Scheduler) and run manually.

6.6 Configure Proxy
The policy for configuring the proxy is in the general category within the Dock Manager policy (refer to Figure 16. Dock Manager General Policies). This configuration can set the address and port number of the proxy server.
Authentication is not currently supported.
o To set the proxy server:

• Select “ProxyServer” and set to “Enabled”.
• Enter the proxy server inside the textbox in the options panel.

o To set the proxy port:

• Select “Port” and set to “Enabled”.
• Enter the proxy port inside the textbox in the options panel.

6.7 Update Software
There are 3 ways to update software itself: (software can be upgraded without UI by method i & iii)
i. Upgrade automatically.
This can be disabled by setting “AutoUpdate” group policy in “General” category to “Disabled”. (Refer to figure 31. AutoUpdate Input) ii. Trigger upgrade by end user.
Refer to Figure 5.1. Click the download button in the title bar.
The download button in the title bar can be hidden by enable “HideUpdateSoftwareButton” group policy in “General” category. (Refer to figure 32. HideUpdateSoftwareButton Input) iii. Trigger upgrade by IT manager.
The “Command” policy (Figure 33. Supported Command Input) in “Command” category (see Figure 32. Dock Manager Command Policies) within the “DockManager” policy allows the IT manager to send update software command (1) to machines installed Dock Manager in the domain. If “Command” policy is enabled, it will allow the IT manager to send supported commands to Dock Manager.
Now the supported commands:
1: checking and updating software for the Dock Manager.

Note that if you want to send the same command as the previous one, just need to update the time in the second text box.
6.8 Update firmware without disconnection
You can complete updating firmware for the following docks without disconnecting it from the computer. You can do that by enabling the “UpdateFWWithoutDisconnect” group policy in “General” category. (Refer to figure 35. UpdateFWWithoutDisconnect Input) and entering the dock type you want.

• ThinkPad Universal USB-C Dock
• ThinkPad Universal Thunderbolt 4 Dock
• ThinkPad Universal USB-C Smart Dock
• ThinkPad Universal Thunderbolt 4 Smart Dock
• ThinkPad Universal USB-C Dock v2

Note: The above docks need to be updated to firmware version that supports the “-r” parameter when updating firmware if you want to enable update firmware without disconnection.

6.9 Allow Mac Address Clone with 40AF dock
This is a function switch for Mac Address Clone that is only available for 40AF dock. This switch can be turned on only when the “MacAddressCloneEnabled” group policy in “General” category (Refer to figure 36.
MacAddressCloneEnabled Input) is enabled.6.10 Allow disable firmware update when dock connect for first time
By default, connecting dock for the first time to a computer installed Dock Manager will trigger checking and updating firmware for this dock. But you can disable it by disable the “UpdateFWOnFirstConnection” group policy in the “General” category. (Refer to figure 37. UpdateFWOnFirstConnection Input) 6.11 Enable firmware white list
If this setting is enabled, the device can be upgraded only to the firmware version in the whitelist. (Refer to Figure 38. FWWhitelist Input)
For example:
40AY:3.0.85,3.0.92; means if you have a 40AY dock, you can only upgrade to 3.0.85 or 3.0.92 if your firmware repository contains them.
40B0:; means your 40B0 dock cannot upgrade to any version because your whitelist is empty.

APPENDIX: Registry Settings

7.1 Application Group Policy Settings Registry
7.1.1 Values under General group

NAME	TYPE	REGISTRY LOCATION	VALUE	DESCRIPTION
RepositoryLocation	REG_SZ	HKLM\Software\WOW6432Node \Policies\Lenovo\Dock Manager\User Settings\General	https://download.lenov o.com/catalog/	Lenovo support site repository
			\\<Server IP Address>\\LenovoSWRepo	This is the repository from private network shared folder.
AskBeforeFirmware Update	REG_SZ	HKLM\Software\WOW6432Node \Policies\Lenovo\Dock Manager\User Settings\General	YES	Enable pop-up dialog message asking user to proceed to firmware update or not.
			NO	Disabled pop-up dialog message asking user to proceed to firmware update or not. Dock Manager will automatically proceed to firmware update after downloading firmware package without user confirmation.
EnableNotifications	REG_SZ	HKLM\Software\WOW6432Node \Policies\Lenovo\Dock Manager\User Settings\General	YES	This means tray message should display desktop notification during firmware download and update
			NO	This means tray message should not display desktop notification during firmware download and update
LogfileAgeToCleanu p	REG_SZ	HKLM\Software\WOW6432Node \Policies\Lenovo\Dock Manager\User Settings\General	1-365	Age of logfile to delete in log directory in days unit.
LogfileMaxSize	REG_SZ	HKLM\Software\WOW6432Node \Policies\Lenovo\Dock Manager\User Settings\Log	Such as ‘5120’	Filesize in Kilobytes.

7.1.2 Values under Scheduler group

NAME	TYPE	REGISTRY LOCATION	VALUE	DESCRIPTION
Frequency	REG_SZ	HKLM\Software\WOW6432Node\Policies\Lenovo\Do ck Manager\User Settings\Scheduler	DAILY	Execute firmware check daily
			WEEKLY	Execute firmware check weekly
			MONTHL Y	Execute firmware check monthly
RunAt	REG_SZ	HKLM\Software\WOW6432Node\Policies\Lenovo\Do ck Manager\User Settings\Scheduler	Such as 13:05:30	Time in 24:MM:SS format
RunOn	REG_SZ	HKLM\Software\WOW6432Node\Policies\Lenovo\Do ck Manager\User Settings\Scheduler	MONDAY , TUESDA Y, WEDNES DAY, THURSD AY, FRIDAY, SATURD AY, SUNDAY	Name of the Day (Monday – Sunday).
RunMonth	REG_SZ	HKLM\Software\WOW6432Node\Policies\Lenovo\Do ck Manager\User Settings\Scheduler	January	January – December
RunDays	REG_SZ	HKLM\Software\WOW6432Node\Policies\Lenovo\Do ck Manager\User Settings\Scheduler	1	1-31 or combination of comma separated dates (Ex: 1, 30)
RunMonthlyOn	REG_SZ	HKLM\Software\WOW6432Node\Policies\Lenovo\Do ck Manager\User Settings\Scheduler	First	First, Second, Third, Fourth, Last Note: Executed in combination with RunOn value and is optional input.

Documents / Resources

Lenovo Dock Manager Application [pdf] User Manual Dock Manager Application, Manager Application, Application

References

• User Manual