CSDUMP start option


>>-+-----------------------------------------------+-----------><
   |                                           (1) |   
   '-CSDUMP--+-| CSDUMP Message Trigger |----+-----'   
             '-| CSDUMP Sense Code Trigger |-'

Notes:

Specify the CSDUMP start option twice to set both message and sense code triggers.


CSDUMP sense code trigger

|--,--SENSE--=--sense_code--+-------------+--------------------->
                            '-,RU=ru_code-'   

>--+----------------------------+------------------------------->
   '-,--TCPNM--=--TCPIP_Jobname-'   

   .-,--MATCHLIM--=--1--------------.   
>--+--------------------------------+---------------------------|
   '-,--MATCHLIM--=--matchlim_value-'

Rules:

When an error message is received on any parameter of the CSDUMP start option, the remaining parameters for this CSDUMP start option are ignored. You are required to re-enter the complete CSDUMP start option.
When the same parameter is entered multiple times on a CSDUMP sense code trigger, only the last occurrence is accepted.


CSDUMP message trigger

|--+-------------------------------------------------------------------------------+-->
   '-,--MESSAGE--=--+-message_id_number------------------------------------------+-'   
                    |          .-,--REMOTE--=--NO------.                         |     
                    +-IST1504I-+-----------------------+-------------------------+     
                    |          '-,--REMOTE--=--+-NO--+-'                         |     
                    |                          '-YES-'                           |     
                    |                                  .-,--REMOTE--=--NO------. |     
                    +-(IST1504I,-message_value_field-)-+-----------------------+-+     
                    |                                  '-,--REMOTE--=--+-NO--+-' |     
                    |                                                  '-YES-'   |     
                    '-(--message_id_number,--message_value_field--)--------------'     

>--+----------------------------+------------------------------->
   '-,--TCPNM--=--TCPIP_Jobname-'   

>--+-----------------------------------+------------------------>
   |                            (1)    |   
   '-,--RNICTRLE--=--+-MSGVALUE------+-'   
                     '-RNIC_TRLEName-'     

   .-,--MATCHLIM--=--1--------------.   
>--+--------------------------------+---------------------------|
   '-,--MATCHLIM--=--matchlim_value-'

Notes:

MSGVALUE is valid only when the MESSAGE operand is used, and MESSAGE specifies either message IST2391I or IST2406I.

Rules:

When an error message is received on any parameter of the CSDUMP start option, the remaining parameters for this CSDUMP start option are ignored. You are required to re-enter the complete CSDUMP start option.
When the same parameter is entered multiple times on a CSDUMP message trigger, only the last occurrence is accepted.

You can use the CSDUMP start option to set up a trigger that invokes a dump of the current address space when a particular sense code or message is issued. You can set only one sense code and one message trigger simultaneously; you cannot set two different message or sense code triggers at the same time. You can change a message trigger or a sense code trigger using the MODIFY CSDUMP command.

Either the MESSAGE operand or the SENSE operand must be specified after the CSDUMP start option or the CSDUMP start option is invalid.

MATCHLIM=matchlim_value

Specifies that the CSDUMP trigger is to be disabled after the matchlim_value value matches the value specified on the message trigger. The matchlim_value value is an integer in the range 1-255. The default is 1.

MESSAGE=message_id_number

Specifies the ID number of the message that triggers a dump. Message numbers must be in the format ISTxxxI, ISTxxxxI, ISTxxxE, ISTxxxxE, or IVTxxxxI.

Rule: If the start option MSGLEVEL=BASE is specified, or if MSGLVL=BASE is specified in a USS operator message table, then the message displayed on the console is the pre-version 4 VTAM® message. If you specify CSDUMP with a message trigger, the message ID number is checked before it is swapped to the base message_id_number value. Therefore, the message_id_number value used with the CSDUMP command must be the version 4 VTAM message number for CSDUMP to match the message_id_number value and take the dump. See z/OS Communications Server: SNA Messages for a list of the base messages and their corresponding version 4 VTAM numbers.

MESSAGE=(message_id_number,message_value_field,...)

Specifies the message variable text that can be used to trigger a dump. Instead of just matching a message number, this field causes the trigger to be more specific. If variable text is specified, then a dump is taken only when the message and variable text match. If a variable text field is blank, then it is considered to be a wildcard. See z/OS Communications Server: SNA Messages for more information about message text for VTAM operator messages.

Rules:

Use an underscore as a substitute for a space in the message text fields that contain variable values. You do not need to pad the end of the variable to fill out the text field; however, in a few rare cases messages can contain text fields (mostly numbers) in which the variable is right justified and does not completely fill the variable length. In these cases, when you are specifying the CSDUMP operand, the message_value_field value must be padded to the left with underscores. For example, the first variable in the IST1461I message is a 3-byte field which is right justified. If a 2-byte number is displayed, an underscore must precede the number in the command in order for the dump command to function correctly. See the following example:
```
CSDUMP,MESSAGE=(IST1461I,_21)
```
Each message has a fixed number of message_value_field values. Each message_value_field value has a maximum length.
The specified number of message_value_field values must be less than or equal to the number of mesage_value_field values in the specified message.
The specified length of the message_value_field value must be less than or equal to the maximum length of the specified message_value_field value.

