Vary Configuration exit programs


  Required Parameter Group:

1 Vary information Input Char(*)
2 Return code Input BIN(4)
 Exit Point Name:  QIBM_QDC_VRYEXIT

 Exit Point Format Name:  PRON0100
 Exit Point Format Name:  PROF0100

 QSYSINC Member Name: EDCVARY

  Required Parameter Group:

1 Vary information Input Char(*)
 Exit Point Name:  QIBM_QDC_VRYEXIT

 Exit Point Format Name:  PSON0200
 Exit Point Format Name:  PSOF0200

 QSYSINC Member Name: EDCVARY

The QIBM_QDC_VRYEXIT exit point is defined to run all exit programs for which the program data indicates the object type and configuration type match the object being varied on. This exit point supports an unlimited number of exit programs.

Notes:

  1. The vary configuration exit points ignore any error messages that are sent from the user exit program.
  2. It is strongly recommended that the exit program reside within the system base or a user ASP.
  3. When a forced vary off has been issued the exit program's ability to reject the vary off processing is revoked and all user exit programs will be executed.
  4. When a vary request is made for a NWSD server connection type of *WINDOWSNT, *IXSVR, or *ISCSI the ability to reject the vary request is revoked and all user exit programs will be executed.
  5. When an Auxiliary Storage Pool (ASP) device that is part of a group is passed to the vary configuration (VRYCFG) command all ASP devices that are part of the group are varied, but the exit programs registered for an ASP device will be called only once for all ASPs in the group. The name of the object passed to the exit program in the object name field of the format will be the name of the object passed to the vary configuration command.
  6. If a preprocesing exit program rejects a vary on/off process any subsequent preprocessing programs will not be invoked, unless the forced vary off option is selected.
  7. If a preprocessing exit program rejects a vary on/off process all post processing exit programs will be invoked.
  8. Exit program processing is not supported for IPL online processing.
  9. Exit program processing is not supported for the console controller.
  10. Exit program processing is not supported for the console device.
  11. Exit program processing is not supported for auto configuration processing.
  12. Exit program processing is not supported for Power Down System (PWRDWNSYS).
  13. Exit program processing is not supported for vary requests made under system profiles.
  14. Exit program processing is not supported for vary request made from system jobs.

Authorities and Locks

The user must have *ALLOBJ to add or remove exit programs to the registration facility.


Required Parameter Group

Vary information
Input; CHAR(*)

The vary information associated with the current vary request. The format of the vary information is defined by the format name.

Return code
Output; BINARY(4)

The return value from the user exit program. If an undefined return code is returned, then the exit point will treat the return code as if it were 0.

0 Continue vary processing.
1 Reject vary processing.

Vary Information formats

PRON0100 and PROF0100 Formats

Offset Type Field
Dec Hex
0 0 CHAR(10) Object name
10 A CHAR(10) Object type
20 14 CHAR(8) Format name
28 1C BINARY(4) Forced vary

PSON0200 and PSOF0200 Formats

Offset Type Field
Dec Hex
0 0 CHAR(10) Object name
10 A CHAR(10) Object type
20 14 CHAR(8) Format name
28 1C BINARY(4) Status


Field Descriptons

Format name. The user exit format name being used. For QIBM_QDC_VRYEXIT, the format name is one of the following:

PRON0100 The exit point programs are called prior to the object being varied on. This format can issue a return code value with the ability to reject the vary processing.
PSON0200 The exit point programs are called after the object vary on has started.
PROF0100 The exit point programs are called prior to the object being varied off. This format can issue a return code value with the ability to reject the vary processing.
PSOF0200 The exit point programs are called after the object vary off has started.

Forced vary. The field to indicate to the user exit program that a forced vary off is occurring.

0 Not forced vary off processing.
1 Forced vary off processing.

Object name. The name of the object being processed by the vary configuration command (VRYCFG).

Object type. The type of object the exit program should be executed against. The following values are supported:

*DEVD The object type is a device description
*CTLD The object type is a controller description
*LIND The object type is a line description
*NWSD The object type is a network server description

