...
To uncompress and extract the installation files from the product distribution file, issue the following command:
Panel | ||
---|---|---|
|
This command assumes that the name of the distribution file is sb-7.2.x.x-linux-3.10-x86_64.tar.Z.
...
To uncompress and extract the installation files from the product distribution file, issue the following command:
Panel |
---|
...
|
...
Distribution File
|
This command assumes that the name of the distribution file is sb-7.2.x.x-linux-3.10-s390x.tar.Z
.
Distribution File
The following table identifies the files contained in the distribution file.
...
To uncompress and extract the installation files from the product distribution file, issue the following command:
Panel | ||
---|---|---|
|
This command assumes that the name of the distribution file is sb-7.2.x.x-linux-3-x86_64-deb.tar.Z
.
...
To uncompress and extract the installation files from the product distribution file, issue the following command:
Panel |
---|
...
|
This command assumes that the name of the distribution file is sb-7.2.x.x-linux-3.10-ppc64le.tar.Z
.
...
To start the installation script, unvinst, issue the following command:
Panel |
---|
See Linux Installation Script Parameters and Installation Script Example, below, for a description of the optional parameters that you can issue with unvinst and an example of unvinst with these parameters.
Note | ||
---|---|---|
| ||
If you want to install multiple Agents on the same machine, or add one or more additional Agents to a machine with a previously installed Agent, some of these installation parameters are required (see Installing Multiple Agents on a Single Machine). |
...
The Universal Broker daemon will be installed and run as the username and groupname specified with the installation script parameters, below.
Note | ||
---|---|---|
| ||
For this release of Linux RPM, the previous non-RPM version will not be uninstalled. The Administrator can remove the remaining files/directories as needed. |
...
The following table describes the optional parameters that are available in the UNIX install script (unvinst
) when installing Universal Agent.
The parameters are grouped into the following categories:
...
Category
...
Description
...
...
Used for base install.
...
...
Used for an active OMS configuration.
...
...
Used for an active UAG configuration.
...
...
Used for Universal Controller CLI programs install.
...
...
Used for user mode installation.
...
...
Used to manage third-party components.
...
Parameter
...
Description
...
Default
...
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 Linux 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
...
Specification (yes or no) for whether or not to create the user name that will own the installed files as a local user.
...
yes
...
‑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
‑‑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
...
Specification (yes or no) for whether or not to create the group that will own the installed files as a local group.
...
yes
...
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
...
-security
--security
...
Sets the value (default, inherit, pam, pam_sessions, or trusted) of the following configuration options for Universal Agent server components:
- SECURITY: UAG Server
- USER_SECURITY: UCMD Server
- USER_SECURITY: UCTL Server
- USER_SECURITY: UDM Server
- USER_SECURITY: UEM Server
The appdef value for -security controls how product configuration options are set; it does not map to a product configuration option.
Note | ||
---|---|---|
| ||
pam_sessions is a valid value only for the UCMD Server and UDM Server. |
...
Specifies (yes or no) whether or not Universal Broker is started by the Installer when installation is completed.
If --ubroker_start is not included in the script, Universal Broker will be started when installation is complete.
Note | ||
---|---|---|
| ||
--ubroker_start is ignored for user mode installs. |
...
Causes unvinst
to execute opsmerge.sh (residing in /opt/universal/uagsrv/bin
), which performs the following tasks:
- Searches for an existing Opswise Automation Center Agent 1.6 or 1.7 install and converts properties stored in the agent.props file to corresponding configuration options in the Universal Automation Center Agent (UAG) configuration file,
uags.conf
. - Searches for an active Opswise Automation Center Agent 1.6 or 1.7 daemon process and attempts to stop it.
- Assigns the ID used by the Opswise Automation Center Agent 1.6 or 1.7 to UAG by moving the qname file from the Opswise Automaton Center install directory to the
/var/opt/universal/uag/var
directory.
...
-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
...
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 | ||
---|---|---|
| ||
You should always include --oms_servers in |
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.
...
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.
...
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.
...
-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.
...
-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.
...
‑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.
...
n/a
...
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
...
‑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)
...
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
...
Specifies (yes or no) whether or not the Universal Controller Command Line Interface (CLI) tools will be installed.
...
no
...
Specifies (yes or no) for a user mode installation, which defines both of the following:
- Whether or not this Agent can be installed on a machine where an Agent already is installed (see Installing Multiple Agents on a Single Machine).
- Whether or not the user can specify installation parameters (--unvdir, --unvcfgdir, --unvdatadir, and --unvport) that control where the Agent will be installed and configured (see Changing the Default Installation Directories).
...
no
...
If --usermode_install is set to yes: Specifies the Agent binaries (installation) directory.
...
(none)
...
If --usermode_install is set to yes: Specifies the Agent configuration files directory.
...
<--unvdir>/etc
...
If --usermode_install is set to yes: Specifies the Agent data files directory.
...
<--unvdir>/var
...
If --usermode_install is set to yes: Specifies the Universal Broker port.
...
(none)
...
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
...
The following example illustrates Universal Agent for Linux installed with the installation script, unvinst, and optional parameters.
Panel | ||
---|---|---|
|
See Linux Installation Script Parameters and Installation Script Example, below, for a description of the optional parameters that you can issue with unvinst and an example of unvinst with these parameters.
Note | ||
---|---|---|
| ||
If you want to install multiple Agents on the same machine, or add one or more additional Agents to a machine with a previously installed Agent, some of these installation parameters are required (see Installing Multiple Agents on a Single Machine). |
This is a silent install. The output from unvinst is written to file install.log in the current directory. The Agent is installed into directory /opt.
The Universal Broker daemon will be installed and run as the username and groupname specified with the installation script parameters, below.
Note | ||
---|---|---|
| ||
For this release of Linux RPM, the previous non-RPM version will not be uninstalled. The Administrator can remove the remaining files/directories as needed. |
Anchor | ||||
---|---|---|---|---|
|
The following table describes the optional parameters that are available in the UNIX install script (unvinst
) when installing Universal Agent.
The parameters are grouped into the following categories:
Category | Description |
---|---|
Used for base install. | |
Used for an active OMS configuration. | |
Used for an active UAG configuration. | |
Used for Universal Controller CLI programs install. | |
Used for user mode installation. | |
Used to manage third-party components. |
Parameter | Description | Default | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
-u
| 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.
| ubroker | ||||||||||||
‑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 | ||||||||||||
‑userdir | Home directory for the created user account specified by --user.
|
| ||||||||||||
-g | Normal UNIX groupname; the Universal Broker daemon will run as this specified group. All installed files will be assigned to this group.
| ubroker | ||||||||||||
‑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 | ||||||||||||
‑‑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 | ||||||||||||
-security | Sets the value (default, inherit, pam, pam_sessions, or trusted) of the following configuration options for Universal Agent server components:
The appdef value for -security controls how product configuration options are set; it does not map to a product configuration option.
| (none) | ||||||||||||
-ubroker_start --ubroker_start | Specifies (yes or no) whether or not Universal Broker is started by the Installer when installation is completed. If --ubroker_start is not included in the script, Universal Broker will be started when installation is complete.
| yes | ||||||||||||
| ||||||||||||||
-c
| Causes
| |||||||||||||
-d | If --convert_opsagent is specified: Identifies the primary install directory for Universal Agent.
|
| ||||||||||||
‑oms_servers
| Specifies a value, in the format
| (none) | ||||||||||||
‑ac_agent_clusters | Specifies the Universal Controller-defined clusters to which this agent will belong. | (none) | ||||||||||||
‑ac_agent_ip | Specifies the IP address or host name (which resolves to an IP address) that the Agent reports to the Controller. | (none) | ||||||||||||
‑ac_netname | Specifies the network ID that Universal Agent will use. | (none) | ||||||||||||
-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.
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.
The value specified for this parameter sets the EXTENSION_DEPLOY_ON_REGISTRATION configuration option value. | no | ||||||||||||
-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:
Minute, hour, and day maximums are set to ensure that their value represented as a number of seconds does not exceed 2147483647. | 10 | ||||||||||||
-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:
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 | 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 | ||||||||||||
‑uag_autostart
| Specifies (yes or no) whether or not the Universal Automation Center Agent (UAG) Server starts automatically when the Universal Broker is started. | yes | ||||||||||||
| ||||||||||||||
‑oms_port | Specifies the port to use to listen for OMS connection requests. | (none) | ||||||||||||
‑oms_autostart
| Specifies (yes or no) whether or not OMS is started automatically by Universal Broker when Universal Broker starts. | no | ||||||||||||
| ||||||||||||||
‑opscli
| Specifies (yes or no) whether or not the Universal Controller Command Line Interface (CLI) tools will be installed. | no | ||||||||||||
| ||||||||||||||
-usermode_install --usermode_install | Specifies (yes or no) for a user mode installation, which defines both of the following:
| no | ||||||||||||
| If --usermode_install is set to yes: Specifies the Agent binaries (installation) directory. | (none) | ||||||||||||
‑unvcfgdir
| If --usermode_install is set to yes: Specifies the Agent configuration files directory. |
| ||||||||||||
‑unvdatadir
| If --usermode_install is set to yes: Specifies the Agent data files directory. |
| ||||||||||||
‑unvport
| If --usermode_install is set to yes: Specifies the Universal Broker port. | (none) | ||||||||||||
| ||||||||||||||
‑python
| Specifies (yes or no) whether the Python 3.7 Distribution for Universal Agent is installed. | no | ||||||||||||
Additional Parameter | ||||||||||||||
-? | Displays command line help. | n/a |
Anchor | ||||
---|---|---|---|---|
|
The following example illustrates Universal Agent for Linux installed with the installation script, unvinst, and optional parameters.
Panel | ||
---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
...
To list information for the Universal Agent for Linux, issue the following command:
Panel | ||
---|---|---|
|
Debian Commands
Information on installed packages is listed with the dpkg command. The command must be executed with superuser authority.
To list information for the Universal Agent for Linux, issue the following commands:
...
issue the following commands:
Panel | ||
---|---|---|
|
Removing Universal Agent for Linux
...
Step 1 | Stop the ubrokerd daemon. | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Step 2 | Make a backup copy of the | |||||||||||||||||||||||||||
Step 3 | RPM Commands Panel | Panel | Panel |
| ||||||||||||||||||||||||
Step 4 | Delete the Agent user account (
| |||||||||||||||||||||||||||
Step 5 | Delete the Agent group (
|
User Mode Install Removal
Step 1 | Stop the Usermode Broker. | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Step 2 | Make a backup copy of the | ||||||||||||||
Step 3 | Using the superuser ID, remove all Universal Agent for Linux packages by issuing the following commands: Panel | Panel | packages by issuing the following commands:
| ||||||||||||
Step 4 | Delete the Agent user account (
| ||||||||||||||
Step 5 | Delete the Agent group ( Panel |
|
Note | ||
---|---|---|
| ||
To remove an Agent executing in an unprivileged user mode environment (see User Mode Installation), simply stop the |
...
All supported Linux installations - except for SUSE 9 and below - require the sample PAM configuration file delivered with Universal Agent to be copied to directory /etc/pam.d:
Panel | ||
---|---|---|
|
PAM Configuration File
All Universal Agent components utilize the same PAM configuration file.
...
As of release 5.1, this file no longer is used. To apply your desired security configuration, access the UAG SECURITY configuration option in the uags.conf
configuration file:configuration, access the UAG SECURITY configuration option in the uags.conf
configuration file:
- If you do not want security, set the value to none.
- If you want security, set the value to pam and update the following files:
- Check the /etc/pam.d/ucmd configuration file to ensure that it contains the minimum PAM security settings (see Examples of Customized PAM Configuration Files, above).
- Add the following to /etc/universal/uacl.conf for each user: uag_work_request [username],allow,noauth
Also, verify that the user has a /home directory defined.