Installing a Universal Agent System Install via the Command Line Interface
Installing a Universal Agent for Windows System Install via the Windows Installer Command Line Interface
This page describes how to install a Universal Agent for Windows System Install using the Windows Installer command line interface.
A command line installation is useful in situations where:
- Several Universal Agent installations must be deployed across many different systems.
- It is not practical or convenient to perform the graphical interface installation.
- It is necessary to generate an installation log file.
Installing the Agent
To install a Universal Agent System Install using the Windows Installer command line interface, perform the following steps:
Step 1 | Download the desired Universal Agent for Windows product distribution file to your work station:
|
---|---|
Step 2 | Execute the distribution file from the command line, and include all appropriate command line switches and parameters. |
Command Line Syntax
The following illustrates the command line syntax used to install the Agent:
sb-7.7.0.<level>-windows-<platform>.exe [/v"command line parameters"] [/s] [/w] [/x]
In this syntax:
<level>
is the numeric package level.<platform>
isx64
for the 64-bit Universal Agent distribution file.
The command line switches (/v, /s, /w, and /x) are processed directly by the distribution file to control behavior of the Windows Setup application.
The command line parameters are passed to the Windows Installer (msiexec) to control the extracted Windows Installer Package file (Ucmd.msi or Ucmdx64.msi) behavior during the install process.
Command Line Switches
The following table describes the command line switches available for a command line installation:
/fom | Repairs a Universal Agent for Windows installation. |
---|---|
/s | Suppresses the initialization and extraction dialogs displayed before the product install Welcome dialog." |
/v | Passes parameters to the Windows Installer (msiexec). |
/w | Instructs the Windows Setup application to wait until the installation completes. |
/x | Uninstalls Universal Agent for Windows. |
Command Line Parameters
The following table describes the parameters that are available for a command line installation.
The parameters can be specified in any order, with the following exceptions:
- If the Silent install (/q) and/or Log file (/L) parameters are used, they can be specified in any order, but they must be specified after all other parameters.
These parameters are preceded by the /v command line switch and must be enclosed in double (") quotation marks.
Parameter | Description | Default |
---|---|---|
AC_AGENT_CLUSTERS=clusters | Sets the AGENT_CLUSTERS UAG configuration option to specify the Universal Controller-defined agent clusters to which this agent will belong. | (none) |
AC_AGENT_IP=IP address | Sets the AGENT_IP UAG configuration option to have UAG Server register with Universal Controller using a specific IP address. | (none) |
AC_ENABLE_SSL | This option is deprecated starting with Universal Agent 7.1.0.0. UAG Server will always attempt to use SSL/TLS for OMS connections. | n/a |
AC_EXTENSION_ACCEPT_LIST | Sets the EXTENSION_ACCEPT_LIST UAG configuration option, which is a comma-separated list of Universal Extensions the Agent will accept. The default value for this option is "*", which will cause the Agent to accept all extensions. Specify a value of "none" to cause the Agent to disallow execution of all Extensions. | * |
AC_EXTENSION_CANCEL_TIMEOUT=value[s|m|h|d] | Sets the EXTENSION_CANCEL_TIMEOUT UAG configuration option, which specifies the length of time that a Universal Extension task is given to complete its response to a CANCEL request. If the task fails to finish its own termination processing within the specified timeout period, UAG Server will forcefully terminate the task. The specified timeout must be numeric, but a one-letter suffix is accepted to specify (s)econds, (m)inutes, (h)ours, or (d)ays. If no time unit is specified, the default is seconds. The following maximums are enforced:
Minute, hour, and day maximums are set to ensure that their value represented as a number of seconds does not exceed 2147483647. | 10 |
AC_EXTENSION_DEPLOY_ON_REGISTRATION | Sets the EXTENSION_DEPLOY_ON_REGISTRATION UAG configuration option that controls whether UAG Server will automatically receive Universal Extensions from Universal Controller at Agent startup. | NO |
AC_EXTENSION_PYTHON_LIST | Sets the EXTENSION_PYTHON_LIST UAG configuration option, which is a comma-separated list of all Python interpreters that should be considered for Universal Extension execution. There are some default locations the Agent will check even if this option is not specified. See the EXTENSION_PYTHON_LIST option's description for more information. | (none) |
AC_NETNAME=value | Specifies a value for a network ID that uniquely identifies the Agent on this system to the Universal Controller. The install uses this value to set the UAG NETNAME configuration option. The value specified in AC_NETNAME will override any currently configured options, including those imported from | OPSAUTOCONF |
AC_MESSAGE_LEVEL=value | Specifies a message level for UAG. The install uses this value to set the MESSAGE_LEVEL UAG configuration option. | INFO |
AC_LOGLVL=value | Specifies a log level for UAG. The install uses this value to set the LOGLVL UAG configuration option. | I |
BROKERPWD=BrokerAccountPassword | Used by the install when RUNBROKERASUSER=1 to specify the password for the account used to execute the Universal Broker service. The install also uses BROKERPWD to initialize the Password shown in the Universal Broker Service Account dialog. Note If the BROKERPWD option is set from the command line, and an installation log is generated (using the | (none) |
BROKERUID=BrokerAccountId | Used by the install when RUNBROKERASUSER=1 to override the default or currently configured user ID associated with the account used to execute the Universal Broker service. The install also uses BROKERUID to initialize the User ID shown in the Universal Broker Service Account dialog. | (none) |
CONVERT_OPSAGENT={yes|no} | Specification for whether or not to convert an existing Opswise Automation Center Agent (1.5, 1.6, or 1.7) to Agent 7.7.x. Note You must include this parameter when upgrading an Opswise Automation Center Agent (1.5, 1.6, or 1.7) to Agent 7.7.x. | no |
INSTALLDIR=installdir | Sets the root installation directory to installdir. Each component will be installed under this directory. | (none) |
KEYSTORE={yes|no} | Specification for whether or not to create encryption keys during installation and set up the local Universal Broker as a keystore owner. | |
OMS={yes|no} | Specification for whether or not to install the Universal Message Service (OMS) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, OMS is not required unless you want to change the current install state. OMS is ignored during an uninstall. | yes |
OMS_AUTOSTART={yes|no} | Specification for setting the start-up behavior of the Universal Message Service (OMS) Server component.
This OMS_AUTOSTART value is used to initialize the state of a check box on the OMS Server Start-up Option dialog, which displays for new installs and upgrades from Universal Agent releases earlier than 5.2.0. Changing the state of this check box will override the value specified from the command line. | no |
OMS_SERVERS=port@ipaddr[,_portn@ipaddrn_,...] | A list of one or more locations where an OMS Server resides. | (none) |
OPSCLI={yes|no} | Specification (yes or no) for whether or not to install the Universal Controller Command Line Interface (CLI) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, OPSCLI is not required unless you want to change the current install state. OPSCLI is ignored during an uninstall. | no |
PYTHON={yes|no} | Specification for whether or not the Python 3.11 Distribution for Universal Agent is installed. | no |
USE_TLS1_3={yes|no} | If specified (using yes), all components will be set up to use TLS 1.3 by setting the | no |
RUNBROKERASUSER={0|1} | Controls whether the Universal Broker service executes as an Administrative user account or as Local System.
| 1: new installs |
UAG_AUTOSTART={yes|no} | Sets the AUTOMATICALLY_START UAG server component definition option to control whether Universal Broker automatically starts the UAG Server. | yes |
UAGSRV={yes|no} | Specification for whether or not to install Universal Automation Center Agent (UAG) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UAGSRV is not required unless you want to change the current install state. UAGSRV is ignored during an uninstall. | yes |
UCMDMGR={yes|no} | Specification for whether or not to install the Universal Command (UCMD) Manager during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UCMDMGR is not required unless you want to change the current install state. UCMDMGR is ignored during an uninstall. | yes |
UCMDSRV={yes|no} | Specification for whether or not to install the Universal Command (UCMD) Server during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UCMDRSV is not required unless you want to change the current install state. UCMDSRV is ignored during an uninstall. | yes |
UCMDSRVWORKFOLDER=WorkFolderPath | Sets the Universal Command Server working folder. This value is used only if the Universal Command Server is being installed. | INSTALLDIR\UcmdHome |
UCTLMGR={yes|no} | Specification (yes or no) for whether or not to install the Universal Control (UCTL) Manager during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UCTLMGR is not required unless you want to change the current install state. UCTLMGR is ignored during an uninstall. | yes |
UCTLSRV={yes|no} | Specification for whether or not to install the Universal Control (UCTL) Server during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UCTLRSV is not required unless you want to change the current install state. UCTLSRV is ignored during an uninstall. | yes |
UCTLSRVWORKFOLDER=WorkFolderPath | Sets the Universal Control Server working folder. This value is used only if the Universal Control Server is being installed. | INSTALLDIR\UcmdHome |
UDMMGR={yes|no} | Specification for whether or not to install the Universal Data Mover (UDM) Manager during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UDMMGR is not required unless you want to change the current install state. UDMMGR is ignored during an uninstall. | yes |
UDMSRV={yes|no} | Specification (yes or no) for whether or not to install the Universal Data Mover (UDM) Server during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UDMRSV is not required unless you want to change the current install state. UDMSRV is ignored during an uninstall. | yes |
UDMSRVWORKFOLDER=WorkFolderPath | Sets the Universal Data Mover Server working folder. This value is used only if the Universal Data Mover Server is being installed. | INSTALLDIR\UdmHome |
UELD={yes|no} | Specification for whether or not to install Universal Event Log Dump (UELD) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UELD is not required unless you want to change the current install state. UELD is ignored during an uninstall. | yes |
UEMMGR={yes|no} | Specification for whether or not to install the Universal Event Monitor (UEM) Manager during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UEMMGR is not required unless you want to change the current install state. UEMMGR is ignored during an uninstall. | yes |
UEMSRV={yes|no} | Specification for whether or not to install the Universal Event Monitor (UEM) Server during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UEMRSV is not required unless you want to change the current install state. UEMSRV is ignored during an uninstall. | yes |
UEMSRVWORKFOLDER=WorkFolderPath | Sets the Universal Event Monitor Server working folder. This value is used only if the Universal Event Monitor Server is being installed. | INSTALLDIR\UemHome |
UPPS={yes|no} | Specification for whether or not to install the Universal Connector for PeopleSoft (UPPS) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UPPS is not required unless you want to change the current install state. UPPS is ignored during an uninstall. | yes |
UQUERY={yes|no} | Specification for whether or not to install the Universal Query (UQUERY) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, UQUERY is not required unless you want to change the current install state. UQUERY is ignored during an uninstall. | yes |
USAP={yes|no} | Specification for whether or not to install the Universal Connector (USAP) during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, USAP is not required unless you want to change the current install state. USAP is ignored during an uninstall. | yes |
USPOOL={yes|no} | Specification (yes or no) for whether or not to install the Universal Spool Utilities, Universal Spool List (USLIST) and Universal Spool Remove (USLRM), during new installs, upgrades, or maintenance.
Since, by default, each component's install state is preserved during an upgrade or maintenance, USPOOL is not required unless you want to change the current install state. USPOOL is ignored during an uninstall. | yes |
/q{n|b|r} | Suppresses the product installation dialogs.
See Command Line Switches, Command Line Installation Examples, and Detecting the Completion of a Silent Install for additional information regarding silent installs. | n/a |
/L[*v] | Instructs the installation process to create an installation log file named < | n/a |
Command Line Installation Examples
The following examples illustrate different ways that Universal Agent for Windows can be installed from the command line.
Graphical User Interface Install, All Components
To install all Universal Agent for Windows components via the graphical interface using the 32-bit distribution file, issue the following command:
sb-7.7.0.0-windows-x64.exe
Graphical User Interface Install, with Log File
sb-7.7.0.0-windows-x64.exe /v"/l*v C:\Temp\install.log"
Silent Install, All Components, with Log File
To silently install all 64-bit Universal Agent for Windows components using the 64-bit distribution file and write a log file to C:\Temp\windows install.log
, issue the following command:
sb-7.7.0.0-windows-x64.exe /s /v"/qn /l*v C:\Temp\install.log"
Silent Install, Different Installation Directory
sb-7.7.0.0-windows-x64.exe /s /v"/qn INSTALLDIR=D:\Universal"
Silent Install, Quotation Marks for Directory Path with a Space
sb-7.7.0.0-windows-x64.exe /s /v"/qn INSTALLDIR=\"C:\Program Files\Stonebranch\""
Silent Installation Removal
sb-7.7.0.0-windows-x64.exe /x /s /v"/qn"
Install Partial Components to a Different Installation Directory
To install only the Universal Broker (which always is installed), Universal Data Mover Manager, Universal Event Monitor Manager, Universal Control Manager, and Universal Query components under D:\Universal
(that is, a directory other than the one specified by the environment variable PROGRAMFILES) using the 32-bit Universal Agent distribution file, issue the following command:
sb-7.7.0.0-windows-x64.exe /v"INSTALLDIR=D:\Universal OMS=no UAGSRV=no UCMDMGR=no UCMDSRV=no UCTLSRV=no UELD=no USPOOL=no UDMSRV=no UEMSRV=no"
Install All Components, Set OMS Server Location
To install all Universal Agent components using the 32-bit Universal Agent distribution file, and to set the Universal Automation Center Agent (UAG) OMS_SERVERS configuration option, issue the following command:
sb-7.7.0.0-windows-x64.exe /v"OMS_SERVERS=7878@opshost"
Install All Components, Set Universal Broker Service
To install all Universal Agent components using the 64-bit Universal Agent distribution file, and to set the Universal Broker service to execute with an administrative account with the specified user ID and password, issue the following command (for example):
sb-7.7.0.0-windows-x64.exe /v"RUNBROKERASUSER=1 BROKERUID=ubradmin BROKERPWD=guessme"
Note
If the option to generate an installation log file is used alongside the BROKERPWD option, the password value may be displayed in the log file, depending on the logging options used. Specifically, the c, p, and v flags will cause the value of the BROKERPWD option to appear in the log file.
To generate a log file when specifying the BROKERPWD option, we recommend using /liarewum
to set to collect as much information as possible without exposing any sensitive information.
For example:
sb-7.7.0.0-windows-x64.exe /v"/liarewum setup.log RUNBROKERASUSER=1 BROKERUID=ubradmin BROKERPWD=guessme"
If the BROKERPWD option is not used from the command line, all logging options may be turned on (using /l*v
) without exposing any sensitive information.
Detecting the Completion of a Silent Install
If /s and /q are used to perform a silent install, no graphical interface or user interaction is required. One drawback to this is that no feedback is provided that indicates when the Windows Installer process (install, uninstall, or repair) finishes.
One method that can be used to detect when the installation process ends is to execute it using the system's start command. Using available command line switches, start can be used to initiate the installation process and then wait for it to finish. When start returns control to its calling process (for example, the command prompt), the process will have ended.
For example, from the command prompt, issue the following command to perform a silent 64-bit Universal Agent installation using the 64-bit distribution file and wait for it to finish:
start /b /wait sb-7.7.0.0-windows-x64.exe /w /s /v"/qn"
- The /b switch prevents the start command from opening a new window.
- The /wait parameter causes the start command to start the installation and then wait for it to finish.
This also is the recommended way to execute the installation from within a batch file.
For more information on the start command, go to the Windows command prompt and enter: start /?.