Installing a Universal Agent User Mode Install via the Command Line Interface
- Stonebranch (Deactivated)
Installing a Universal Agent for Windows User Mode Install via the Command Line Interface
This page describes how to install Universal Agent using the user mode install command line interface.
A command line installation is useful in situations where:
- Automation is used to deploy Universal Agent installations across many different systems.
- It is not practical or convenient to perform the graphical interface installation
Installing the Agent
To install Universal Agent for Windows using the user mode command line interface, perform the following steps:
Step 1 | Download the Universal Agent for Windows User Mode Install product distribution file, |
|---|---|
Step 2 | Execute the distribution file from the command line, and include all appropriate command line parameters. |
Command Line Syntax
The following illustrates the command line syntax used to install the Agent:
sb-7.7.0.<level>-windows-x64-um.exe command line parameters
In this syntax:
<level>is the numeric package level.
The command line parameters control the behavior of the install process. Where noted, some command line parameters have environment variable and configuration file equivalents that are available as alternate sources of user mode install input. The user mode install evaluates each source and combines the values to form a single set of input data. Environment variables override configuration file values, and command line parameter values override environment variables.
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. The order of precedence for the different sources are:
- Command line parameters (overrides all)
- Command file parameters
- Environment variables
- Configuration file values
Parameter | Description | Syntax | Default | ||
|---|---|---|---|---|---|
Command | Environment Variable | Configuration File | |||
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. | -ac_agent_clusters val | UMIAGENTCLUSTERS=val | ac_agent_clusters val | Opswise - Default Linux/Unix Cluster, Opswise - Default Windows Cluster |
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. | -ac_agent_ip ipaddr | UMIAGENTIP=ipaddr | ac_agent_ip ipaddr | (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 | n/a | n/a | 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_accept_list list | UMIEXTACCEPTLIST=list | ac_extension_accept_list | * |
| 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. | -ac_extension_cancel_timeout val[s|m|h|d] | UMIEXTCANCELTIMEOUT=val[s|m|h|d] | ac_extension_cancel_timeout val[s|m|h|d] | 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. | -ac_extension_deploy_on_registration opt | UMIEXTDEPLOYONREG=opt | ac_extension_deploy_on_registration opt | 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. | -ac_exension_python_list list | UMIEXTPYTHONLIST=list | ac_extension_python_list list | (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. | -ac_netname name | UMIUAGSRVNETNAME name | ac_netname name | OPSAUTOCONF |
| AC_MESSAGE_LEVEL=value | Specifies a message level for UAG. The install uses this value to set the MESSAGE_LEVEL UAG configuration option. | -ac_message_level level | AC_MESSAGE_LEVEL=level | ac_message_level level | INFO |
| AC_LOGLVL=value | Specifies a log level for UAG. The install uses this value to set the LOGLVL UAG configuration option. | -ac_loglvl level | AC_LOGLVL=level | ac_loglvl level | I |
| BROKERDISPNAME | Specifies the name with which the Universal Broker for this user mode install is shown in the Windows Services Manager. This value is also used to register the message source for messages the Universal Broker sends to the Windows Application event log. Note that this is only the "friendly" name of the service, intended to uniquely identify the Broker service. The value specified for the BROKERSERVICENAME is the internal name the Windows Service Control Manager uses to control the service. | -broker_dispname name | UMIBROKERDISPNAME=name | broker_dispname name | Universal Broker (User Mode) |
| BROKERPORT | Specifies the port number or service name upon which the Universal Broker accepts connections from Universal Agent components. The value specified for this parameter must be unique for all services on the system, including other Universal Brokers. | -broker_port port | UMIBROKERPORT=port | broker_port port | 7887 |
BROKERPWD=BrokerAccountPassword | Used by the install when RUNBROKERASUSER is yes to specify the password for the account used to execute the Universal Broker service. | -w password -broker_pwd password | UMIBROKERPWD=password | broker_password password | BrSvcAcct001 |
BROKERSERVICENAME | Specifies the name with which the Universal Broker is assigned and recognized by the Windows Services Control Manager. This is the "true" name of the service and is the value used for service control via the command line or Windows APIs. The value specified for this parameter must be unique among all the services – including other Universal Brokers – installed on the system. | -broker_svcname name | UMIBROKERSVCNAME=name | broker_svcname name | UBrokerUMService |
BROKERUSERID | Used by the install when RUNBROKERASUSER is yes to set the user account used to execute the Universal Broker service. Important The user account specified by this parameter MUST exist before the Broker can execute. The User Mode install will not create the account. Refer to the /wiki/spaces/DEV/pages/1312885 section for more information. | -u userid -broker_userid userid | UMIBROKERUID=userid | ubroker_userid userid | UBrokerService |
COMMAND_FILE | Specifies a text file that contains command line parameters. This file may be used to simplify automated deployments and/or to shorten the length of the command line used to do the user mode installation. Note that this is not the same as a user mode installation CONFIGURATION_FILE. The format of each option specified within this file must follow command line syntax, and each option must reside on a separate line within the file. The path specified for the file may be an absolute path or one relative to the current working directory. | -f path -file path - | N/A | N/A | (none) |
CONFIGURATION_FILE | Specifies a file in standard Universal Agent configuration file format that contains keywords and values that may be used to set installation parameters. Note that this file is not the same as a user mode installation COMMAND_FILE. The format of each option specified within this file must follow configuration file syntax, which each option place on a separate line within the file. The path specified for the file may be an absolute path or one relative to the current working directory. | -conf_file path | UMICONFIGFILE=path | N/A | (none) |
| HELP | Displays command line help and exits without installing. This parameter has no value associated with it. | -? -h -help | N/A | N/A | |
INSTALLDIR | Sets the root user mode installation directory to dir. Each component will be installed under this directory. | -installdir dir | UMIINSTALLDIR=dir | installation_directory dir | %TEMP%\universal |
OMS_AUTOSTART | Specifies the behavior of the Universal Message Service (OMS) Server component at Universal Broker startup.
| -oms_autostart opt | UMIOMSAUTOSTART=opt | oms_autostart opt | no |
| OMS_PORT | Specifies the port number or service name upon which the Universal Message Service (OMS) Server accepts connections from the Universal Automation Center (UAG) Server component and the optional Universal Automation Center command line interface (UAGCMD). The value specified for this parameter must be unique for all services on the system, including other OMS Servers. | -oms_port port | UMIOMSPORT=port | oms_port port | 7878 |
OMS_SERVERS | A list of one or more locations where an OMS Server resides. When this value is specified, it sets the oms_servers value inside the Universal Automation Center (UAG) Server configuration file. The UAG Server uses this value to determine which OMS Server it will connect to. The format of this value is port@ipaddr[;port1@ipaddr1[;...;portn@ipaddrn]], where port is the OMS Server's configured oms_port value and ipaddr is the IP address or host name of the OMS Server system. UAG Server will stop processing the list after it successfully connects to one of the OMS Servers listed. | -oms_servers value | UMIOMSSERVERS=value | oms_servers value | (none) |
RUNBROKERASUSER | Controls whether the Universal Broker service executes as an Administrative user account or as Local System.
| -run_broker_as_user opt | UMIRUNBROKERASUSER=opt | run_broker_as_user opt | yes |
SILENTMODE | When specified, no product installation dialogs are shown. If no other install parameters are specified, default values for all options are used. This option has no value. Only the parameter itself is necessary. | -silent | N/A | N/A | no |
UAG_AUTOSTART | Specifies the behavior of the Universal Automation Center (UAG) Server component at Universal Broker startup.
| -uag_autostart opt | UMIUAGSRVAUTOSTART=yes | uag_autostart opt | yes |
WORKING_FOLDER | Sets the Universal Agent working folder for this user mode installation. For user mode installs, this folder is shared by the following agent components:
If the folder contains spaces, you must use double ( " ) quotation marks around the path name. | -working_folder dir | UMIWORKINGFOLDER=dir | working_folder dir | INSTALLDIR\UAHome |
| 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). | -use_tls1_3 opt | UMIUSETLS13=opt | use_tls1_3 opt | no |
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
To launch the graphical user interface for a Universal Agent for Windows User Mode Install via the command line, execute the following command:
sb-7.7.0.0-windows-x64-um.exe
Silent Install
To suppress the GUI and execute a silent Universal Agent for Windows User Mode Install, execute the following command:
sb-7.7.0.0-windows-x64-um.exe -silent
This will execute the install using default values for all options.
Silent Install with Universal Broker Service Options
The configure the Universal Broker and override the default installation directory from a silent Universal Agent for Windows User Mode Install, execute the following command:
sb-7.7.0.0-windows-x64-um.exe -silent -broker_dispname "Universal Broker (6800)" -broker_svcname UBroker6800 -broker_port 6800 -installdir "c:\ua\6800"
Actual values used for each of the options shown above will depend on your specific requirements, but this command will:
- Install the Universal Agent to
c:\ua\6800 - Configure the Universal Broker service with a display name of Universal Broker (6800)
- Configure the Universal Broker service to register messages sent to the Windows Application event log with a message source of Universal Broker (6800)
- Configure the Universal Broker service with an internal name of UBroker6800
- Configure the Universal Broker service to accept connections from Universal Agent components on port 6800
This information will also be used to populate the c:\ua\6800\ubrsvc.bat script, which may be used to start, stop, restart, or remove the Universal Broker service.
Silent Install, with Universal Automation Center (UAG) Server Options
To configure the UAG Server and override the default installation directory from a silent Universal Agent for Windows User Mode Install, execute the following command:
sb-7.7.0.0-windows-x64-um.exe -silent -uag_autostart yes -ac_netname UAGENT-6800 -oms_servers 7878@omshost.com -installdir "c:\ua\6800"
Actual values used for the some of the options above will depend on your specific requirements, but this command will:
- Install the Universal Agent to
c:\ua\6800 - Configure the UAG Server component to start automatically at Universal Broker startup
- Connect to an OMS Server that resides on omshost.com, which is accepting connections over port 7878
- Cause the UAG Server to register with a Universal Controller using the name UAGENT-6800