z/OS MVS Programming: Sysplex Services Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Parameter Descriptions

z/OS MVS Programming: Sysplex Services Reference
SA38-0658-00

The parameter descriptions are listed in alphabetical order. Default values are underlined.

,CONTOKEN=contoken
Use this input parameter to specify the responding connection's connect token. CONTOKEN is returned to the connect answer area when the connector issues the IXLCONN macro for the structure.

Note that during rebuild, you must specify the original contoken, not the temporary one.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the requestor's connect token.

EVENT=DISCFAILCONN
EVENT=EXISTINGCONN
EVENT=REBLDQUIESCE
EVENT=REBLDSTOP
EVENT=REBLDCLEANUP
EVENT=REBLDCONNFAIL
EVENT=STRTEMPUNAVAIL
Use this input parameter to specify the connection event to which the requestor is responding:
DISCFAILCONN
Indicates the Disconnected or Failed Connection event (equal to field EEPLDISCFAILCONNECTION in the IXLYEEPL parameter list). The SUBJCONTOKEN keyword is required to identify the connection that is the subject of the event. The RELEASECONN keyword is required. It indicates whether the connection should remain persistent or be released.
EXISTINGCONN
Indicates an Existing Connection event for a connection that is failed-persistent (equal to field EEPLEXISTINGCONNECTION in the IXLYEEPL parameter list). This event is reported to new connections only. Specifying EVENT=EXISTINGCONN deletes the failed-persistent connection from the structure, and the existing connection is no longer defined to the coupling facility. The SUBJCONTOKEN keyword is required to identify the connection that is the subject of the event.
REBLDQUIESCE
Indicates the Rebuild Quiesce event to rebuild or duplex a structure (equal to field EEPLREBUILDQUIESCE in the IXLYEEPL parameter list). Rebuild is initiated through the SETXCF START,REBUILD command or the IXLREBLD REQUEST=START request. Duplexing is initiated through the SETXCF START,REBUILD,DUPLEX command or the IXLREBLD REQUEST=STARTDUPLEX request. (See IXLREBLD — Rebuilding or Duplexing a Structure.) Users must respond to the Rebuild Quiesce event. Specifying EVENT=REBLDQUIESCE indicates that the requestor participating in the user-managed process to rebuild or duplex the structure has quiesced all activity to the structure including the completion of processing based on the use of restart tokens.

Note that if you do not provide a REBLDQUIESCE response, you must either stop the rebuild or duplex process or disconnect from the structure.

REBLDSTOP
Indicates the Rebuild Stop event to stop rebuilding or duplexing a structure (equal to field EEPLREBUILDSTOP in the IXLYEEPL parameter list). Stop rebuilding is initiated through the SETXCF STOP,REBUILD command or the IXLREBLD REQUEST=STOP request. Stop duplexing is initiated through the SETXCF STOP,REBUILD,DUPLEX command or the IXLREBLD REQUEST=STOPDUPLEX request. (See IXLREBLD — Rebuilding or Duplexing a Structure.) Users must respond to the Rebuild Stop event. Specifying EVENT=REBLDSTOP indicates that the requestor is participating in stopping the rebuild or duplexing process.
REBLDCLEANUP
Indicates the Rebuild Cleanup event (equal to field EEPLREBUILDCLEANUP in the IXLYEEPL parameter list). When all connectors to a rebuilt structure issue IXLREBLD REQUEST=COMPLETE to indicate that they have completed processing, the system reports the Rebuild Cleanup event to the event exit. When all connectors to a duplexed structure issue IXLREBLD REQUEST=DUPLEXCOMPLETE to indicate that they have completed processing, the system also reports the Rebuild Cleanup event to the event exit. Users must respond to this event to confirm that resource cleanup for rebuilding is complete. Specifying EVENT=REBLDCLEANUP indicates that the requestor has completed the rebuilding process and has no knowledge of the old structure or has completed the duplexing process and has no knowledge of the old structure.
REBLDCONNFAIL
Indicates that the connection identified by SUBJCONTOKEN failed in its connection to the new structure during rebuild processing. The SUBJCONTOKEN keyword is required to identify the connection that is the subject of the event.
STRTEMPUNAVAIL
Indicates that the structure is temporarily unavailable for coupling facility requests against it. The structure is undergoing a system-managed process, such as system-managed rebuild. Specifying EVENT=STRTEMPUNAVAIL indicates that the responder has completed preparations for the structure being unavailable for the duration of the system-managed process. The EVENTSEQ# is required to identify the specific Structure Temporarily Unavailable event for which the response applies.
,EVENTSEQ#=eventseq#
Use this input parameter to specify the event sequence number. The event sequence number for the event must be the same value that was presented to this connection in the event exit parameter list (IXLYEEPL).

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the fullword field that contains the event sequence number.

,MF=S
,MF=(L,mfctrl)
,MF=(L,mfctrl,mfattr)
,MF=(L,mfctrl,0D)
,MF=(E,mfctrl)
,MF=(E,mfctrl,COMPLETE)
Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter can be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.
,mfctrl
Use this output parameter to specify a storage area to contain the parameters.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list.

,mfattr
Use this input parameter to specify the name of a 1- to 60-character string that can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list. If you do not code mfattr, the system provides a value of 0D, which forces the parameter list to a doubleword boundary.
,COMPLETE
Use this input parameter to require that the system check for required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional parameters that are not documented here. The ones that are not documented do not have any effect on the macro. For example, if SMILE=var were an optional parameter and the default is SMILE=NO_SMILE then it would not be documented. However, if the default was SMILE=:-), then it would be documented because a value would be the default.
,PROXYRESPONSE=NO
,PROXYRESPONSE=YES
Use this input parameter to indicate whether this response is being provided on behalf of a failing connector.
NO
Indicates that this is not a proxy response. The response is on behalf of the connector described by the CONTOKEN keyword.
YES
Indicates that this is a proxy response. The response is being provided on behalf of the connector described by the SUBJCONTOKEN keyword.
Note: To ensure that the PROXYRESPONSE feature is installed on the system on which you are running, issue IXCQUERY REQINFO=FEATURES. QUREQRFPROXYRESPONSE, returned from the IXCQUERY request, indicates whether the PROXYRESPONSE feature is installed.
,RELEASECONN=NO
,RELEASECONN=YES
Use this input parameter to specify whether the connection should remain persistent or be released.
NO
Indicates that the requestor has completed processing for the failed connection event, and specifies that XES should continue processing for the failed connection. The persistence attribute of the connection is not affected by this response.
YES
Indicates that the requestor has completed processing for the failed connection event, specifies that XES should continue processing for the failed connection, and specifies that this connection is no longer required to be persistent.
,RETCODE=retcode
Use this output parameter to specify the location in which the system is to copy the return code from GPR 15.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword to contain the return code.

,RSNCODE=rsncode
Use this output parameter to specify the location in which the system is to copy the reason code from GPR 0.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword to contain the reason code.

,SUBJCONTOKEN=subjcontoken
Use this input parameter to specify the CONTOKEN for the connection described by the event. SUBJCONTOKEN must be the same value that was presented to the event exit in field EEPLSUBJCONTOKEN of the IXLYEEPL.

Do not provide a proxy response on behalf of a failing connector until AFTER the EEPLDISCFAILCONNECTION event for the subject user has been presented to your event exit. You can use the value of the EEPLSUBJCONTOKEN field from that invocation of the event exit as input for this parameter.

Note that if the subject connector is not in the failing state, the IXLEERSP request will fail with the IXLRSNCODESUBJCONNNOTFAILING reason code.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the CONTOKEN for the connection described by the event.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014