Universal Agent for AIX Installation
Installation Process
Installation of Universal Agent for AIX is a three-step process:
Step 1 | Download the product distribution file. |
|---|---|
Step 2 | Extract the installation files from the distribution file. |
Step 3 | Install the extracted files. |
Extracting the Universal Agent for AIX Installation Files
The Universal Agent for AIX product distribution file is in a compressed tar format.
To uncompress and extract the installation files from the distribution file, issue the following command:
zcat sb-7.7.x.x-aix-7.1-ppc64.tar.Z | tar xvf -
This command assumes the following:
Name of the distribution file is
sb-7.7.x.x-aix-7.1-ppc64.tar.Z.File is located in the current working directory.
Distribution File
The distribution file contains multiple files, including packages in the AIX backup file format, using extension .bff. The actual base name of the .bff file depends on the AIX version for which the distribution file is intended. (See Distribution File Format for distribution file naming conventions.)
The following table identifies the files contained in the distribution file.
File | Description |
|---|---|
Readme.unv | Summary of the installation procedure. |
unv-7.7.x.x-aix-7.1-ppc64.rpm | AIX RPM file format package. |
unv-opscli-7.7.x.x-aix-7.1-ppc64.rpm | Universal Controller Command Line Interface (CLI) RPM file format package. |
Installation script. | |
upimerge.sh | Script that uses the Universal Installation Merge (UIM) module. |
usrmode.inc | User-mode installer main script. |
unvfiles.tar | User-mode installer modules archive; a set of scripts loaded and executed by usrmode.inc. |
unv-python3.11.tar | Python 3.11 Distribution for Universal Agent. |
Note
If your Universal Agent for AIX distribution file does not contain all of these files, contact Stonebranch, Inc. Customer Support to obtain a correct distribution file.
Installing Universal Agent for AIX
Universal Agent for AIX is installed with the unvinst script, which executes the rpm command. The command to start the script must be executed with the superuser ID.
Note
Stonebranch, Inc. strongly recommends the use of the unvinst script for the AIX installation above any other method.
Component Selection
The Universal Agent package contains many components, which are grouped into five categories. Components in some categories are installed and activated optionally, as specified in the unvinst script by using unvinst command line parameters.
The following table describes each category, provides the default installation configuration for the components in that category, and identifies the command line parameters to use for components that are optionally installed and activated.
Note
The default installation configuration refers to new installs only. For upgrades, installed component configurations are not changed by the upgrade process.
Category | Default Configuration | Description |
|---|---|---|
Base components | Always installed. | Base components are always installed and activated. They include the Universal Broker, Universal Command (UCM), Universal Data Mover (UDM), and others. Base components provide the core agent infrastructure and workload services. |
Universal Automation Center Agent (UAG) | Always installed, but inactive. | Universal Controller utilizes UAG agents to provided distributed, workload automation services. |
Universal Message Service (OMS) | Always installed, but inactive. | OMS is message-oriented middleware that should be deployed on a small set of centrally located servers. It should not be activated on every Agent install. OMS is the network provider for UAG and the Universal Controller. |
Universal Controller command line programs | Not installed. | Universal Controller command line programs provide a command line interface to the Universal Controller. The installation of Universal Controller command line programs is optional. The command line programs are only required on Agents that need to interface with the Universal Controller via the command line. |
Third-party components | Not installed. | This category includes components not developed or maintained by Stonebranch, Inc. |
Starting the Installation Script
To start the unvinst installation script and install all of the AIX packages, issue the following command:
sh ./unvinst [--user username [--userdir directory] [--create_user {yes|no}] ] [--group group name [--create_group {yes|no}] ]
[--keystore {yes|no}] [--convert_opsagent [--opsdir directory] ] [--oms_servers network address] [--oms_port port]
[--ac_agent_clusters clusters] [--ac_agent_ip IP address] [--oms_autostart {yes|no}] [--ac_netname ID]
[--ac_extension_accept_list list] [--ac_extension_python_list list] [--ac_extension_deploy_on_registration {yes|no}]
[--ac_extension_cancel_timeout value {s|m|h|d}] [--ac_process_cancel_timeout value {s|m|h|d}] [--ac_message_level level]
[--ac_loglvl level] [--uag_autostart yes] [--opscli {yes|no}] [--usermode_install {yes|no} [--unvdir directory]
[--unvcfgdir directory] [--unvdatadir directory] [--unvport port] [--python {yes|no}] [--use_tls1_3 {yes|no}]
See AIX 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.
An entry is added to the system initialization table, /etc/inittab, to start the ubrokerd daemon when the system boots to runlevel 2. The inittab entry is similar to the following:
ubroker:2:once:/opt/universal/ubroker-7.7.0/ubrokerd start
The Universal Broker daemon will be installed and run as the username and groupname specified with the installation script parameters, below.
Note
With the Solaris, HP, and AIX installs, the previous installation directories are removed when the native installer has detected that additional directories or files have not been added to the original installation directories. If they have been modified, the directories will remain and can be reviewed and removed, as desired, by your Administrator.
AIX Installation Script Parameters
The following table describes the optional parameters that are available in the installation script, unvinst, when installing Universal Agent.
The parameters are grouped into the following categories:
Parameter | Description | Default |
|---|---|---|
Base Parameters |
|
|
-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 |
‑use_tls1_3 | If specified (using yes), all components will be set up to use TLS 1.3 by setting the | no |
UAG Parameters |
|
|
-c | 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, Note You must include this parameter when upgrading an Opswise Automation Center Agent (1.5, 1.6, or 1.7) to Universal Agent 7.7.x.x. |
|
-d | If --convert_opsagent is specified: Identifies the primary install directory for Universal Agent.
|
|
‑oms_servers | Specifies a value, in the format Note You should always include --oms_servers in | (none) |
‑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 | 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 | 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 | 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_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 | 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_message_level | Specifies a message level for UAG. The install uses this value to set the MESSAGE_LEVEL UAG configuration option. | (none) |
-ac_loglvl | Specifies a log level for UAG. The install uses this value to set the LOGLVL UAG configuration option. | (none) |
‑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 |
OMS Parameters |
|
|
‑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 | 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. |