MODIFY CSDUMP command


Set the CSDUMP trigger:

>>-MODIFY-- --procname--,--CSDUMP------------------------------->

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

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

>--+------------------------------+----------------------------->
   '-,--TCPNAME--=--TCPIP_Jobname-'   

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

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

Notes:

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


Remove the CSDUMP trigger:

>>-MODIFY-- --procname--,--CSDUMP--,--DELETE--=--+-ALL-----+---><
                                                 +-MESSAGE-+   
                                                 '-SENSE---'

Abbreviations

Operand	Abbreviation
MODIFY	F

Purpose

Set the CSDUMP trigger:

Use the MODIFY CSDUMP command to perform the following actions:

Take an immediate dump of the current address space. This is the default action that is performed when the MODIFY CSDUMP command is issued with no other operands. Any existing message or sense code trigger set by the MODIFY CSDUMP command or the CSDUMP start option are not affected by issuing this form of the MODIFY CSDUMP command.
Set a trigger that invokes a dump of the current address space when a particular sense code is issued. The trigger invokes a dump of the VTAM® address space if the current address space is not the VTAM address space.
Set a trigger that invokes a dump of the current address space and possibly a dump of a remote VTAM address space, when a particular message is issued. The trigger invokes a dump of the VTAM address space if the current address space is not the VTAM address space.

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. If you have previously set a message trigger using the MODIFY CSDUMP or the CSDUMP start option, and then you enter a different message trigger, the previous message trigger is overwritten.

Tip: You can use the CSDUMP start option to set either a CSDUMP message trigger or a sense code trigger or both. See z/OS Communications Server: SNA Resource Definition Reference for information about the CSDUMP start option.

Remove the CSDUMP trigger:

Using the MODIFY CSDUMP,DELETE command, the user can delete the triggers set previously.

Operands

procname

The procedure name for the command. If procname in the START command was specified as startname.ident, where startname is the VTAM start procedure and ident is the optional identifier, either startname.ident or ident can be specified for procname.

If procname in the START command was startname, startname must be specified for procname.

Set the CSDUMP trigger:

MATCHLIM=matchlim_value

Specifies that the CSDUMP trigger is to be disabled after matchlim_value matches. The matchlim_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 will trigger a dump. Message numbers must be of the format ISTxxxI, ISTxxxxI, or IVTxxxxI.

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

MESSAGE=(message_id_number,message_value_field,...)

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

Note: Use an underscore as a substitute for a space in the variable text value of the message operand.

Rules:

Each message has the fixed number of message_value_fields. Each message_value_field has the maximum length.
The specified number of message_value_fields must be less than or equal to the number of message_value_fields in the specified message.
The specified length of the message_value_field must be less than or equal to the maximum length of the specified message_value_field.
The leading message_value_field can be skipped using a comma ( , ) for each message_value_field. The trailing message_value_field is 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 that connects the two VTAMs becomes inoperative. This operand can be specified only when MESSAGE=IST1504I is also specified.

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 or as part of an immediate dump.

RNICTRLE=MSGVALUE: MSGVALUE is valid only when the MESSAGE operand is used and specifies either message IST2391I or IST2406I. Specifying the MSGVALUE keyword allows VTAM to collect diagnostic dump information for the 10GbE RoCE Express feature that is 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 IBM 10GbE RoCE Express feature, and y is the port number that is 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 10GbE RoCE Express TRLE is not active when CSDUMP produces the dump.
A specific RNIC_TRLEName is specified 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 same 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 will carry the sense code specified. The RU operand can be used only in combination with the SENSE operand. If the RU operand is used, then the dump will be 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 SNA Formats.

SENSE=sense_code

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

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

TCPNAME=TCPIP_Jobname

Specifies to take a dump of the TCPIP job, along with the current address space. The job name must be 1 - 8 characters in length.

Remove the CSDUMP trigger:

DELETE=ALL

Specifies to delete both the message and the sense triggers.

DELETE=MESSAGE

Specifies to delete the message trigger.

DELETE=SENSE

Specifies to delete the sense trigger.

Examples

Using the default option to take the dump now:

f vtam,csdump
 IST097I MODIFY ACCEPTED
 IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the default option and tcpname to take the dump of the current address space and the dump of the TCPIP Job now:

f vtam,csdump,tcpname=tcpcs
 IST097I MODIFY ACCEPTED
 IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the default option, TCPNAME parameter, and RNICTRLE parameter to take an immediate dump of the current address space, the specified TCP/IP address space, and a 10GbE RoCE Express diagnostic dump of the specified 10GbE RoCE Express feature:

f vtam,csdump,tcpname=tcpcs,rnictrle=iut10001
  IST097I MODIFY ACCEPTED
  IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message option and RNICTRLE parameter to automatically trigger a dump of the current address space and a 10GbE RoCE Express diagnostic dump the next time when message IST2406I is issued. The diagnostic dump of the 10GbE RoCE Express feature associated with the TRLE name in message IST2406I will be taken.

f vtam,csdump,message=ist2406i,rnictrle=msgvalue
  IST097I MODIFY ACCEPTED
  IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message to take the dump:

f vtam,csdump,message=ist1386i
 IST097I MODIFY ACCEPTED                     
 IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message and tcpname to take the dump of the current address space and the dump of the TCPIP Job:

f vtam,csdump,message=ist1386i,tcpname=tcpcs
 IST097I MODIFY ACCEPTED
 IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message and the first message_value_field to take the dump:

f vtam,csdump,message=(ist169i,react)
IST097I MODIFY ACCEPTED                   
IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message and the first two message_value_fields:

f vtam,csdump,message=(ist169i,react,pua)
 IST097I MODIFY ACCEPTED                   
 IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message and the second message_value_field to take the dump:

f vtam,csdump,message=(ist169i,,pua)
IST097I MODIFY ACCEPTED                
IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the message and the REMOTE operand to take a dump of this VTAM and of the remote VTAM when an XCF link becomes inoperative:

f vtam,csdump,message=ist1504i,remote=yes
IST097I MODIFY ACCEPTED                
IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the sense code to take the dump:

f vtam,csdump,sense=08090000
IST097I MODIFY ACCEPTED   
IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the sense code and RU code to take the dump:

f vtam,csdump,sense=08090000,ru=818641
IST097I MODIFY ACCEPTED                  
IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the sense code, RU code, and matchlim to take the dump 12 times:

f vtam,csdump,sense=08090000,ru=818641,matchlim=12
IST097I MODIFY ACCEPTED                  
IST223I MODIFY CSDUMP COMMAND COMPLETED

Using the sense code, RU code, and tcpname to take the dump of the current address space and the dump of the TCPIP Job:

f vtam,csdump,sense=08090000,ru=818641,tcpname=tcpcs
IST097I MODIFY ACCEPTED
IST223I MODIFY CSDUMP COMMAND COMPLETED