Universal Agent for Solaris Installation

Universal Agent for Solaris Installation

Installation Process

Installation of Universal Agent for Solaris is a three-step process:

Step 1

Download product distribution file (see Universal Agent for UNIX - Distribution File).

Step 2

Extract the installation files from the distribution file.

Step 3

Install the extracted files.

Extracting the Universal Agent for Solaris Installation Files

Stonebranch, Inc. provides a separate product distribution file for the following Solaris systems:

  • Intel-based systems

  • SPARC-based systems

Universal Agent for Solaris product distribution files are in a compressed tar format.

Intel-Based Systems

To uncompress and extract the installation files from the distribution file, issue the following command:

zcat sb-7.7.x.x-solaris-10-x64.tar.Z | tar xvf -

This command assumes that:

  • Name of the distribution file is sb-7.7.x.x-solaris-10-x64.tar.Z.

  • File is located in the current working directory.

Distribution File

The following table identifies the files contained in the distribution file.

File

Description

File

Description

Readme.unv

Summary of the installation procedure.

unv-7.7.x.x-solaris-10-x64.pkg

Solaris Intel-based file format package.

unv-opscli-7.7.x.x-solaris-10-x64.pkg

Universal Controller Command Line Interface (CLI) Intel-based file format package.

unvinst

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 Solaris (Intel-based systems) distribution file does not contain these files, contact Stonebranch, Inc. Customer Support to obtain a correct distribution file.

SPARC-Based Systems

To uncompress and extract the installation files from the distribution file, issue the following command:

zcat sb-7.7.x.x-solaris-10-sparcv9.tar.Z | tar xvf -

This command assumes that:

  • Name of the distribution file is sb-7.7.x.x-solaris-10-sparcv9.tar.Z.

  • File is located in the current working directory.

The actual base name of the .pkg file depends on the Solaris version for which the distribution file is intended. (See Distribution File Format for distribution file naming conventions.)

Distribution File

The following table identifies the files contained in the distribution file.

File

Description

File

Description

Readme.unv

Summary of the installation procedure.

unv-7.7.x.x-solaris-10-sparcv9.pkg

Solaris SPARC-based file format package.

unv-opscli-7.7.x.x-solaris-10-sparcv9.pkg

Universal Controller Command Line Interface (CLI) SPARC-based file format package.

unvinst

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 Solaris (SPARC-based systems) distribution file does not contain all of these files, contact Stonebranch, Inc. Customer Support to obtain a correct distribution file.

Solaris Package

Universal Agent for Solaris is packaged as a set of Solaris packages (extension .pkg).

The following table identifies the Universal Agent for Solaris package names.

Package Name

Description

Package Name

Description

UNVcom

Universal Agent common files, such as, message catalogs and translation tables.

UNVctl

Universal Control Manager

UNVcts

Universal Control Server

UNVqry

Universal Query

UNVspl

Universal Spool

UNVuag

Universal Automation Center Agent

UNVubr

Universal Broker

UNVucm

Universal Command Manager

UNVucr

Universal Certificate

UNVucs

Universal Command Server

UNVudm

Universal Data Mover Manager

UNVuds

Universal Data Mover Server

UNVuem

Universal Event Monitor Manager

UNVues

Universal Event Monitor Server

UNVusp *

Universal Connector SAP

UNVutl

Universal Utilities

UNVoms

Universal Message Service (OMS)

UNVopscli

Universal Controller Command Line Interface (CLI)

Note

UNVusp is not provided with the Universal Agent for Solaris Intel-based file format package.

Installing Universal Agent for Solaris

Universal Agent for Solaris is installed with the unvinst script, which executes the pkgadd 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 Solaris 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

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.

UAG is activated using the --oms_servers parameter.

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.

OMS is activated using the --oms_autostart parameter.

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.

Universal Controller command line programs are installed using the --opscli parameter.

Third-party components

Not installed.

This category includes components not developed or maintained by Stonebranch, Inc.
 
For example, Universal Agent 7.7.0.0 provides a Python 3.11 distribution that can be installed under the Universal Agent install directory. This distribution is provided so that a reliable Python environment exists on systems that may not provide for all users.

Starting the Installation Script

To start the installation script, unvinst, and install all of the Solaris 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 Solaris 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.

System initialization files /etc/init.d/ubrokerd and /etc/rc3.d/S85ubrokerd are created to start the ubrokerd daemon when the system boots to runlevel 3.

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.

Solaris 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:

Category

Description

Category

Description

Base

Used for base install.

OMS

Used for an active OMS configuration.

UAG

Used for an active UAG configuration.

CLI

Used for Universal Controller CLI programs install.

User Mode

Used for user mode installation.

Third-party

Used to manage third-party components.

Parameter

Description

Default

Parameter

Description

Default

Base Parameters

 

 

-u
‑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 Solaris 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

‑‑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
‑‑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 (/export/home/<username>), --userdir must specify the path to that home directory.

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

/export/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

‑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

‑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

‑use_tls1_3
‑‑use_tls1_3

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

UAG Parameters

 

 

-c
‑convert

‑‑convert_opsagent

Causes unvinst to execute opsmerge.sh (residing in /opt/universal/uagsrv/bin), which performs the following tasks:

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

  2. Searches for an active Opswise Automation Center Agent 1.6 or 1.7 daemon process and attempts to stop it.

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

/export/home/opswise

‑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

You should always include --oms_servers in unvinst; OMS is the network communications provider between Controller 7.7.x.x and Agent 7.7.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