Status. The field value indicating if a preprocessing exit program rejected the vary request or the vary request was not successful.

0 Vary request was successful.
1 Vary request was not successful.
2 Vary request was rejected by a preprocessing exit program.
3 Status of vary request is unknown.

Program Data. When registering the exit program 8 characters of program data must be passed. The first 4 characters are the object type and the remaining 4 characters should be the object configuration type.

Characters Value Description
Characters 1 through 4 Object type The object type the exit program should be executed for:

Note: The object type value specified must be in all uppercase.

DEVD The object type is a device description
CTLD The object type is a controller description
LIND The object type is a line description
NWSD The object type is a network server description
Characters 5 through 8 Configuration type See tables below for valid values

Note: The configuration type value is dependent on the value specified for the object type.

Supported configuration types for object type DEVD
Configuration type Description
DSKT Diskette unit (DKT) device description
TAPE Tape (TAP) device description
DSPL Local display (DSP) description
DSPR Remote display (DSP) description
PRTL Local printer (PRT) description
PRTR Remote printer (PRT) description
FINC Finance (FNC) device description
APPC Advanced program-to-program communications (APPC) device description
ASYN Asynchronous (ASYNC) device description
BISC Binary synchronous communications (BSC) device description
HOST Systems network architecture (SNA) host device description
SNUF Systems network architecture upline facility (SNUF) device description
DSPV Virtual display (DSP) device description
PRTV Virtual printer (PRT) device description
INTR Intrasystem (INTRA) device description
RETL Retail (RTL) device description
NTWK Network (NET) device description
SNPU Upstream SNA pass-through (SNPT) device description
SNPD Downstream SNA pass-through (SNPT) device description
DSPS SNA pass-through display (DSP) device description
PRTS SNA pass-through printer (PRT) device description
FNCS SNA pass-through finance (FNC) device description
RTLS SNA pass-through retail (RTL) device description
PRTN Local area network printer (PRT) device description
OMLB Optical media libray (MLB) device description
OPTD Optical (OPT) device description
TMLB Tape media libray (MLB) device description
CRPD Crypto (CRP) device description
ASPD Auxilliary storage pool (ASP) device description
Start of changeNWSH Network server host adapter(NWSH) device descriptionEnd of change

Supported configuration types for object type CTLD
Configuration type Description
LCLW Local workstation (LWS) controller description
VRTW Virtual workstation (VWS) controller description
RMTW Remote workstation (RWS) controller description
FINC Finance (FNC) controller description
APPC Advanced program-to-program communications (APPC) controller description
HOST Systems network architecture (SNA) host controller description
BISC Binary synchronous communications (BSC) controller description
ASYN Asynchronous (ASYNC) controller description
TAPE Tape (TAP) controller description
RETL Retail (RTL) controller description
NTWK Network (NET) controller description

Supported configuration types for object type LIND
Configuration type Description
SDLC Synchronous data link control (SDLC) line description
BISC Binary synchronous communications (BSC) line description
ASYN Asynchronous (ASYNC) line description
X25L X.25 (X25) line description
TKRN Token ring network (TRN) line description
TDLC Twinaxial data link control (TDLC) line description
ETHN Ethernet (ETH) line description
WLSL Wireless local area network (WLS) line description
PPPL Point-to-Point Protocol (PPP) line description
DDIL Data-description interface (DDI) line description
FRNW Frame-relay network (FR) line description
FAXL Facsimile (FAX) line description

Supported configuration types for object type NWSD
Configuration type Description
IXSV Integrated network server description of server

Supports NWSD objects of server connection type *WINDOWSNT and *IXSVR

Start of changeGTOS Guest operating system network server description

Supports NWSD objects of server connection type *GUEST

ISCS iSCSI network server description Supports NWSD objects of server connection type *ISCS

Notes:

For compatibility purposes user exit programs registered in V5R3 with NWSD configuration type WDNT will be processed as if IXSV had been specified. End of change




Exit program introduced: V5R3
Top | Configuration APIs | APIs by category