MODIFY DUMP command


Static dump of remote NCP (via link station) to host:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--link_station_name---->

                       .-,--ACTION--=--COMP-.   
>--,--DUMPDS--=--name--+--------------------+------------------->

   .-,--OPTION--=--STATIC-.  .-,--RMPO--=--NO------.   
>--+----------------------+--+---------------------+------------>
                             '-,--RMPO--=--+-NO--+-'   
                                           '-YES-'     

   .-,--TYPE--=--NCP-.   
>--+-----------------+-----------------------------------------><


Static dump of NCP to host:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--ncp_name------------->

   .-,--ACTION--=--COMP-.                           
>--+--------------------+--+--------------------+--------------->
                           '-,--DUMPDS--=--name-'   

>--+--------------------------------------+--------------------->
   '-,--DUMPSTA--=--+-------------------+-'   
                    '-link_station_name-'     

   .-,--OPTION--=--STATIC-.  .-,--RMPO--=--NO------.   
>--+----------------------+--+---------------------+------------>
                             '-,--RMPO--=--+-NO--+-'   
                                           '-YES-'     

   .-,--TYPE--=--NCP-.   
>--+-----------------+-----------------------------------------><


Static dump of NCP to hard disk:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--ncp_name------------->

                        .-,--OPTION--=--STATIC-.   
>--,--ACTION--=--STORE--+----------------------+---------------><


Dynamic dump of NCP to host:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--ncp_name------------->

                       .-,--ACTION--=--COMP-.   
>--,--OPTION--=--DYNA--+--------------------+------------------->

                               .-,--TYPE--=--NCP-.   
>--+------------------------+--+-----------------+-------------><
   |                    (1) |                        
   '-,--DUMPDS--=--name-----'

Notes:

If the NCP has been acquired before activation, DUMPDS is required.


Transfer CSP or MOSS dump from hard disk to host:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--ncp_name------------->

                         .-,--ACTION--=--COMP-.   
>--,--TYPE--=--+-CSP--+--+--------------------+----------------->
               '-MOSS-'                           

>--+------------------------+----------------------------------><
   |                    (1) |   
   '-,--DUMPDS--=--name-----'

Notes:

If the NCP has been acquired before activation, DUMPDS is required.


Transfer NCP, CSP, or MOSS dump from hard disk to host:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--ncp_name------------->

                           .-,--TYPE--=--NCP------.   
>--,--ACTION--=--TRANSFER--+----------------------+------------->
                           '-,--TYPE--=--+-CSP--+-'   
                                         +-MOSS-+     
                                         '-NCP--'     

>--+------------------------+----------------------------------><
   |                    (1) |   
   '-,--DUMPDS--=--name-----'

Notes:

If the NCP has been acquired before activation, DUMPDS is required.


Purge dump from hard disk:

>>-MODIFY-- --procname--,--DUMP--,--ID--=--ncp_name------------->

                        .-,--TYPE--=--NCP------.   
>--,--ACTION--=--PURGE--+----------------------+---------------><
                        '-,--TYPE--=--+-CSP--+-'   
                                      +-MOSS-+     
                                      '-NCP--'

Abbreviations

Operand	Abbreviation
MODIFY	F
ACTION=TRANSFER	ACTION=TRANS
DUMPDS	DS
DUMPSTA	DST
OPTION=DYNA	OPT=DYNA or DYNA
OPTION=STATIC	OPT=STATIC
RMPO=YES	RMPO or RMPO=Y
RMPO=NO	RMPO=N

Purpose

The MODIFY DUMP (dump of an NCP) command is used to control NCP, communication scanner processor (CSP), and maintenance and operator subsystem (MOSS) dumps. Some functions use the IBM® 3720 or 3745 Communication Controller's hard disk. The functions that can be performed are:

Dump the NCP from the communications control unit (CCU) to the host
Dump the NCP from the CCU and store the dump on the hard disk
Transfer an NCP, CSP, or MOSS dump from the hard disk to the host
Purge an NCP, CSP, or MOSS dump from the hard disk

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.

ACTION

Specifies what is to be done to the dump. ACTION=STORE requires NCP Version 5 Release 3 or later.

ACTION=TRANSFER

VTAM stores the dump in a host data set, using SSP as the interface to the dump data set.

If TYPE=CSP or TYPE=MOSS, VTAM transfers the CSP or MOSS dump (taken automatically when the CSP or MOSS fails) from the controller's hard disk or diskette to the host. When the transfer is complete, MOSS purges the dump from the controller's hard disk.

