Universal Control Manager for zOS
- Former user (Deleted)
- Stonebranch (Deactivated)
- IT Stonebranch
Introduction
This Universal Control (UCTL) Manager information is specific to the z/OS operating system.
UCTL Manager for z/OS executes as a batch job.
Control Requests
UCTL Manager for z/OS supports all three Universal Control control requests:
- Start (START_CMD option)
- Stop (STOP_CMD option)
- Refresh (REFRESH_CMD option)
JCL Procedure
The following figure identifies the UCTL Manager for z/OS JCL procedure (UCTLPRC, located in the SUNVSAMP library) that is provided to simplify the execution JCL and future maintenance.
DD Statements used in JCL Procedure
The following table describes the DD statements used in the UCTL Manager for z/OS JCL procedure, above.
ddname | DCB Attributes * | Mode | Description |
|---|---|---|---|
STEPLIB | DSORG=PO, | Input | Load library containing the program being executed. |
UNVNLS | DSORG=PO, | Input | UCTL national language support library. Contains message catalogs and code page translation tables. |
UNVTRACE | DSORG=PS, | Output | UCTL trace output. |
SYSPRINT | DSORG=PS, | Output | stdout file for the UCTL program. UCTL does not write any messages to SYSPRINT. |
SYSOUT * | DSORG=PS, | Output | stderr file for the UCTL program. UCTL writes its messages to SYSOUT. |
* The C runtime library determines the default DCB attributes. Refer to the IBM manual OS/390 C/C++ Programming Guide for details on default DCB attributes for stream I/O
JCL
The following figure illustrates the UCTL Manager for z/OS JCL using the UCTLPRC JCL procedure, above.
Job step STEP1 executes UCTLPRC.
The configuration options are specified on the SYSIN DD.
Configuration
Configuration consists of:
- Setting default options and preferences for all executions of UCTL Manager.
- Setting options and preferences for a single execution of UCTL Manager.
Configuration Sources
Configuration options are read from the following sources:
- PARM keyword
- SYSIN ddname
- Command file ddname
- Configuration file
The order of precedence is the same as the list above; command line being the highest, and configuration file being the lowest. That is, options specified via a PARM keyword override options specified via a SYSIN ddname, and so on.
Detailed information on these methods of configuration can be found in Configuration Management.
Configuration File
The UCTL Manager configuration file is provided to the manager by the local Universal Broker with which it registers. The UCTL Manager configuration file is located in the UCTCFG00 member of the PDSE allocated to the UNVCONF ddname in the Universal Broker started task.
The configuration file, provided by the local Universal Broker, provides the simplest method of specifying configuration options whose values will not change with each command invocation. These default values are used if the options are not read from one or more other sources.
Some options only can be specified in the configuration file; they have no corresponding command line equivalent. Other options cannot be specified in the configuration file; they must be specified via one or more other sources for a single execution of UCTL Manager.
Note
For any changes to the UCTL Manager configuration file to become active, a Universal Broker refresh is required, or the Universal Broker started task must be restarted.
Configuration Options Categories
The following table categorizes the configuration options used to execute Universal Control Manager for z/OS into logical areas of application. Each Category name is a link to a table of options in that category. Each Option Name in those tables is a link to detailed information about that option.
Category | Description |
Control command to execute. | |
Network address of the remote system. | |
User account the Control command executes with on the remote system. | |
X.509 certificate related options. | |
Options used to define event generation. | |
Options required for local broker registration. | |
Universal Control message options. | |
Options used to control the process of network data. | |
Alternative methods to specify command options. | |
Options use to display command help and program versions. |
Certificate Category Options
Option Name | Description |
ddname of the PEM-formatted trusted CA X.509 certificates | |
ddname of Manager's PEM-formatted X.509 certificate. | |
Number of days prior to certificate expiration to begin issuing informational messages about the expiration. | |
Location of Manager's PEM-formatted CRL. | |
ddname of Manager's PEM-formatted RSA private key. | |
Password for the Manager's PRIVATE_KEY. | |
SSL/TLS implementation to be used for network communications | |
Specification that the Broker's X.509 certificate host name field must be verified. | |
Specification that the Broker's X.509 certificate serial number field must be verified. |
Command Category Options
Option Name | Description |
Identity of the started component. | |
Instruction to a Broker to refresh configuration data. | |
Instruction to a Broker to start a component. | |
Instruction to stop a component being executed by a Broker. |
Events Category Options
Option Name | Description |
Specification for whether or not product activity monitoring events are generated. | |
Events to be generated as persistent events. |
Local Category Options
Option Name | Description |
Local Universal Broker with which the Universal Control Manager must register |
Messages Category Options
Option Name | Description |
Language of messages written. | |
Level of messages written. | |
List of message IDs representing Universal messages to be suppressed. |
Miscellaneous Category Options
Option Name | Description |
Write command option help. | |
Write program version. |
Network Category Options
Option Name | Description |
Code page used to translate text data to and from the network. | |
SSL/TLS cipher list for the control session. | |
Minimum SSL/TLS protocol level that will be negotiated and used for communications channels. | |
Maximum number of seconds considered acceptable to wait for data communications. |
Options Category Options
Option Name | Description |
Encrypted command file. | |
Plain text command file. | |
Encryption key used to decrypt an encrypted command file specified by option COMMAND_FILE_ENCRYPTED. |
Remote Category Options
Option Name | Description |
Number of host connection attempts before ending with an error. | |
Host or IP address to use for all outgoing IP connections. | |
TCP/IP host name of the remote Broker. | |
TCP/IP port number of the remote Broker. |
User Category Options
Option Name | Description |
User ID or account with which to execute the Control command. | |
Password associated with USER_ID. |
Command Line Syntax
The following figure illustrates the command line syntax – using the command line, long form of the configuration options – of Universal Control Manager for z/OS.
uctl{ -start compname [-cmdid id] | -stop compID [-userid user [-pwd password] ] |-refresh [compname] }-host hostaddress[-file ddname | -encryptedfile ddname [-key key] ] *[-port port][-cmdid id][-hostname_retry_count count][-outboundip host][-ssl_implementation {openssl | system}[-system_id ID][-lang language][-level {trace|audit|info|warn|error}][-msg_suppression_list list ][-ca_certs ddname [-verify_host_name {yes|no|hostname}][-verify_serial_number number] ][-cert ddname -private_key ddname [-private_key_pwd password] ][-days number][-crl ddname][-codepage codepage][-ctl_ssl_cipher_list cipherlist][-min_ssl_protocol option][-delay seconds]
uctl{ -help | -version }
* The command file (-file or -encryptedfile) can contain some or all required and/or optional configuration options, including a control request and -host. If a command file is specified on the command line, and it contains the required control request and -host options, those options do not have to be specified additionally on the command line.