G Voyager and Pioneer Control File Parameters

Table G-1 lists Voyager control file parameters and the corresponding descriptions.

Table G-1 Voyager Control File Parameters

Voyager Control File Parameters Description

SUBPOOL_SIZE=

The size of the cache in Subpool 231(ECSA) Voyager will allocate for event messages created by installed exits. The values are from 0200K to 7500K. Before allocating verify that there is enough ECSA storage available.

Sample value: 1000K

TCPN=

The TCPIP STC name where Voyager is executing. This is required for socket allocations.

Sample value: TCPIP

IPAD=

The LDAP IP address or hostname. The hostname can only be 40 characters long.

Sample value: 10.10.10.10

PORT=

The port the LDAP is listening on for Voyager messages.

Note: This is the value _agentPort_ as specified in racf.properties.Sample value: 5790

DEBUG=

Enter Y to turn on debugging and enter N to turn it off. If you enter Y, then the output is sent to DEBUGOUT.

Note: If you set DEBUG=Y produces enormous log. It is advised not to use DEBUG=Y in production.

Default value: N

ESIZE=

The value of this parameter must be set to 16 always. This never changes.

CSDATA=

Enter Y if the RACF database is supporting CSDATA fields. Otherwise, enter N.

If EXTRACT=Y, then set the value of this parameter to N.

Sample value: N

VOYAGER_ID=

The ID defined to LDAP for Voyager, if several Voyagers are using the same RACF database, then they must all have the same VOYAGER_ID.

This parameter is used for the following purposes:

  • For user documentation.

  • Comes in handy when one VOYAGER PER LPAR.

  • Gateway uses VOYAGER_ID= and some consideration is given to configure to exclude gateway events by VOYAGER_ID if needed.

Sample value: VOYID

CACHE_DELAY=

The delay (in seconds) Voyager will use when issuing a write socket to the LDAP. This parameter is used in conjunction with communications from the Mainframe Connector Portion to Oracle Identity Manager Appserver Parent Product.

Sample value: 005

AUDIT_LOG=

Enter YES to turn on audit logging. Otherwise, enter NO.

Sample value: YES

PIONEER_ID=

(Optional) Enter the RACF userID defined for Pioneer.When Voyager reads a subpool message and the issuer is this RACF userID, then Voyager will not send this message to the LDAP.If you do not specify a value for this parameter, no action takes place.

EXTRACT=

Enter Y to utilize a RACF Extract versus a RACF LISTUSER. Otherwise, enter N. This Parameter should be "Y" unless told otherwise by Oracle Support Representative.

Sample value: Y

CONNECT_RETRY=

The number of times Voyager will attempt to reconnect. You can specify a value from 001 through 999. A value of 999 indicates unlimited retries.

Note: 999 indicates unlimited retires.

Sample value: 009

CONNECT_INTV=

The number of seconds between each reconnect attempt. The value can range from 01 through 99.If CONNECT_RETRY=010 and CONNECT_INTV=10, then Voyager will retry the connection to the LDAP for 100 seconds. After the 100 seconds have elapsed, Voyager will shutdown.

Sample value: 05

EBCDIC_COUNTRY_CODE

This parameter represents the EBCDIC Country Code page override.

Note: Do not specify values for special reserved usage parameters unless directed by Oracle Support. These parameters are available only for specific custom usage, and their sample values are not available.

These parameters must be used along with the gateway configuration property file (_mainframeCodePage_), which is available inside the racf.properties file.

EBCDIC_TILDE_CHR

This parameter represents the EBCDIC HEX value tilde character that indicates the end of data override.

Note: Do not specify values for special reserved usage parameters unless directed by Oracle Support. These parameters are available only for specific custom usage, and their sample values are not available.

These parameters must be used along with the gateway configuration property file (_mainframeCodePage_), which is available inside the racf.properties file.

Table G-2 lists Pioneer control file parameter and the corresponding descriptions.

Table G-2 Pioneer Control File Parameters

Pioneer Control File Parameter Description

TCPN=

The TCPIP STC name where Voyager is executing. This is required for socket allocations.

Sample value: TCPIP

IPAD=

This is the Reserved value. The value of this parameter must be set to 0.0.0.0 always.

PORT=

The port at which Pioneer is listening for LDAP messages.

Sample value: 5709

DEBUG=

Enter Y to turn on debugging and enter N to turn it off. If you enter Y, then the output is sent to DEBUGOUT.

Note: Setting this flag to Y will create enormous log. Do not use it on production systems.

Sample value: N

ESIZE=

The value of this parameter must be set to 16 always. This never changes.

LPAR=

Enter a 20-byte unique name for the LPAR of the Voyager system.

Sample value: zOS-2.2-TEST

POST_PROC_ALIAS=

If you set the value of this parameter to T, then Pioneer will honor all DEFINE/DELETE alias requests from the LDAP.

If you set the value of this parameter to F, Pioneer will ignore all requests for DEFINE or DELETE aliases.

Sample value: T

IDLEMSG=

Can take a value of either Y or N.

If you set the value of this parameter to Y, then for every 60 minutes Pioneer is idle, it displays an IDLE message.

Sample value: N

DEBUGOUT=

This parameter is valid only if you set DEBUG=Y.

If you have set DEBUG=N, then this parameter is ignored.

If the output must be sent to SYSOUT, then use the following format:

SYSOUT,CLASS(x)

In this format, x represents the JES2 output class desired, please use a lettered SYSOUT CLASS available at your installation versus "*".

Sample value: IBM z/oS JCL

Note: The usage of SYSOUT,CLASS(*) has been noted to cause IKJ56231I FILE DEBUGOUT NOT ALLOCATED, SYSTEM OR INSTALLATION ERROR+ when used with a Control card.

SPIN_CLASS=

The output SPIN class for DEBUGOUT when Pioneer shutdown or debugging is turned off through Operator command.

Sample value: X

AUDIT_LOG=

If you set the value of this parameter to YES, then the Audit log is turned on and the output goes to AUDTLOG ddname of Pioneer.

If you set the value of this parameter to NO, then auditing will not be in effect.

Sample value: YES

SECURE_ID=

YES is required.

NO is not accepted and will fail.

SECURE id can run in one of the three following modes:

  • SECURE_ID = YES, DEFAULT = YES

    This mode uses RACF userid IDFAGNT as the default userid. This must have 'SPECIAL' as a coded attribute.

  • SECURE_ID = YES, DEFAULT = NO, ENCRYPT = NO, ID = racfuserid

    This mode uses the RACF userid for RACF API calls and must have 'SPECIAL' coded on that RACF userid.

  • SECURE_ID = YES, DEFAULT = NO, ENCRYPT = YES

    This mode uses the RACF userid that was encrypted using the new IDFSECUT program. This encrypted RACF userid will be used for all RACF API calls.

    Sample value: YES, DEFAULT=YES

SMF=

A value of either N or Y is required.

If you set the value of this parameter to N, then SMF recording is not turned off, but custom SMF TYPE 245 subtype 1 and 2 records are not created when the SECURE_ID is invoked.

If you set the value of this parameter to Y, then every time the SECURE_ID is invoked, custom SMF TYPE 245 subtype 1 and 2 records are created. In addition, SMFPRMxx of z/OS SYS1.PARMLIB must be reviewed to verify that this SMF Type record will be written. Also, Pioneer must have the z/OS authority to write custom SMF type 245 entries.

Sample value: N

EBCDIC_COUNTRY_CODE

This parameter represents the EBCDIC Country Code Page override.

EBCDIC_TILDE_CHR

This parameter represents the EBCDIC HEX value Tilde Character that indicates the end of data override.