SETXCF STOP command

Use the SETXCF STOP command to:

Stop one or more inbound signalling paths.
Stop one or more outbound signalling paths.
Delete the definition of a transport class.
Stop using an administrative policy.
Stop rebuilding one or more coupling facility structures.
Stop populating a coupling facility that had been newly brought into service in a sysplex with structures selected from the set of those defined in the active CFRM policy.
Stop duplexing of one or more structures in a coupling facility and specify the structure that is to remain in use.
Stop altering a coupling facility structure.
Stop an in-progress REALLOCATE process.
Transition from a message-based event and confirmation management protocol to a policy-based event and confirmation management protocol.
Remove a specific coupling facility or a list of coupling facilities from maintenance mode. When the coupling facility is out of maintenance mode, the XCF allocation algorithm can select the CF for allocating a coupling facility structure.

The complete syntax for the SETXCF STOP command is:

 
SETXCF STOP,{PATHIN,{DEVICE=([/]indevnum[,[/]indevnum]...)}    }
                    {STRNAME=(strname[,strname]...)       }    
                       [,UNCOND=NO|YES]                        
                                                              
            {PATHOUT,{DEVICE=([/]outdevnum[,[/]outdevnum]...)} }
                     {STRNAME=(strname[,strname]...)         }   
                        [,UNCOND=NO|YES]                       
                                                              
            {CLASSDEF,CLASS=classname                          }
            {MSGBASED}
            {POLICY,TYPE=name  }
                                                               
            {REBUILD,{POPULATECF=cfname}                       }
                     {DUPLEX,}                                 
                     {STRNAME=(strname[,strname]...)}          
                         {,KEEP=NEW|OLD}                       
                     {CFNAME=(cfname[,cfname]...)   }          
                                                              
            {ALTER,STRNAME=strname                             }
            {REALLOCATE,[,FORCE]                     }
            {MAINTMODE,CFNAME=(cfname[,cfname]...)             }

ALTER,STRNAME or STRNM=strname

Specifies that structure alter processing should be stopped for the named structure. (Use the DISPLAY XCF,STRUCTURE command to determine which structures are being altered.)

The SETXCF STOP,ALTER command can be used to stop an alter in progress that was initiated either with a SETXCF START,ALTER command or with the IXLALTER programming interface.

STRNAME or STRNM=strname: Identifies the structure for which to stop structure alter processing.

CLASSDEF or CD,CLASS=classname

Deletes the definition for the specified transport class and frees the space allocated for message buffers. The transport class must be defined to XCF. You can delete a transport class only when no signalling paths are currently assigned to the class. You cannot delete the DEFAULT transport class definition.

MSGBASED

Switch to a policy-based protocol from the current message-based event and confirmation management protocol.

PATHIN or PI,DEVICE=([/]indevnum[,[/]indevnum]...)

Specifies the device number of one or more inbound signalling paths that XCF should no longer use. A device number, indevnum, is 3 or 4 hexadecimal digits, optionally preceded by a slash (/). If you specify only one device, you do not need to enter the parentheses.

A specified device must be defined to XCF as an inbound path.

Once the command completes successfully, XCF stops receiving signalling traffic along these paths and deallocates the device. The device is no longer defined to XCF as a signalling path. If a specified signalling path is the last path from another system in the sysplex, XCF rejects the command.

PATHIN or PI,STRNAME or STRNM=(strname[,strname]...)

Specifies the name of one or more coupling facility structures that XCF should no longer use. The specified structure must be defined to XCF as an inbound path.

The structure name can be up to 16 alphanumeric characters long and must begin with an uppercase alphabetic character. If you specify only one structure name, you do not need to enter the parentheses.

UNCOND=NO or YES: UNCOND=NO stops a signalling path when no other stop commands are active against that path. UNCOND=YES stops a signalling path even when another stop command is active against that path. This operand stops an outstanding stop request and initiates a new one, recovering path resources so they are not lost for the duration of the IPL. Because a STOP command with the UNCOND=YES option might cause loss of signals, the system accepts the command only when an outstanding stop is active against a path.
Note: Use UNCOND=YES only at the direction of the system programmer.

PATHOUT or PO,DEVICE=([/]outdevnum[,[/]outdevnum]...)

Specifies the device number of one or more outbound signalling paths that XCF should no longer use to send messages. A device number, outdevnum, is 3 or 4 hexadecimal digits, optionally preceded by a slash (/). If you specify only one device, you do not need to enter the parentheses.

XCF stops sending signalling traffic along these paths, leaving the devices unallocated. The device is no longer defined to XCF as a signalling path. If a specified path is the last path to another system in the sysplex, XCF rejects the command.

PATHOUT or PO,STRNAME or STRNM=(strname[,strname]...)

Identifies one or more coupling facility structures that XCF should no longer use. The specified structure must be defined to XCF as an outbound path.

UNCOND=NO or YES: UNCOND=NO stops a signalling path when no other stop commands are active against that path. UNCOND=YES stops a signalling path even when another stop command is active against that path. This operand stops an outstanding stop request and initiates a new one, recovering path resources so they are not lost for the duration of the IPL. Because a STOP command with the UNCOND=YES option could cause loss of signals, the system accepts the command only when an outstanding stop is active against a path.
Note: Use UNCOND=YES only at the direction of the system programmer.

