Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

Default

Anchor
Base
Base
Base Parameters



-u
‑user

Anchor
--user
--user
--user

Normal UNIX username that is used to execute the Universal Broker daemon. The install grants this user account ownership of all installed files, with the exception of the Universal Agent server components (for example: ucmsrv, udmsrv, and uemsrv) which, due to security requirements, are owned by root and will have their "set user ID on execution" bit set.

  • If the user account that you want to use already exists, specify that user account.
  • If the user account does not exist, the install creates it.
  • If you want to change the user account for an installed Universal Agent for AIX system, you must perform a re-installation and use this parameter to change the user account.
  • If --user is omitted from unvinst, the default is used.
  • If --usermode_install is yes, there is no default.

ubroker

‑create_user

Anchor
--create_user
--create_user
‑‑create_user

Specification (yes or no) for whether or not to create the user name that will own the installed files as a local user.

yes

Anchor
-userdir
-userdir
‑userdir
‑‑userdir

Home directory for the created user account specified by --user.

  • If this directory does not exist, it is created when the specified user is created.
  • If the user specified by --user already exists, but the home directory of that user is not the default directory (/home/<username>), --userdir must specify the path to that home directory.
  • If --userdir is omitted from unvinst, the default is used.

/home/<username>

-g
‑group

Anchor
--group
--group
‑‑group

Normal UNIX groupname; the Universal Broker daemon will run as this specified group. All installed files will be assigned to this group.

  • If the group that you want to use already exists, specify that group.
  • If this group does not exist, the install creates it.
  • If --group is omitted from unvinst, the default is used.

ubroker

‑create_group

Anchor
--create_group
--create_group
‑‑create_group

Specification (yes or no) for whether or not to create the group that will own the installed files as a local group.

yes

Anchor
-keystore
-keystore
‑keystore
‑‑keystore

Specification (yes or no) for whether or not to create encryption keys during installation and set up the local Universal Broker as a keystore owner.

no

Anchor
UAG
UAG
UAG Parameters



-c
‑convert

Anchor
--convert_opsagent
--convert_opsagent
‑‑convert_opsagent

Converts an existing Opswise Automation Center Agent (1.5, 1.6, or 1.7) to a 5.2.0 Agent.

The installation process will invoke a script, opsmerge.sh, 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
titleNote

You must include this parameter when upgrading an Opswise Automation Center Agent (1.5, 1.6, or 1.7) to Universal Agent 7.2.x.x.



-d
‑opsdir
‑‑opsdir

If --convert_opsagent is specified: Identifies the primary install directory for Universal Agent.

  • If --opsdir is omitted from unvinst, the default is used.

/home/opswise

‑oms_servers

Anchor
--oms_servers
--oms_servers
‑‑oms_servers

Specifies a value, in the format port@host[,port2@host,...,portn@hostn], for the port and network address of the OMS server(s) to be used as network communications providers.
 

Note
titleNote

You should always include --oms_servers in unvinst; OMS is the network communications provider between Controller 7.2.x.x and Agent 7.2.x.x.

 
UAG configuration: The value specified for --oms_servers is set automatically for the UAG OMS_SERVERS configuration option.

(none)

‑ac_agent_clusters
‑‑ac_agent_clusters

Specifies the Universal Controller-defined clusters to which this agent will belong.

UAG configuration: The value specified by --ac_agent_clusters is set automatically for the UAG AGENT_CLUSTERS configuration option.

(none)

‑ac_agent_ip
‑‑ac_agent_ip

Specifies the IP address or host name (which resolves to an IP address) that the Agent reports to the Controller.

UAG configuration: The value specified by --ac_agent_ip is set automatically for the UAG AGENT_IP configuration option.

(none)

‑ac_netname
‑‑ac_netname

Specifies the network ID that Universal Agent will use.

UAG configuration: The value specified by --ac_netname is set automatically for the UAG NETNAME configuration option.

(none)

-ac_extension_accept_list
--ac_extension_accept_list

