Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

File

Description

Readme.unv

Summary of the installation procedure.

unv-7.6.x.x-linux-3.10-x86_64.rpm

Linux RPM file format package.

unv-opscli-7.6.x.x-linux-3.10-x86_64.rpm

Universal Controller Command Line Interface (CLI) RPM 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.711.tar

Python 3.7 11 Distribution for Universal Agent.

...

File

Description

Readme.unv

Summary the installation procedure.

unv-7.6.x.x-linux-3.10-s390x.rpm

Linux RPM file format package.

unv-opscli-7.6.x.x-linux-3.10-s390x.rpm

Universal Controller Command Line Interface (CLI) RPM 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.711.tar

Python 3.7 11 Distribution for Universal Agent.

...

File

Description

Readme.unv

Summary the installation procedure.

unv-7.6.x.x-linux-3-x86_64-deb

Linux RPM file format package.

unv-opscli-7.6.x.x-linux-3-x86_64.deb

Universal Controller Command Line Interface (CLI) RPM 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.711.tar

Python 3.7 11 Distribution for Universal Agent.

...

File

Description

Readme.unv

Summary the installation procedure.

unv-7.6.x.x-linux-3.10-ppc64le.rpm

Linux RPM file format package.

unv-opscli-7.6.x.x-linux-3.10-ppc64le.rpm

Universal Controller Command Line Interface (CLI) RPM 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.711.tar

Python 3.7 11 Distribution for Universal Agent.

...

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.6.0.0 provides a Python 3.7 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.

...

Panel
sh ./unvinst [--user username [--userdir directory] [--create_user {yes|no}] ] [--group group name [--create_group {yes|no}] ] 
             [--keystore {yes|no}] [--security {appdef|default|inherit|pam|pam_sessions}]
             [--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] [--uag_autostart yes]
             [--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] [--opscli {yes|no}] [--usermode_install {yes|no} [--unvdir directory] [--unvcfgdir directory] 
             [--unvdatadir directory] [--unvport port] [--python {yes|no}] ] [--use_tls1_3 {yes|no}] [--register_ubrokerd {yes|no}] [--ubrokerd_id value]

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.
 

...

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

‑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

‑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

‑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

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

Note
titleNote

pam_sessions is a valid value only for the UCMD Server and UDM Server.


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

Note
titleNote

--ubroker_start is ignored for user mode installs.


yes
Anchor
-keystore
-keystore
‑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

-register_ubrokerd
--register_ubrokerd

Specifies whether the Universal Broker daemon will be defined to systemd for automatic ubrokerd startup. When this value is 'yes' for system mode installs, a systemd unit file named ubrokerd.service is created. For user mode installs, the name of the file is formatted as described by the -ubrokerd_id command line option.
The install will attempt to install this file into the configured systemd system unit file directory. If a configured value cannot be determined, the script uses /usr/lib/systemd/system. If this option is not specified, it defaults to 'no', and the ubrokerd daemon is not registered with systemd.
no

Anchor
UAG
UAG
UAG Parameters



-c
‑convert

Anchor
--convert_opsagent
--convert_opsagent
‑‑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.

/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 a Controller 7.6.x.x and Agent 7.6.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_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

‑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

-ac_message_level
--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
--ac_loglvl

Specifies a log level for UAG. The install uses this value to set the LOGLVL UAG configuration option.(none)

‑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



Anchor
--usermode_install
--usermode_install
-U
-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)

-ubrokerd_id
--ubrokerd_id

If --usermode_install is set to yes: Specifies the value used to uniquely identify the ubrokerd unit file when the Universal Brokerd daemon is registered with systemd, as directed by the -register_ubrokerd option. This value is used to format a systemd unit file name in the format ubrokerd@<id>.service, where '<id>' is the value specified for this option. 

 If this option is omitted, the value specified for the -unvport option is used. For system mode installs, the unit file name will always be ubrokerd.service.

Value of --unvport option.

Anchor
Third-party
Third-party
Third-Party Parameters



‑python

Anchor
python
python
‑‑python

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

no

Additional Parameter



-?
-h
‑help
‑‑info

Displays command line help.

n/a

...