BKPTOPTS

Purpose

The optional BKPTOPTS statement defines the local attributes for the TCP/IP communication between the primary controller (that is, a subsystem with OPCOPTS OPCHOST set to YES, PLEX, or STANDBY) and the backup controller. Define this statement on both controllers.
Note: If in ROUTOPTS you set that the primary controller uses HTTP or HTTPS communications to reach a destination, ensure that you set the same protocol for the backup controller to communicate.

Format


1  BKPTOPTS?  CHECKROLE (
2.1 YES
2.1! NO
1 )?  CONNTIMEOUT (
2.1! 60
2.1 TCPIP timeout interval
1 )?  CP1DUMPPROC (
2.1! EQQSECP1
2.1 dump procedure name
1 )?  CP1RESTPROC (
2.1! EQQRECP1
2.1 restore procedure name
1 )?  CP2DUMPPROC (
2.1! EQQSECP2
2.1 dump procedure name
1 )?  CP2RESTPROC (
2.1! EQQRECP2
2.1 restore procedure name
1 )?  HOSTNAME (
2.1! local hostname
2.1 hostname
2.1 IP address
1 )?  KEEPALIVE (
2.1! 60
2.1 seconds
1 )?  LOCPORTNUMBER (
2.1! 426
2.1 TCPIP port
1 )?  LTPDUMPPROC (
2.1! EQQSENLT
2.1 dump procedure name
1 )?  LTPRESTPROC (
2.1! EQQRESLT
2.1 restore procedure name
1 )

1?  NCPDUMPPROC (
2.1! EQQSENCP
2.1 dump procedure name
1 )?  NCPRESTPROC (
2.1! EQQRENCP
2.1 restore procedure name
1 )?  PEERHTPPORT (
2.1! 511
2.1 HTTP port number
1 )?  PEERHTSPORT (
2.1! 512
2.1 SSL port number
1 )  PEERHOSTNAME (
2.1 hostname
2.1 IP address
1 )?  PEERPORTNUMBER (
2.1! 426
2.1 TCPIP port
1 )?  SSLAUTHMODE (
2.1! CAONLY
2.1 STRING
1 )?  SSLAUTHSTRING (
2.1! tws
2.1 SSL string
1 )?  SSLKEYSTORE (
2.1 SSL keystore db file name
1 )?  SSLKEYSTOREPSW (
2.1 SSL keystore pw file name
1 )?  SSLLEVEL (
2.1! OFF
2.1 FORCE
1 )?  TCPIPJOBNAME (
2.1! TCPIP
2.1 TCPIP started task
1 )

Parameters

CHECKROLE(YES|NO)
Determines if the controller configured as primary (with OPCHOST(YES) set in the OPCOPTS statement) performs a check about the backup controller activity, before starting.

The primary controller tries to connect to the backup controller host name and port number as a TCP/IP client. If the connection is established, it means that the backup controller is running as the primary controller after a takeover occurred. In this case, the primary controller starts as the backup controller.

If the connection is not established, it means that the backup controller is not running as the primary controller, therefore the primary controller continues its normal startup processing.

CONNTIMEOUT(TCPIP timeout interval|60)
It defines how many seconds a TCP/IP connection attempt waits before a timeout occurs. It is expressed in seconds. Valid values are from 1 to 10000. The default is 60.
CP1DUMPPROC(dump procedure name|EQQSECP1)
The name of the dump procedure that you set with EQQJOBS for the CX, CP1, and XD1 files. The default is EQQSECP1.
CP1RESTPROC(restore procedure name|EQQRECP1)
The name of the restore procedure that you set with EQQJOBS for the CX, CP1, and XD1 files. The default is EQQRECP1.
CP2DUMPPROC(dump procedure name|EQQSECP2)
The name of the dump procedure that you set with EQQJOBS for the CX, CP2, and XD2 files. The default is EQQSECP2.
CP2RESTPROC(restore procedure name|EQQRECP2)
The name of the restore procedure that you set with EQQJOBS for the CX, CP2, and XD2 files. The default is EQQRECP2.
HOSTNAME('hostname|IP address| hostname')
The local host name or IP address used by the TCP/IP communication subtasks. The default is the IP address returned by TCP/IP. It can be up to 52 alphanumeric characters and specifies a host name or IP address in IPv4 or IPv6 format. Enclose this value in single quotation marks.

Omitting this parameter might affect how long the server initialization process takes. TCP/IP must free resources used by previously opened connections. Before doing this, it waits the time specified in the TCP/IP profile, through the FINWait2time parameter of the TCPCONFIG statement. When this time limit is reached, the system waits a further 75 seconds before dropping the connection. The default is 600 seconds, but you can specify a lower value. For details about the TCPCONFIG statement, see z/OS® Communication Server IP Configuration Reference.

