Command-line parameters
The USS Agent for Windows software supports command-line parameters which can be used as part of scripts to install or control the agent after installation.
Pre-installation Command Line Parameters
If you intend to script the installation of the USS Agent or use a tool such as Orca from the Windows SDK to create a custom MSI file. The following parameters can be used:
Version 4.1 and above
Parameter | Description | Example | Required? |
| The username of a valid USS administrator account with provisioning rights. |
| Yes |
| The password for the account specified with USS_USERNAME. |
| Yes |
| The hostname of the USS API service to use for authentication and registration. |
| No |
| The hostname to register the agent as. If it is absent, it will be automatically detected. |
| No |
| The ID of the configuration profile to apply during installation. This can be found in the Advanced section of the Windows Agent Configuration profile section. If it is absent, the default profile will be used (if available). |
| No |
| The tamper-proof admin password for the agent to be used during uninstall, as specified in the Agent Configuration Profile in use. |
| Yes, if uninstalling |
| Force the installer to continue even if it believes the agent has already been installed | No |
Version 4.0 and below
Parameter | Description | Example | Required? |
| The username of a valid USS administrator account with provisioning rights. For usernames that do not end in |
| Yes |
| The password for the account specified with USS_USERNAME. |
| Yes |
| The hostname to register the agent as. If it is absent, it will be automatically detected. |
| No |
| If the |
| No |
| The base domain of the USS service to use, which should be set to |
| No |
| The tamper-proof admin password for the agent to be used during uninstall, as specified in the Agent Configuration Profile in use. |
| Yes, if uninstalling |
Examples
Manual installation using MsiExec and with a debug log:
msiexec.exe /i Setup64.msi /quiet USS_USERNAME="user@clouduss.com" USS_PASSWORD="password" USS_HOSTNAME="WindowsPC" /l*v uss_install.log
Manual installation using MsiExec with a specific configuration profile and a debug log:
msiexec.exe /i Setup64.msi /quiet USS_USERNAME="user@domain.com" USS_PASSWORD="secret" USS_AGENT_PROFILE_ID=123 USS_HOSTNAME="WindowsPC" USS_API_DOMAIN="clouduss.com" /l*v uss_install.log
USS_HOSTNAME is absent, it will be detected automatically. If USS_API_DOMAIN or USS_AGENT_PROFILE_ID are absent, the default value will be used.Uninstalling using MsiExec :
msiexec.exe /x Setup64.msi /quiet UNINSTALLPASSWORD="password" /l*v uss_uninstall.log
Post-installation Command Line Parameters
If you wish to configure and control the USS Agent software after installation, you can use the special ManualUpdater tool, which is located C:\Program Files\USSAgent\USSAgent.
The ManualUpdater tool supports the following parameters:
Parameter | Description |
| Required for all parameters except |
| Starts the USS Agent service. From version 4.2.10 and above, the parameter |
| Stops the USS Agent service |
| Associates the USS Agent with a different USS account. Requires parameters |
| Return the status of the USS Agent e.g. Running or Stopped |
| Regenerate the SSL certificate (requires |
| Specify a domain to use, default is |
| The ID of the configuration profile to apply. This can be found in the Advanced section of the Windows Agent Configuration profile section. If it is absent, the default profile will be used (if available). |
Examples
Start the service:
ManualUpdater.exe start admin_password=p4ssw0rd
Stop the service:
ManualUpdater.exe stop admin_password=p4ssw0rd
Reconfigure the service:
ManualUpdater.exe reconfigure admin_password=p4ssw0rd username=anotheruser@clouduss.com password=password hostname=myhostname
Reconfigure the service with a specific configuration profile:
ManualUpdater.exe reconfigure admin_password=p4ssw0rd username=anotheruser@clouduss.com password=password hostname=myhostname config_id=12