If TYPE=NCP, VTAM transfers the dump from the IBM 3720 or the 3745 Communication Controller hard disk to the host. The dump is not purged.

ACTION=TRANSFER and TYPE=NCP are valid only if an NCP dump is on the controller's hard disk from a previous VARY ACT DUMPLOAD=YES command or because DUMPLD=YES is coded on the PCCU definition statement.

ACTION=PURGE

VTAM purges the dump from the disk.

If TYPE=CSP or TYPE=MOSS, VTAM purges the CSP or MOSS dump (taken automatically when the CSP or MOSS fails) from the controller's hard disk.

If TYPE=NCP, VTAM purges an NCP dump previously stored on the IBM 3720 or 3745 Communication Controller hard disk. VTAM does not transfer the dump to the host.

ACTION=PURGE and TYPE=NCP are valid only if an NCP dump is on the controller's hard disk from a previous VARY ACT DUMPLOAD=YES command or because DUMPLD=YES is coded on the PCCU definition statement.

ACTION=COMP

Specifies the compatibility mode of operations for this command with previous releases of VTAM.

If TYPE=CSP or TYPE=MOSS, VTAM transfers the CSP or MOSS dump (taken automatically when the CSP or MOSS fails) from the controller's hard disk to the host.

If TYPE=NCP, VTAM dumps the NCP and stores the results at the host. The type of NCP dump (static or dynamic) to be taken is specified on the OPTION operand.

ACTION=STORE

VTAM causes the NCP to be dumped to the controller's hard disk only if DUMPLOAD=YES is specified on the VARY ACT command or DUMPLD=YES is specified on the PCCU definition statement and the dump slot for this CCU on the controller's hard disk is empty. Use the DISPLAY DISK command to see that these conditions are met. If either one of these conditions is not met, a dump to disk will not take place and the NCP will be deactivated.

Only OPTION=STATIC and ID=ncp_name are allowed if ACTION=STORE is specified. No other operands are allowed.

ACTION=STORE requires NCP Version 5 Release 3 or later.

DUMPDS=name

Identifies the file that is to contain this dump. The specified file should be large enough to contain the dump. The contents of the file are overwritten by the dump. name must be the data definition name on the DD statement that defines the file to receive the dump.

If ID=link_station_name, this operand must be specified.

If ID=ncp_name, the DUMPDS operand (if specified) overrides any file specification in the PCCU definition statement. If this operand is omitted, VTAM uses the file specified in the PCCU definition statement. If the dump file is not specified on either the MODIFY DUMP command or the PCCU definition statement, the command fails.

If the NCP has been acquired before activation, the DUMPDS operand is required for all non-static dump types including CSP, MOSS, and NCP dump transfers and an NCP dynamic dump. VTAM does not allow static dumps of NCPs that have been acquired before activation.

DUMPSTA=link_station_name

Specifies the name of a link station (channel or SDLC link station within another NCP) in a node adjacent to the NCP to be dumped, through which a static dump operation is to be performed. The link station must be active at the time of the dump. The VTAM-generated link station name (a 3-digit or 4-digit hexadecimal device number followed by -S) can be specified.

DUMPSTA applies only when all of the following conditions are met:

ID=ncp_name is specified.
OPTION=STATIC is specified (or assumed by default).
TYPE=NCP is specified (or assumed by default).

If the DUMPSTA operand is specified, any previous DUMPSTA specifications (from the VARY ACT command or from the NCP definition) are overridden for this one dump operation. If a null value is specified (that is, if DUMPSTA= is specified), VTAM selects an available link station, giving preference to a channel link station over any SDLC link stations.

If the DUMPSTA operand is omitted, the current dump station name from the VARY ACT command or from the NCP definition (in that order) is used. If the current dump station name is null, VTAM selects an available link station as described above.

ID

Specifies the NCP to be dumped or the link station through which a remote NCP is to be dumped.

ID=ncp_name: Specifies an active NCP
ID=link_station_name: Specifies an SDLC link station within an NCP that is adjacent to the communication controller containing the NCP to be dumped. The associated SDLC link must be active. If ID=link_station_name is specified, the DUMPDS operand is required, and the DUMPSTA and OPTION=DYNA operands are not allowed.
Note: CSP and MOSS dumps cannot be taken by specifying a link station name. Specify the NCP name to take CSP and MOSS dumps.

OPTION