POLICY or POL,TYPE=name

Directs the system to deactivate the active policy for the type of service named.

TYPE=name

Specifies the name of the service that is using the couple data set for policy data. The supported service names are:

ARM for automatic restart management
CFRM for coupling facility resource management
SFM for sysplex failure management

REBUILD or RB,POPULATECF or POPCF=cfname

Specifies the name of the coupling facility in which structure population is to stop. All structure rebuilds that were initiated by a SETXCF START,REBUILD,POPULATECF command will be stopped.

Note that you also can use the SETXCF STOP,REBUILD,CFNAME or SETXCF STOP,REBUILD,STRNAME to stop structure rebuilds that were initiated by a SETXCF START,REBUILD,POPULATECF command.

REBUILD or RB,DUPLEX,STRNAME or STRNM=(strname[,strname]…)

Specifies the name of one or more coupling facility structures for which duplexing is to be stopped. You must also specify with the KEEP keyword which of the duplexed structures should remain after the duplexing operation has stopped.

The structure name can be up to 16 alphanumeric characters long and must begin with an uppercase alphabetic character. IBM® names begin with SYS, or letters A-I. If you specify only one structure name, you do not need to enter the parentheses.

KEEP=NEW|OLD

Specifies which of the duplexed structures should remain after duplexing has stopped.

KEEP=NEW specifies that processing should switch to the new structure.

KEEP=OLD specifies that processing should fall back to the old structure.

Note:

If the CFRM active policy specifies DUPLEX(ENABLED) for the structure and IXLREBLD IGNOREDUPLEX=YES is not used, the system might immediately reduplex the structure after the completion of the stop processing. There might be a delay before reduplexing when only two coupling facilities are available for duplexing the structure. Reduplexing will occur immediately in configurations with three or more coupling facilities available for duplexing the structure.
To prevent the system from immediately reduplexing the structure or reduplexing the structure at a later time, change the DUPLEX specification for the structure to DUPLEX(ALLOWED) or DUPLEX(DISABLED). Change the DUPLEX setting for the structure in the CFRM policy 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.

REBUILD or RB,DUPLEX,CFNAME=(cfname[,cfname]…)

Specifies the name of one or more coupling facilities in which structure duplexing is to stop.

Duplexing will be stopped for each structure in each specified coupling facility so that no structures involved in structure duplexing processing remain in the coupling facility. When more than one coupling facility is specified, a separate request is made to stop duplexing for each coupling facility specified. The order of making the requests is the same order as the coupling facilities are listed in the command.

If the specified coupling facility contains the new structure in the duplexed pair of structures, the system will fall back to the old structure.
If the specified coupling facility contains the old structure in the duplexed pair of structures, the system will switch to the new structure.

The coupling facility name can be up to 8 alphanumeric characters long and must begin with an uppercase alphabetic character. If you specify only one coupling facility name, you do not need to enter the parentheses.

See the same notes in the REBUILD or RB,DUPLEX,STRNAME or STRNM=(strname[,strname]…) parameter.

REBUILD or RB,STRNAME or STRNM=(strname[,strname]...)

Specifies the name of one or more coupling facility structures for which rebuild processing is to stop. The structure name can be up to 16 alphanumeric characters long and must begin with an uppercase alphabetic character. IBM names begin with SYS, or letters A-I. If you specify only one structure name, you do not need to enter the parentheses.

REBUILD or RB,CFNAME or CFNM=(cfname[,cfname]...)

Specifies the name of one or more coupling facilities for which rebuild processing is to stop for all structures. The coupling facility name can be up to 8 alphanumeric characters long and must begin with an uppercase alphabetic character. If you specify only one coupling facility name, you do not need to enter the parentheses.

ALTER,STRNAME or STRNM=strname

Specifies that structure alter processing should be stopped for the named structure. (Use the DISPLAY XCF,STRUCTURE command to determine which structures are being altered.)

The SETXCF STOP,ALTER command can be used to stop an alter in progress that was initiated either with a SETXCF START,ALTER command or with the IXLALTER programming interface.

STRNAME or STRNM=strname: Identifies the structure for which to stop structure alter processing.

REALLOCATE[,FORCE] or REALLOC[,FORCE]

Specifies that an in-progress REALLOCATE process is to be stopped.

When stopping without specifying FORCE, REALLOCATE processing completes the steps for the current target structure then finishes. The status of the REALLOCATE processing will be "STOPPING" as shown by either the DISPLAY XCF,STR or the DISPLAY XCF,CF operator command.

When stopping with FORCE specified, REALLOCATE processing finishes immediately AND the step(s) for the current target structure might NOT be completed. Use the FORCE option when structure rebuild processing for the structure which is the target of the REALLOCATE process is not making progress.

When the process finishes, for the structures selected prior to the operator stopping the process, the processing provides a report (message IXC545I) summarizing the actions that were taken up to the time that processing was stopped.

To stop the REALLOCATE process does NOT require issuing the command without FORCE specified before issuing with FORCE specified.

MAINTMODE,CFNAME=(cfname,[cfname...])

Removes the maintenance mode indication from the specified coupling facility or facilities. When in maintenance mode, a CF is not eligible for CF structure allocation purposes. When the coupling facility is out of maintenance mode, the XCF allocation algorithm can select the CF for allocating a coupling facility structure.