Using the vdmutil Command-Line Utility on a Connection Server Instance

You can use the vdmutil command-line interface on a Connection Server instance to create, assign, and manage URL content redirection settings for client-to-agent redirection.

Note: You must use the vdmutil command to configure client-to-agent redirection for Mac clients. Because GPOs are not supported by macOS, you cannot use GPOs to configure client-to-agent configuration if you have Mac clients.

Command Usage

The syntax of the vdmutil command controls its operation from a Windows command prompt.

vdmutil command_option [additional_option argument] ...

The additional options that you can use depend on the command option.

By default, the path to the vdmutil command executable file is C:\Program Files\VMware\VMware View\Server\tools\bin. To avoid entering the path on the command line, add the path to your PATH environment variable.

Command Authentication

You must run the vdmutil command as a user who has the Administrators role.

You can use Horizon Console to assign the Administrators role to a user. For more information, see the Horizon Administration document.

The vdmutil command includes options to specify the user name, domain, and password to use for authentication. You must use these authentication options with all vdmutil command options except for --help and --verbose.

Table 1. vdmutil Command Authentication Options

Option	Description
--authAs	User name of a Horizon administrator user to authenticate to the Connection Server instance. Do not use domain\username or user principal name (UPN) format.
--authDomain	Fully qualified domain name for the Horizon administrator user specified in the --authAs option.
--authPassword	Password for the Horizon administrator specified in the --authAs option. Typing "*" instead of a password causes the vdmutil command to prompt for the password and does not leave sensitive passwords in the command history on the command line.

For example, the following vdmutil command logs in the user mydomain\johndoe.

vdmutil --listURLSetting --authAs johndoe --authDomain mydomain --authPassword secret 

Command Output

The vdmutil command returns 0 when an operation succeeds and a failure-specific non-zero code when an operation fails. The vdmutil command writes error messages to standard error. When an operation produces output, or when verbose logging is enabled by using the --verbose option, the vdmutil command writes output to standard output in US English.

Options for URL Content Redirection

You can use the following vdmutil command options to create, assign, and manage URL content redirection settings. All options are preceded by two dashes (--).

Table 2. vdmutil Command Options for URL Content Redirection

Option	Description
--addGroupURLSetting	Assigns a group to a particular URL content redirection setting.
--addUserURLSetting	Assigns a user to a particular URL content redirection setting.
--createURLSetting	Creates a URL content redirection setting.
--deleteURLSetting	Deletes a URL content redirection setting.
--disableURLSetting	Disables a URL content redirection setting.
--enableURLSetting	Enables a URL content redirection setting that was previously disabled with the --disableURLSetting option.
--listURLSetting	Lists all of the URL content redirection settings on the Connection Server instance.
--readURLSetting	Displays information about a URL content redirection setting.
--removeGroupURLSetting	Removes a group assignment from a URL content redirection setting.
--removeUserURLSetting	Removes a user assignment from a URL content redirection setting.
--updateURLSetting	Updates an existing URL content redirection setting.

You can display syntax information for all vdmutil options by typing vdmutil --help. To display detailed syntax information for a particular option, type vdmutil --option --help.