Specifies a comma-separated list of one or more Universal Extensions that the agent will accept via auto-deployment from the Controller.

  • A single value of * indicates that all extensions are accepted.
  • A single value of none indicates that no extensions are accepted.

The value specified for this parameter sets the EXTENSION_ACCEPT_LIST configuration option value.

*
-ac_extension_python_list --ac_extension_python_list

Specifies a comma-separated list of zero or more Python locations. Each item in the list is expected to contain a complete path to a Python executable.

The value specified for this parameter sets the EXTENSION_PYTHON_LIST configuration option value.

/usr/bin/python3,/usr/bin/python,/usr/libexec/platform-python
-ac_extension_deploy_on_registration --ac_extension_deploy_on_registration

Controls Extension deployment behavior from the Universal Controller.

  • If the value is yes, the Controller will preemptively deploy all extensions acceptable by UAG.
  • If the value is no, the Controller will only send Extension modules as needed (on demand).

The value specified for this parameter sets the EXTENSION_DEPLOY_ON_REGISTRATION configuration option value.

no

-ac_extension_cancel_timeout
--ac_extension_cancel_timeout

Set the EXTENSION_CANCEL_TIMEOUT UAG configuration option, which specifies the length of time 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_enable_ssl
‑‑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.

no

-ac_process_cancel_timeout
--ac_process_cancel_timeout

Set the PROCESS_CANCEL_TIMEOUT UAG configuration option, which specifies the length of time an OS 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

‑uag_autostart

Anchor
--uag_autostart
--uag_autostart
‑‑uag_autostart

Specifies (yes or no) whether or not the Universal Automation Center Agent (UAG) Server starts automatically when the Universal Broker is started.

UAG component definition: The value specified by --uag_autostart is set automatically for the UAG AUTOMATICALLY_START component definition option.

yes

Anchor
OMS
OMS
OMS Parameters



‑oms_port
‑‑oms_port

Specifies the port to use to listen for OMS connection requests.

OMS configuration: The value specified by --oms_port is set automatically for the OMS SERVICE_PORT configuration option.

(none)

‑oms_autostart

Anchor
--oms_autostart
--oms_autostart
‑‑oms_autostart

Specifies (yes or no) whether or not OMS is started automatically by Universal Broker when Universal Broker starts.

OMS component definition: The value specified by --oms_autostart is set automatically for the OMS AUTOMATICALLY_START and RESTART component definition options.

no

Anchor
CLI
CLI
CLI Parameters



‑opscli

Anchor
--opscli
--opscli
‑‑opscli

Specifies (yes or no) whether or not the Universal Controller Command Line Interface (CLI) tools will be installed.

no

Anchor
User Mode
User Mode
User Mode Parameters



-U
-usermode_install

Anchor
--usermode_install
--usermode_install
--usermode_install

Specifies (yes or no) for a user mode installation, which defines both of the following:

no

Anchor
--unvdir
--unvdir
-unvdir
Anchor
unvdir
unvdir
--unvdir

If --usermode_install is set to yes: Specifies the Agent binaries (installation) directory.

(none)

‑unvcfgdir

Anchor
unvcfgdir
unvcfgdir
‑‑unvcfgdir

If --usermode_install is set to yes: Specifies the Agent configuration files directory.

<--unvdir>/etc

‑unvdatadir

Anchor
unvdatadir
unvdatadir
‑‑unvdatadir

If --usermode_install is set to yes: Specifies the Agent data files directory.

<--unvdir>/var

‑unvport

Anchor
unvport
unvport
‑‑unvport

If --usermode_install is set to yes: Specifies the Universal Broker port.

(none)

Anchor
Third-party
Third-party
Third-Party Parameters



‑python

Anchor
python
python
‑‑python

Specifies (yes or no) whether the Python 3.7 Distribution for Universal Agent is installed.

no

Additional Parameter



-?
-h
‑help
‑‑info

Displays command line help.

n/a

...