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:
,CART=cart
Use this input parameter to specify command-and-response token (CART) associated with the console to be notified when any rebuild- or duplexing rebuild-related start or completion occurs. The system reports a Rebuild Quiesce event with OPERATOR as the reason and places the CART value in the event exit parameter list IXLYEEPL (field EEPLCART) for each connected user.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the eight-character input field that contains the command-and-response token (CART).

,CFNAME=cfname
Use this input parameter to specify the name of a coupling facility in which structure rebuild is requested for every structure allocated other than XCF signalling structures. Note that this function is intended only for use by a cleanup utility. The system will not start rebuild for XCF signalling structures in the named coupling facility. The user should rebuild XCF signalling structures in a coupling facility one at a time.

The coupling facility name must be 8 characters long, padded on the right with blanks if necessary. The name may contain numeric characters, uppercase alphabetic characters, national characters ($, @, #), or an underscore (_), and must begin with an uppercase alphabetic character.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 8-character input field that contains the coupling facility name.

,CONSID=consid
Use this input parameter to specify the system-generated console ID for the console or extended MCS console to be notified when any rebuild- or duplexing rebuild-related start or completion occurs.

The system reports a Rebuild Quiesce event with OPERATOR as the reason, and places the console id of the issuing console in the event exit parameter list IXLYEEPL (field EEPLCONSID) for each connected user.

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

,CONTOKEN=contoken
Use this input parameter to specify the original connect token returned to the requestor by the IXLCONN macro when connecting to the structure.

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

,IGNOREDUPLEX=NO
,IGNOREDUPLEX=YES

Use this input parameter to specify whether to use the completion of the processing initiated by this request as a trigger to reduplex the structure. A specification of DUPLEX(ENABLED) in the CFRM active policy means that the system might automatically duplex the structure in response to various triggers.

IGNOREDUPLEX=NO
Use the completion of the processing that is initiated by this request as a trigger to reduplex the structure.
IGNOREDUPLEX=YES
Do not use the completion of the processing that is initiated by this request as a trigger to reduplex the structure. This request does not prevent a duplexing rebuild from being started at a later time after the processing completes.

To prevent the system from reduplexing the structure at a later time, change the DUPLEX specification for the structure to DUPLEX(ALLOWED) before stopping duplexing, or change the DUPLEX setting for the structure to DUPLEX(DISABLED), which will cause XCF to initiate the stop processing. Change the DUPLEX setting back to DUPLEX(ENABLED) when you no longer need to prevent the system from reduplexing.

,KEEP=NEW
,KEEP=OLD
Use this input parameter to specify which structure should remain after the duplexing rebuild has been stopped.
KEEP=NEW
Duplexing rebuild should stop and switch to using the new structure.
KEEP=OLD
Duplexing rebuild should stop to fall back to using the old structure.
,LESSCONNACTION=TERMINATE
,LESSCONNACTION=CONTINUE
Use this input parameter to indicate whether XES is to allow a rebuild to continue, in spite of a degradation in connectivity to the new structure.

When a structure rebuild is requested, XES evaluates whether the new structure will have the same or better connectivity than the current structure, as determined by the Sysplex Failure Management (SFM) weights of the connector's systems attached to the coupling facility. If the evaluation shows that the new structure will have poorer connectivity than the current structure, XES uses the LESSCONNACTION specification to determine what action to take in regard to the structure rebuild.

Note:
  1. If the IXLREBLD invocation specifies REASON=LOSSCONN, XES ignores the LESSCONNACTION keyword and processes the request as if LESSCONNACTION=TERMINATE were specified.
  2. For duplexing rebuild requests, LESSCONNACTION=TERMINATE is assumed; the system will not initiate a duplexing rebuild if the new structure has poorer connectivity than the old structure, as determined by the SFM weights of the systems connected to the structure in the coupling facility.
  3. XES ignores the LESSCONNACTION keyword when a rebuild start request results in system-managed processing. If any active connector loses connectivity to the structure being rebuilt, the system-managed process always stops.
LESSCONNACTION=TERMINATE
The system is to stop the rebuild if the new structure has poorer connectivity than the old structure, as determined by the SFM weights of the systems connected to the structure in the coupling facility.
LESSCONNACTION=CONTINUE
The system is not to stop the structure rebuild. Users that cannot connect to the new structure must disconnect from the structure to allow the rebuild to continue, or must stop the rebuild.
Note:
  1. If LESSCONNACTION is not specified when the rebuild is started, the default action is to not to continue any rebuild, despite its effect on the connectors to the structure.
  2. If LESSCONNACTION=CONTINUE is specified with the CFNAME= keyword, all structures in the specified coupling facility are rebuilt, despite any degradation in connectivity for the structures being rebuilt.
,LOCATION=NORMAL
,LOCATION=OTHER
Use this input parameter to indicate where the new structure that is allocated for rebuild can be located.
NORMAL
The new structure can be allocated in any coupling facility in the preference list using the normal allocation rules.
OTHER
The new structure cannot be allocated in the same coupling facility as the original structure. The new structure can be allocated in any coupling facility in the preference list, other than the coupling facility containing the original structure, using normal allocation rules. LOCATION=OTHER is assumed when the rebuild is a duplexing rebuild.

This option is intended for planned reconfiguration cases where a system administrator has verified that the policy does contain a coupling facility where the structure can be rebuilt. If there is only one coupling facility in the preference list for the structure being rebuilt and the coupling facility is the location of the original structure, each connector will receive reason code IXLRSNCODENOFAC when the rebuild connect is attempted. In IXLYCONA, CONAFACILITYARRAY will indicate that the current coupling facility was not chosen because the LOCATION=OTHER option was specified on IXLREBLD.

Note: A structure rebuild initiated with STARTREASON=LOSSCONN will always be stopped if the connectivity will not be improved for the current set of active connectors by the rebuild process. LOCATION=OTHER is NOT implied by a LOSSCONN rebuild, as there may not be another viable coupling facility available in which to rebuild the structure.
,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.
,PLISTVER=IMPLIED_VERSION
,PLISTVER=MAX
,PLISTVER=plistver
Use this input parameter to specify the version of the macro. See Understanding IXLREBLD Version Support for a description of the options available with PLISTVER.
,POPULATECF=populatecf
Use this input parameter to specify the name of the coupling facility which is to be populated with structures selected from those currently allocated in other less preferred coupling facilities.

A structure rebuild will be attempted for each allocated structure in the policy that contains the specified coupling facility in its preference list, if the specified coupling facility is at a higher position in the preference list than the coupling facility in which the structure currently is allocated. If the structure already is allocated in a more preferable coupling facility, the rebuild is not started.

Each selected structure will be placed in a ‘pending rebuild’ state; these ‘pending rebuild’ structures are then processed serially to completion (either a stop complete event or a rebuild complete event is received) before the system selects the next structure for rebuild.

This option is intended for use by an operations product or subsystem only. It is not intended for use by an application initiating rebuilds for structures owned by other applications.

The coupling facility name must be 8 characters long, padded on the right with blanks if necessary. The name may contain numeric characters, uppercase alphabetic characters, national characters ($, @, #), or an underscore (_), and must begin with an uppercase alphabetic character.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 8-character field that contains the name of the coupling facility.

REQUEST=START
REQUEST=STOP
REQUEST=COMPLETE
REQUEST=STARTDUPLEX
REQUEST=STOPDUPLEX
REQUEST=DUPLEXCOMPLETE
Use this input parameter to specify the type of rebuild request.
  • Use REQUEST=START to request start rebuild processing for the specified structure or structures within the specified coupling facility. The request will start non-duplexing rebuild processing, which might be either user-managed or system-managed.
  • Use REQUEST=STOP to request stop rebuild processing for the specified structure or structures within the specified coupling facility. The request will stop non-duplexing rebuild processing only, either for a user-managed or system-managed rebuild.
  • Use REQUEST=COMPLETE to indicate that user-managed rebuild processing is complete for the specified connection.
  • Use REQUEST=STARTDUPLEX to request start duplexing rebuild processing for the specified structure or structures within the specified coupling facility.
  • Use REQUEST=STOPDUPLEX to request stop duplexing rebuild processing for the specified structure or structures within the specified coupling facility. The request implies that the connector is reverting to simplex mode by either switching to the new structure or falling back to the old structure.
  • Use REQUEST=DUPLEXCOMPLETE to indicate that duplexing rebuild processing is complete for the specified connection.
,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 the fullword output field 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 the fullword output field to contain the reason code.

,STARTREASON=LOSSCONN
,STARTREASON=STRFAILURE
,STARTREASON=CONNECTOR
,STARTREASON=OPERATOR
Use this input keyword to specify the reason for starting the rebuild or duplexing rebuild process for the structure.
STARTREASON=LOSSCONN
Loss of connectivity to the structure (for rebuild processing only)
STARTREASON=STRFAILURE
Structure failure (for rebuild processing only)
STARTREASON=CONNECTOR
Connected user-specified reason. The requestor can specify the USERCODE parameter to indicate the reason for initiating the rebuild.
STARTREASON=OPERATOR
Operator-initiated rebuild processing. This option requires that you also provide a command-and-response token (CART) and console ID (CONSID) associated with the console to be notified of the rebuild progress.
,STOPREASON=LOSSCONNOLD
,STOPREASON=LOSSCONNNEW
,STOPREASON=LOSSCONN
,STOPREASON=STRFAILUREOLD
,STOPREASON=STRFAILURE
,STOPREASON=CONNECTOR
,STOPREASON=OPERATOR,CART=cart,CONSID=consid
Use this input parameter to specify the reason for stopping the rebuild or the duplexing rebuild process for the structure. You can specify one of the following reasons:
STOPREASON=LOSSCONNOLD
Loss of connectivity to the original structure (for rebuild processing only)
STOPREASON=LOSSCONNNEW
Loss of connectivity to the new structure (for rebuild processing only)
STOPREASON=LOSSCONN
Loss of connectivity to the structure (for duplexing rebuild processing only)
STOPREASON=STRFAILUREOLD
Failure of the original structure (for rebuild processing only
STOPREASON=STRFAILURE
Failure of the structure (for duplexing rebuild processing only)
STOPREASON=CONNECTOR
Connected user-specified reason. The requestor can specify the USERCODE parameter to indicate the reason for stopping the rebuild.
STOPREASON=OPERATOR
Operator-initiated request to stop rebuild processing. This option requires that you also provide a command-and-response token (CART) and console ID (CONSID) associated with the console to be notified of the rebuild processing.
,STRNAME=strname
Use this input parameter to specify the name of the structure. The structure name must be 16 characters long, padded on the right with blanks if necessary. The name may contain numeric characters, uppercase alphabetic characters, national characters ($, @, #), or an underscore (_).

Users can use the IXCQUERY service macro to determine what structures have been defined in the active CFRM policy.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character input field that contains the name of the target structure.

,USERCODE=0
,USERCODE=usercode
Use this input parameter to specify the user code that represents the connector's reason for initiating rebuild processing.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the fullword input field that contains the user code representing the connector's reason for rebuilding.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014