INQUIRE VTAM
Retrieve information about the connection between CICS and the z/OS Communications Server.
Note: VTAM is now the z/OS Communications Server.
Conditions: INVREQ, NOTAUTH
For more information about the use of CVDAs, see CICS-value data areas (CVDAs).
Description
The INQUIRE VTAM command returns information about the type and state of the connection between the Communications Server and your CICS system.
Options
- GRNAME(data-area)
- Returns the 8-character generic resource group name under which this CICS region requests registration to the Communications Server, if it is using the generic resources facility of the Communications Server. Blanks are returned if the system was initialized without a request for registration.
- GRSTATUS(cvda)
- Returns
a CVDA value indicating the status of generic resource registration.
All of the values except NOTAPPLIC indicate that CICS has been initialized
to use the generic resource function; that is, a nonblank GRNAME value
was specified. CVDA values are:
- DEREGERROR
- Deregistration was attempted but was unsuccessful, and no attempt to reregister has been made.
- DEREGISTERED
- Deregistration was successfully accomplished.
- NOTAPPLIC
- CICS is not using the generic resource feature; GRNAME is not set or is set to blanks.
- REGERROR
- Registration was attempted but was unsuccessful, and no attempt to unregister has been made.
- REGISTERED
- Registration was successful and no attempt to unregister has been made.
- UNAVAILABLE
- The Communications Server does not support the generic resource function.
- UNREGISTERED
- CICS is using the generic resource function but no attempt, as yet, has been made to register.
- OPENSTATUS(cvda)
- Returns
a CVDA value indicating the status of the connection between CICS
and the Communications Server. CVDA values are:
- CLOSED
- The connection between CICS and the Communications Server has not yet been established or has been stopped.
- CLOSEFAILED
- The connection is open but is not usable because a previous request to close the connection failed. Retry the close request.
- CLOSING
- The connection between CICS and the Communications Server is in the process of closing.
- FORCECLOSING
- The connection between CICS and the Communications Server is in the process of closing following a SET VTAM FORCECLOSE command.
- IMMCLOSING
- The connection between CICS and the Communications Server is in the process of closing following a SET VTAM IMMCLOSE command.
- OPEN
- A connection exists between CICS and the Communications Server.
- PSDINTERVAL(data-area)
- Returns
the persistent session delay interval, which is the length of time
that Communications Server sessions are held in recovery-pending state
after a failure. The PSDINT system initialization
parameter specifies this value for the CICS region at startup. The
persistent session delay interval has two formats:
- A composite (packed decimal format 0hhmmss+, 4 bytes long), which you obtain by using the PSDINTERVAL option.
- Separate hours, minutes, and seconds, which you obtain by specifying the PSDINTHRS, PSDINTMINS, and PSDINTSECS options.
- PSDINTHRS(data-area)
- Returns the hours component of the persistent session delay interval, in fullword binary form. See the PSDINTERVAL option.
- PSDINTMINS(data-area)
- Returns the minutes component of the persistent session delay interval, in fullword binary form. See the PSDINTERVAL option.
- PSDINTSECS(data-area)
- Returns the seconds component of the persistent session delay interval, in fullword binary form. See the PSDINTERVAL option.
- PSTYPE(cvda)
- Returns
a CVDA value indicating the type of Communications Server persistent
sessions support for the CICS region. CVDA values are as follows:
- SNPS
- Single-node persistent sessions. Communications Server sessions can be recovered after a CICS failure and restart.
- MNPS
- Multinode persistent sessions. Communications Server sessions can also be recovered after a Communications Server or z/OS® failure in a sysplex.
- NOPS
- Communications Server persistent sessions support is not used for this CICS region.
Conditions
- INVREQ
- RESP2 values:
- 1
- The Communications Server is not present in the system.
- NOTAUTH
- RESP2 values:
- 100
- The user associated with the issuing task is not authorized to use this command.