Command-line parameters

Updated 1 month ago by admin

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:

It is possible to use Windows variables as parameter values.
It is best practice to create a new administrator user for provisioning and assign a limited Role to the user containing the Win - Agent - Provisioning permission.

Version 4.1 and above

Parameter
Description
Example
Required?

USS_USERNAME

The username of a valid USS administrator account with provisioning rights.

user@clouduss.com or %username%@clouduss.com

Yes

USS_PASSWORD

The password for the account specified with USS_USERNAME.

p4ssw0rd

Yes

USS_API_DOMAIN

The hostname of the USS API service to use for authentication and registration.

apiv2.clouduss.com

Yes

USS_HOSTNAME

The hostname to register the agent as. If it is absent, it will be automatically detected.

WindowsPC or %computername%

No

USS_AGENT_PROFILE_ID

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).

123

No

UNINSTALLPASSWORD

The tamper-proof admin password for the agent to be used during uninstall, as specified in the Agent Configuration Profile in use.

p4ssw0rd

Yes, if uninstalling

Version 4.0 and below

Parameter
Description
Example
Required?

USS_USERNAME

The username of a valid USS administrator account with provisioning rights. For usernames that do not end in @clouduss.com you must include the USS_SPECIFY_DOMAIN and USS_CLOUD_DOMAIN parameters.

user@clouduss.com or %username%@clouduss.com

Yes

USS_PASSWORD

The password for the account specified with USS_USERNAME.

p4ssw0rd

Yes

USS_HOSTNAME

The hostname to register the agent as. If it is absent, it will be automatically detected.

WindowsPC or %computername%

No

USS_SPECIFY_DOMAIN

If the USS_USERNAME does not end with @clouduss.com then you must specify the base domain to use for the USS service. This parameter must be included with a value of 1 and USS_CLOUD_DOMAIN parameter must also be included.

1

No

USS_CLOUD_DOMAIN

The base domain of the USS service to use, which should be set to clouduss.com unless otherwise instructed by your service provider.

clouduss.com

No

UNINSTALLPASSWORD

The tamper-proof admin password for the agent to be used during uninstall, as specified in the Agent Configuration Profile in use.

p4ssw0rd

Yes, if uninstalling

Examples

These examples should be run as administrator or with elevation. They are based on v4.1 or above

Manual installation using MsiExec and with a debug log:

msiexec.exe /i Setup64.msi /quiet USS_USERNAME="user@clouduss.com" USS_PASSWORD="password" USS_API_DOMAIN="apiv2.clouduss.com" USS_HOSTNAME="WindowsPC" /log 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="apiv2.clouduss.com" /log uss_install.log

If USS_HOSTNAME is absent, it will be detected automatically.

Uninstalling using MsiExec :

msiexec.exe /x Setup64.msi /quiet UNINSTALLPASSWORD="password" /log 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 available from the download section.

The ManualUpdater tool support the following parameters:

Parameter
Description

admin_password

Required for all parameters. The tamper-proof admin password as specified in the Agent Configuration Profile in use.

start

Starts the USS Agent service

stop

Stops the USS Agent service

reconfigure

Associates the USS Agent with a different USS account. Requires parameters username, password and hostname to be supplied. Since v4.2.x the domain parameter is also supported with a default value of apiv2.clouduss.com.

Examples

These examples should be run as administrator or with elevation

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


How did we do?