MIRROPTS

Purpose

For details about how to replicate the CP objects to the Federator, see Mirroring the z/OS current plan to enable the Orchestration Monitor.

Parameters

CONNECTIONFACTORYID('z server connection name')

Required. Name of the connection between the Z connector and z/OS server started task. Ensure that you set this same value as the id and jndiName properties in the connectionFactory.xml file.

It can be a string up to 255 characters that are compliant with the IBM-1047 code page. Blanks are not allowed. If the value is longer than one row, ensure that you always end at column 72 and begin at column 1.

ENGINENAME('registration engine name')

Optional. Name with which the Z controller is to be registered to the Federator; this is also the discovered engine name that will be shown in the Dynamic Workload Console. If another engine with the same name is already registered to the Federator, a suffix is automatically added to generate a unique name.

You can change the engine name at any time, but to make your changes effective the Z controller must be restarted.

The engine name can be up to 64 alphanumeric characters that are compliant with the IBM-1047 code page. The initial character must be a letter. The special characters left parenthesis, right parenthesis, underscore, minus sign, and at signs are allowed; blanks are not allowed. If the value that you are setting is longer than one row, ensure that you always end at column 72 and begin at column 1. The default value is the subsystem name of your Z controller.

FEDERATOR('hostname or IP address'/port)

Required. You can have the Z controller connected to either a single Federator or a load balancer that dispatches and redirects the connections among several instances of the same Federator. In this parameter, specify the host name (or IP address) and port number of the Federator or load balancer, in the format is 'hostname or IP address'/port. The host name can be up to 52 alphanumeric characters, enclosed between quotation marks; the port can be a number between 0 and 65535 (the default is 443, which is the default Federator port used at installation time).

SECRET('secret key string')

The secret key string used to register the engine to the Federator; it must be coincident with the value that you have previously set for the federator.secret variable in the fed_variables.xml file (for details about this file, see Configuring the Federator to mirror data on a database). When successful, the registration process enables the generation of the authentication token to secure the communication.

This parameter is case-sensitive. You can specify up to 36 alphanumeric characters that are compliant with the IBM-1047 code page, enclosed between single quotation marks. Special characters, except blanks, are allowed. If the value that you are setting is longer than one row, ensure that you always end at column 72 and begin at column 1.

You can use the same SECRET parameter for multiple engines. Standby controllers, if any, share the same SECRET and authentication token as the primary controller.

Ensure that the value you specify respects the code page that you set in the CODEPAGE parameter of the OPCOPTS statement.

This parameter is required when:

• The engine is being registered to the Federator for the first time. After that first registration, this parameter can be omitted.
• You changed the value of the federator.secret variable in the fed_variables.xml file (for details, see Configuring the Federator to mirror data on a database).

SOCKETNUM(number of sockets|4)

Optional. The number of sockets that each thread used by the DB Filler task opens to communicate with the Federator. The valid range is from 1 to 10; the default is 4.

A high value enhances the processing of the events, however you must ensure that you set a value appropriate to the Federator’s capabilities.

SOCKETTIMEOUT(timeout|30)

Optional. Time, in seconds, that the DB Filler task waits before the connection with the Federator is interrupted. You can specify a value between 1 and 300 (5 minutes), the default is 30.

SSLKEYRING(SSL key ring db filename)

required. If SSLKEYRINGTYPE is SAF, this parameter specifies the SAF key ring used to connect the security certificates.

If SSLKEYRINGTYPE is USS, this parameter specifies the database containing the keys and certificates. It consists of an SSL working directory and file name, in the format SSLworkdir/filename.kbd.

This parameter is case-sensitive. If you do not specify it, it is set to the value used for HTTPOPTS(SSLKEYRING).

SSLKEYRINGPSW(SSL key ring psw filename)

If SSLKEYRINGTYPE is USS, specifies the file containing the key password. It consists of an SSL working directory name and file name, in the format SSLworkdir/TWS.sth. This parameter is case-sensitive.

SSLKEYRINGTYPE(USS|SAF)

Required. Specifies if the key ring file is a key database USS file or a SAF key ring (default). If this value is set to USS, you can also set SSLKEYRINGPSW parameter.

THREADNUM(number of threads|4)

Optional. The number of threads that the DB Filler task runs to perform operations. The valid range is from 1 to 10; the default is 4.

A high value enhances the processing of the events, however you must ensure that you set a value appropriate to the processing capacity of your z/OS system.