Provides additional specifications for an NCP dump. The OPTION operand applies if TYPE=NCP is specified or assumed by default, and if ACTION=COMP or ACTION=STORE.

OPTION=DYNA

Applies only when the ID operand specifies the name of an active NCP. OPTION=DYNA specifies that the NCP is to be dumped dynamically. That is, NCP processing continues while the NCP's contents are dumped. The NCP is not deactivated. VTAM requests multiple storage images from the NCP, and the resulting output reflects the storage contents of the communication controller over the period required to complete the dump.

The following two commands produce identical results:

F NET,DUMP,ID=ncp_name,DYNA
 
F NET,DUMP,ID=ncp_name,OPTION=DYNA

OPTION=STATIC

Specifies that the NCP is to be dumped statically. That is, NCP processing stops and the NCP is deactivated. The resulting output reflects the storage contents of the communication controller at the time the dump was started.

When TYPE=NCP and OPTION=STATIC, VTAM checks for the availability of the NCP dump data set. If this data set is not available, the command fails and the NCP remains active.

When ACTION=STORE, issue the DISPLAY DISK command to determine that the automatic dump switch in the controller is set on (DUMPLOAD=YES on VARY ACT command or DUMPLD=YES on the PCCU definition) and that the dump slot for this CCU on the controller's hard disk is empty. If either one of these conditions is not met, no dump to disk will take place, and the NCP will be deactivated.

RMPO

Specifies whether the communication controller containing the NCP is to be powered off after a static dump and deactivation of the NCP.

RMPO=YES: Specifies that the communication controller is to be powered off. RMPO=YES is valid only for a static NCP dump (OPTION=STATIC is specified or assumed by default). Also, RMPO=YES should be entered only for an NCP that is in a communication controller with the remote power-off facility.
Note that RMPO can be entered instead of RMPO=YES.
RMPO=NO: Specifies that the communication controller is not to be powered off.

TYPE

Specifies the type of dump.

If ACTION=TRANSFER and either TYPE=CSP or TYPE=MOSS, the box event record (BER) log, configuration data file (CDF), token-ring interface coupler (TIC) dump, and channel adapter (CA) dump are transferred automatically from the hard disk with the CSP or MOSS dump. If the CSP or MOSS dump is not present, the BER log, CDF, TIC dump, and CA dump are transferred; however, after they are transferred, the MODIFY DUMP command will fail because the specified dump is not present.

TYPE=CSP

If ACTION=TRANSFER or COMP, transfers a dump of the NCP's communication scanner processor (taken automatically when the CSP fails) from the controller's hard disk to the host data set using SSP as the interface to the dump data set. From the host data set, it can be formatted and printed.

The file to contain this dump can be specified by the operator with the DUMPDS operand of the MODIFY DUMP command, or it can be specified by the system programmer on the CDUMPDS operand of the PCCU definition statement. If neither the DUMPDS operand nor the CDUMPDS operand are specified, VTAM uses the dump file specified by the DUMPDS operand of the PCCU definition statement.

If ACTION=PURGE, purges the CSP dump from the hard disk or diskette in the controller.

TYPE=MOSS

If ACTION=TRANSFER or COMP, transfers a dump of the maintenance operator subsystem (taken automatically when the MOSS fails) from hard disk or diskette in the controller to the host data set using SSP as the interface to the dump data set.

The file to contain this dump can be specified by the operator with the DUMPDS operand of the MODIFY DUMP command, or it can be specified by the system programmer on the MDUMPDS operand of the PCCU definition statement. If neither the DUMPDS operand nor the MDUMPDS operand are specified, VTAM uses the dump file specified by the DUMPDS operand of the PCCU definition statement.

If ACTION=PURGE, purges the MOSS dump from the hard disk or diskette in the controller.

TYPE=NCP

If ACTION=COMP, TYPE=NCP specifies a normal dump of the NCP. If ACTION=TRANSFER, the resulting dump is sent to the host from the IBM 3720 or 3745 Communication Controller hard disk. If ACTION=PURGE, the dump is purged from the IBM 3720 or 3745 Communication Controller hard disk.

If ACTION=TRANSFER or PURGE, the OPTION operand does not apply. If ACTION=TRANSFER, the host file to contain the transferred dump can be specified by the operator with the DUMPDS operand of the MODIFY DUMP command, or it can be specified by the system programmer on the DUMPDS operand of the PCCU definition statement.

If TYPE=NCP and ACTION=COMP, the OPTION operand can be used to specify whether this is to be a dynamic or static dump.