Installing a Universal Agent System Install via the Command Line Interface

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:

  • sb-7.7.0.<level>-windows-x64.exe, the 64-bit Universal Agent for Windows distribution file (for supported 64-bit versions of Windows only).

Step 2

Execute the distribution file from the command line, and include all appropriate command line switches and parameters.
 
The installation process determines whether a Windows Installer update is needed. The process then extracts and saves a Windows installer package file (.msi) to one of these locations.
 
After all files (including the .msi) are extracted from the distribution file, the installation process verifies that your machine meets the minimum installation requirements. If the requirements are met, the installation begins.

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> is x64 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.
 
om (after the /f) are options used by the repair. There are other options available, but for behavior that matches the repair done from the graphical install, the om options must be used.
 
/fom cannot be used with the /x (uninstall) command line switch.

/s

Suppresses the initialization and extraction dialogs displayed before the product install Welcome dialog."
 
If you are using the /q command line parameter, use this switch additionally for a completely silent install.

/v

Passes parameters to the Windows Installer (msiexec).
 
The list of parameters must be enclosed in double (") quotation marks. See Command Line Parameters for available parameters.

/w

Instructs the Windows Setup application to wait until the installation completes.
 
Use this switch when launching the installation from a script file. Without it, the Setup application may return immediately after launching Windows Installer.

/x

Uninstalls Universal Agent for Windows.
 
/x cannot be used with the /fom (repair) command line switch.

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

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:

  • 2147483647 or 2147483647s

  • 35791394m

  • 596523h

  • 24855d

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 agent.props, if CONVERT_OPSAGENT is set to yes.
 
If AC_NETNAME is omitted from the command line, and no other value specifies the Agent's network ID, the default is used.

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.
 
Valid values are any 256 characters or less.
 
BROKERPWD is ignored if RUNBROKERASUSER=0.
 

Note

If the BROKERPWD option is set from the command line, and an installation log is generated (using the /l option to msiexec), the password value may be displayed in the log file, depending on the logging options used. Specifically, the c, p, and v flags will show the value of the BROKERPWD command line option. We recommend using /liarewum to set installation log file options to collect as much information as possible without exposing any sensitive information.
 
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.

(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.
 
Valid values are any 20 characters or less. For domain accounts, a domain name of up to 256 characters is accepted, but the user ID is still limited to 20 characters.
 
BROKERUID is ignored if RUNBROKERASUSER=0.

(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.
 
The installation process will invoke a script, opsmerge.vbs, which stops the Agent and converts the configuration options stored in its agent.props file to corresponding configuration options in the Universal Automation Center Agent (UAG) uags.conf file. The script also performs several other tasks needed for the conversion.
 

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.
 
INSTALLDIR is required only if you want to install Universal Agent for Windows under a directory different from the one specified by the PROGRAMFILES environment variable (typically C:\Program Files\Universal). If the directory contains spaces, you must use double ( " ) quotation marks around the path name.

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

  • If yes is specified, OMS will be installed.

  • If no is specified, OMS will not be installed. If OMS already is present on the system (via a previous installation), it will be removed.

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.
 
Setting this parameter has the same effect as selecting whether or not to install Universal Message Service on the Custom Setup dialog when installing Universal Agent via the graphical interface.

yes

OMS_AUTOSTART={yes|no}

Specification for setting the start-up behavior of the Universal Message Service (OMS) Server component.

  • If yes is specified, the AUTOMATICALLY_START OMS component definition option is set to yes, which instructs Universal Broker to start the OMS Server automatically when it is started.

  • If no (the default) is specified, or if this option is not included on the command line, the AUTOMATICALLY_START and /wiki/spaces/UA71x/pages/2654344RESTART OMS component definition options are set to no. Universal Broker will not start the OMS Server automatically when it is started. This allows the OMS Server to be started manually any time after the Broker is started.

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.

  • If yes is specified, the CLI will be installed.

  • If no is specified, the CLI will not be installed. If the CLI already is present on the system (via a previous installation), it will be removed.

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.
 
Setting this parameter has the same effect as selecting whether or not to install Universal Controller Command Line Interface on the Custom Setup dialog when installing Universal Agent via the graphical interface.

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 max_ssl_protocol option to tls1_3 (and encrypt to yes for UCMD and UDM).

no

RUNBROKERASUSER={0|1}

Controls whether the Universal Broker service executes as an Administrative user account or as Local System.

  • If RUNBROKERASUSER=1, the install will perform the following steps:

    1. If the Universal Broker service is not installed or currently is configured to run as Local System, the install will set the service's start-up account to UBrokerService or the user ID specified by the BROKERUID command line option.

    2. If the Universal Broker service is installed and already is configured to run as a user account, the Broker's start-up account will not be changed (allows customized user accounts to be preserved during upgrades).
       

  • If RUNBROKERASUSER=0, the install will perform the following steps:

    1. If the Universal Broker service is not installed or is currently configured to run as an account other than Local System, the install will set the service's start-up account to Local System.
       

    2. If the Universal Broker service is installed and is currently configured to run as Local System, the Universal Broker service's properties will not be changed.

1: new installs
0: upgrades earlier than 4.3.0

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.

  • If yes is specified, UAG will be installed.

  • If no is specified, UAG will not be installed. If UAG already is present on the system (via a previous installation), it will be removed.

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.
 
Setting this parameter has the same effect as selecting whether or not to install Universal Automation Center Agent on the Custom Setup dialog when installing Universal Agent via the graphical interface.

yes

UCMDMGR={yes|no}

Specification for whether or not to install the Universal Command (UCMD) Manager during new installs, upgrades, or maintenance.

  • If yes is specified, the UCMD Manager will be installed.

  • If no is specified, the UCMD Manager will not be installed. If the UCMD Manager already is present on the system (via a previous installation), it will be removed.

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.
 
Setting this parameter has the same effect as selecting whether or not to install Universal Command Manager on the Custom Setup dialog when installing Universal Agent via the graphical interface.

yes

UCMDSRV={yes|no}

Specification for whether or not to install the Universal Command (UCMD) Server during new installs, upgrades, or maintenance.

  • If yes is specified, the UCMD Server will be installed.

  • If no is specified, the UCMD Server will not be installed. If the UCMD Server already is present on the system (via a previous installation), it will be removed.

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.
 
Setting this parameter has the same effect as selecting whether or not to install Universal Command Server on the Custom Setup dialog when installing Universal Agent via the graphical interface.

yes

UCMDSRVWORKFOLDER=WorkFolderPath

Sets the Universal Command Server working folder. This value is used only if the Universal Command Server is being installed.
 
If the folder contains spaces, you must use double ( " ) quotation marks around the path name.

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.

  • If yes is specified, the UCTL Manager will be installed.

  • If no is specified, the UCTL Manager will not be installed. If the UCTL Manager already is present on the system (via a previous installation), it will be removed.

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.
 
Setting this parameter has the same effect as selecting whether or not to install Universal Control Manager on the Custom Setup dialog when installing Universal Agent via the graphical interface.

yes

UCTLSRV={yes|no}