Leading message_value_field values can be skipped using a comma (,) for each message_value_field value. The trailing message_value_field values are not required.

See z/OS Communications Server: SNA Messages to determine the number of message value fields and their maximum lengths.

REMOTE

Specifies whether to request a dump of the remote VTAM when an XCF link connecting the two VTAMs becomes inoperative. You can specify this operand only when you specify MESSAGE=IST1504I.

REMOTE=NO: A dump of the remote VTAM is not requested when an XCF link becomes inoperative. This is the default behavior.
REMOTE=YES: A dump of the remote VTAM is requested when an XCF link becomes inoperative. The remote VTAM must be z/OS® V1R9 or later for the dump to be taken.

RNICTRLE

Specifies that a diagnostic dump of an IBM® 10GbE RoCE Express® feature needs to be taken under certain conditions. The RNICTRLE operand can be used only with the MESSAGE trigger.

RNICTRLE=MSGVALUE: MSGVALUE is valid only when the MESSAGE operand is used, and MESSAGE specifies either message IST2391I or IST2406I. Specifying the MSGVALUE keyword allows VTAM to collect diagnostic dump information for the 10GbE RoCE Express feature identified in these messages.

RNICTRLE=RNIC_TRLEName: The format of RNIC_TRLEName must be IUTyxxxx, where xxxx is the Peripheral Component Interconnect Express (PCIe) function ID (PFID) that identifies the 10GbE RoCE Express feature, and y is the port number used on the 10GbE RoCE Express interface. The value of y can be 1 or 2.

Usage: The 10GbE RoCE Express diagnostic dump is taken in addition to any other dumps that CSDUMP produces. After the 10GbE RoCE Express diagnostic dump is produced, recovery of the 10GbE RoCE Express feature is attempted.

Notes: No 10GbE RoCE Express diagnostic dump is taken in either of the following cases:

The TRLE is not active when CSDUMP produces the dump.
A specific TRLE value is coded for RNICTRLE but the TRLE is not an RDMA over Converged Ethernet (RoCE) TRLE.

Rules:

When the 10GbE RoCE Express feature operates in a dedicated RoCE environment, the diagnostic dump deactivates the 10GbE RoCE Express feature, and causes an inoperative condition for all users.
When the 10GbE RoCE Express feature operates in a shared RoCE environment, the diagnostic dump only affects the TCP/IP stack that configured the PFID value included in the value of RNIC_TRLEName. Other TCP/IP stacks that use the RoCE Express feature are not affected.

Guideline: Ensure that multiple 10GbE RoCE Express interfaces are active with the same physical network ID to avoid loss of connections during a CSDUMP operation. For more information, see High availability considerations in z/OS Communications Server: IP Configuration Guide.

RU=ru_code

Specifies the response unit code that contains the sense code specified. The RU operand can be used only with the SENSE operand. If the RU operand is specified, then the dump is triggered only if the RU and SENSE codes occur together. The RU code must be 2, 4, or 6 characters in length.

See z/OS Communications Server: SNA Data Areas Volume 1 for valid RU codes or see SNA Formats.

SENSE=sense_code

Specifies the sense code that will trigger a dump. This value must be 8 characters in length.

See z/OS Communications Server: IP and SNA Codes for valid sense codes.

TCPNM=TCPIP_Jobname

Specifies that a dump of the TCPIP job should be taken when the corresponding sense or message trigger occurs. The current address space is also specified. The TCPIP_Jobname value must be 1-8 characters in length

Examples:

Set the message trigger to take the dump:
```
CSDUMP,MESSAGE=IST1386I
```
Set the message trigger to take the dump of the current address space and the dump of the TCPIP job:
```
CSDUMP,MESSAGE=IST1386I,TCPNM=TCPCS
```
Set the message trigger with the message and first message_value_field value to take the dump:
```
CSDUMP,MESSAGE=(IST169I,react)
```
Set the message trigger with the message and first two message_value_field values to take the dump:
```
CSDUMP,MESSAGE=(IST169I,react,pua)
```
Set the message trigger with the message and first and fifth message_value_field values to take the dump:
```
CSDUMP,MESSAGE=(IST252I,rct,,,,pua)
```
Set the sense code trigger to take a dump of the current address space:
```
CSDUMP,SENSE=08090000
```
Set the message trigger and the sense trigger to take a dump:
```
CSDUMP,MESSAGE=(IST169I,react,pua),
CSDUMP,SENSE=08090000
```
Set the sense code to take a dump of the current address space and a dump of the TCPIP job:
```
CSDUMP,SENSE=08090000,RU=818641,TCPNM=TCPCS
```
Set the message trigger with the message and remote option to take a dump of the current address space and the remote VTAM connected through an XCF link to another VTAM:
```
CSDUMP,MESSAGE=IST1504I,REMOTE=YES
```