KEEPALIVE(seconds|60)
Sets the TCP_KeepAlive socket option for the current connection between the primary controller and backup controller. This allows the backup controller to be notified in a timely manner when an unexpected system failure occurs on the primary controller site.

It is expressed in seconds. Valid values are from 1 to 2147460. The default is 60.

For detailed information about the TCP_KeepAlive socket option, see z/OS Communications Server: IP Programmer's Guide and Reference.

LOCPORTNUMBER(TCPIP port|426)
The local TCP/IP port number used by the TCP/IP communication subtask of the controller or backup controller to communicate with each other. Valid values are from 0 to 65535. The default is 426.
LTPDUMPPROC(dump procedure name|EQQSENLT)
The name of the dump procedure that you set with EQQJOBS for the LTP file. The default is EQQSENLT.
LTPRESTPROC(restore procedure name|EQQRESLT)
The name of the restore procedure that you set with EQQJOBS for the LTP file. The default is EQQRESLT.
NCPDUMPPROC(dump procedure name|EQQSENCP)
The name of the dump procedure that you set with EQQJOBS for the NCP, NCX, and NXD files. The default is EQQSENCP.
NCPRESTPROC(restore procedure name|EQQRENCP)
The name of the restore procedure that you set with EQQJOBS for the NCP, NCX, and NXD files. The default is EQQRENP.
PEERHOSTNAME('hostname|IP address')
The host name or IP address of the partner controller. It can be up to 52 alphanumeric characters and specifies a host name or IP address in IPv4 or IPv6 format. Enclose this value in single quotation marks. This parameter is required.
PEERHTPPORT(HTTP port number|511)
The port number used by the HTTP server to listen for non-SSL connections. This parameter is used by the backup controller after you issue the modify command /f subsys,BKTAKEOVER. Valid values are from 0 to 65535.
PEERHTSPORT(SSL port number|512)
The SSL port number used by the HTTP server to listen for SSL-connections. This parameter is used by the backup controller after you issue the modify command /f subsys,BKTAKEOVER. Valid values are from 0 to 65535.
PEERPORTNUMBER(TCPIP port|426)
The TCP/IP port number of the partner controller. Valid values are from 0 to 65535. The default is 426.
SSLAUTHMODE(STRING|CAONLY)
The SSL authentication type. Specify one of the following values:
CAONLY
The controller checks the certificate validity by verifying that a recognized Certification Authority has issued the peer certificate. Information contained in the certificate is not checked. This is the default value.
STRING
The controller checks the certificate validity as described in the CAONLY option. It also verifies that the Common Name (CN) of the Certificate Subject matches the string specified in the SSLAUTHSTRING parameter.
To avoid any communication error, specify the same SSLLEVEL value for the scheduler started tasks that are to communicate with each other.
SSLAUTHSTRING(SSL string|tws)
The string used to verify the certificate validity when you set SSLAUTHMODE to STRING. The string is up to 64 characters. The default is tws.
SSLKEYSTORE(SSL keystore db filename)
Identifies the database containing keys and certificates. It consists of an SSL working directory name and file name, in the format SSLworkdir/TWS.kbd. It is case sensitive. This field is required if the SSLLEVEL parameter is set to FORCE.
SSLKEYSTOREPSW(SSL keystore pw filename)
Identifies the file containing the key password. It consists of an SSL working directory name and file name, in the format SSLworkdir/TWS.sth. It is case sensitive. This field is required if the SSLLEVEL parameter is set to FORCE.
SSLLEVEL(FORCE|OFF)
The SSL authentication type. Specify one of the following values:
OFF
The scheduler component does not support SSL authentication for its connections. This is the default value.
FORCE
The scheduler component uses SSL authentication for all its connections. It refuses any incoming connection that is not SSL.

To avoid communication errors, specify the same SSLLEVEL value for the scheduler started tasks that are to communicate with each other.

TCPIPJOBNAME(TCPIP started task|TCPIP)
The name of the TCP/IP started task running on the z/OS® system where you run the controller. Set this parameter when you have multiple TCP/IP stacks or a TCP/IP started task with a name different from TCPIP. 
 BKPTOPTS TCPIPJOBNAME('TCPIP')  ❶
  HOSTNAME('1.11.111.111')     ❷
  LOCPORTNUMBER(33014)         ❸
  PEERHOSTNAME('2.22.222.222') ❹
  PEERPORTNUMBER(33014)        ❺
In this example, the BKPTOPTS statement is set on the backup controller, with the following meanings:
❶
The TCP/IP started task name set to the default value.
❷
The IP address of the backup controller.
❸
The number of the local port to communicate with the primary controller.
❹
The IP address of the primary controller.
❺
The number of the port of the primary controller.