Output Parameters

Output parameters for the function routine are:

SSOBRETN
SSJPRETN
IAZJPLEX (JESPLEX Information service)

SSOBRETN Contents: When control returns to the caller and register 15 contains a zero, the JESPLEX Information services function places one of the following decimal values in the SSOBRETN field:

Value (Decimal): Meaning
SSJPOK (0): Request successful.
SSJPERRW (4): Request completed with possible errors. See SSJPRETN for reason code.
SSJPERRU (8): Request cannot be completed because of user error. See SSJPRETN for reason code.
SSJPERRJ (12): Request cannot be completed; SSJPRETN contains internal reason code.
SSJPPARM (16): The parameter list, that is the SSJP extension is an invalid format - it is not an SSJP, the service version number is not supported, or the SSJP is not large enough.
SSJPSTOR (20): Request cannot be processed because required storage cannot be obtained. No data can be returned to the caller.

SSJPRETN Contents: In addition to the return code in SSOBRETN, the field SSJPRETN contains the service related error or more specific information about the error. SSJPRETN can be set to one of the following values if SSOBRETN is not zero:

Value (Decimal): Meaning
SSJPUNSF (4): Unsupported subfunction requested.
SSJPNTDS (8): SSJPUSER does not point to the correct control block.
SSJPUNSD (12): Version number in the control block pointed to by SSJPUSER is not correct.
SSJPSMLE (16): Length field in the control block pointed to by SSJPUSER is too small.
SSJPEYEE (20): Eyecatcher in the control block pointed to by SSJPUSER is not correct.
SSJPGETM (128): $GETMAIN failed.
SSJPSTGO (132): STORAGE OBTAIN failed.
SSJPINVA (136): Invalid filter arguments were specified.
SSJPGLBL (140): Function not supported on the global (JES3 only).
JPLXINVA (132): Invalid search arguments
JPLXINV1 (136): Status filter invalid
JPLXINV2 (140): System name filter invalid
JPLXINV3 (144): Member name filter invalid
JPLXINV4 (148): JES Specific filter invalid

JESPLEX Information service, IAZJPLEX contents: For the JESPLEX Information service (function code SSJPJXOD), the following parameters are returned in IAZJPLEX:

Field Name: Description
JPLXVERO: Subsystem version number (currently X'0200')
JPLXLPTR: Pointer to first Member data buffer
JPLXNMBR: Number of Member data buffers returned
JPLXTRKT: Total number of SPOOL tracks defined across all partitions
JPLXTRKU: Total number of SPOOL tracks used across all partitions
JPLXTRAT: Total number of active SPOOL tracks defined across all partitions.
JPLXTRAU: Total number of active SPOOL tracks used across all partitions.

For each system or member that passes the filter requirements, an element is added to the chain pointed to by JPLXLPTR. Each element is composed of the following sections:

DSECT Name: DSECT Description
JPXHDR: JESPLEX Header Section
JPXPREF: JESPLEX Prefix Section
JPXGENI: JESPLEX General Information Section
JPXJES3I: JESPLEX JES3 Specific Information Section
JPXJES2I: JESPLEX JES2 Specific Information Section
JPXCPERF: JESPLEX Command Prefix Information
JPXCPRFE: JESPLEX Command Prefix Array Entry

The following example is a layout of the various sections of the JESPLEX Information output data area. The basic layout is a chain of JESPLEX Information sections. Each JESPLEX section has a common section and a subsystem specific section.

          JESPLEX INFO SECTION                              
          +----------------+                                
   JPXHDR | JPXNXTP   =-----------> POINTER TO THE NEXT     
          |                |        JPXHDR IN THE CHAIN.    
          |                |        ZERO IF END OF CHAIN.   
          +----------------+                                
  JPXPREF | Prefix Section |                                
          | . . .          |                                
          +----------------+                                
  JPXGENI | General        |                                
          | JESPLEX Data   |                                
          | Section        |                                
          | . . .          |                                
          +----------------+                                
 JPXJES3I | Optional JES3  |                                
          | JESPLEX        |                                
          | Info Section   |                                
          | . . .          |                                
          +----------------+                                
 JPXJES2I | Optional JES2  |                                
          | JESPLEX        |                                
          | Info Section   |                                
          | . . .          |                                
          +----------------+                                
 JPXCPREF | Command prefix |                                
          | array section  |                                
          | . . .          |                                
          +----------------+

JESPLEX Header Section: Each JESPLEX information element begins with a header section. There can be multiple JESPLEX Areas returned. The JPXNXTP pointer is used to navigate to the next JESPLEX Header section in the chain.

The fields in the JPXHDR section are:

Field Name: Description
JPXEYE: Eyecatcher. Should be set to ‘JPXHDR’.
JPXOPRF: Offset to the prefix section
JPXNXTP: Address of the next JESPLEX information element

JESPLEX Prefix Section: This section holds the length of all the information reported for one of the JESPLEX members. This length does not include the length of the JESPLEX Header section. For addressability to this section, add the JPXOPRF header field to the header (JPXHDR) address.

The fields in the JPXPREF section are:

Field Name: Description
JPXPRLN: Length of the entire element, not including the JESPLEX header section
JPXPRTP: Type of this section.
JPXPRMD: Modifier for this section.

JESPLEX General Information Section: This section holds details that are common to both JES2 and JES3. To get addressability to this section, add the JPXOPRF header field and the prefix size (JPXPRSZ) to the header (JPXHDR) address.

The fields in the JPXGENI section are:

Field Name

Description

JPXGLN

Length of this section.

JPXGTY

Type of this section

JPXGMD

Modifier for this section

JPXSBSNM

Subsystem name

JPXSTIME

Last start date and time in STCK format

JPXSTAT1

Member status

Field Value: Description
JPXDRAIN: Drained or Down member
JPXINITZ: Initializing (JES2 Only)
JPXACTIV: Active member
JPXDRING: Draining member (JES2 Only)
JPXNATCH: Not Attached (JES3 Only)

JPXSTATC

Character string representation of the member status

JPXMVSNM

MVS™ system name

JPXMEMNM

JES member name

JPXVERSN

Product version in character format

JPXSMFID

SMF identifier

JPXSYSLG

Syslog indicator flag

Field Value: Description
JPXSLOGY: Release 11 syslog support is Active for this member

JPXMEMNO

Member number (JES2 Only)

JPXSTPE

Type of last start

Field Value: Description
JPXCOLD: Cold start
JPX2COLF: Cold start with format (JES2 Only)
JPXWARM: Warm start
JPX2SRMS: Single member warm start (JES2 Only)
JPX3WRMD: Warm start to replace a spool dataset (JES3 Only)
JPX3WRMA: Warm start with analysis (JES3 Only)
JPX3WDA: Warm start to replace a spool dataset with analysis (JES3 Only)
JPXHOT: Hot start
JPX3HOTR: Hot start with refresh (JES3 Only)
JPX3HOTA: Hot start with analysis (JES3 Only)
JPX3HTRA: Hot start with refresh and analysis (JES3 Only)
JPX2QUICK: Quick start (JES2 Only)
JPX3LCL: Local start (JES3 Only)

JPXPRODL

Product level in binary format

JPXSERVL

Service level in binary format

JESPLEX JES3 Specific Information Section: This section holds details that are specific to JES3. To get addressability to this section, add the prefix offset (JPXOPRF), the prefix size (JPXPRSZ), and the general information section size (JPXGLN) to the header (JPXHDR) address.

The fields in the JPXJES3I section are:

Field Name

Description

JPX3LN

Length of this section

JPX3TY

Type of this section

JPX3MD

Modifier for this section

JPX3GCON

Last global contact time in STCK format

JPX3TRK1

Primary track group allocation

JPX3TRK2

Secondary track group allocation

JPX3WTOL

WTO message limit

JPX3WTOI

WTO message interval in seconds

JPX3CSA

PBUF CSA limit

JPX3AUX

PBUF JES3AUX limit

JPX3FIX

Fixed PBUFs

JPX3USR

User pages per open SYSOUT dataset

JPX3SELM

Selection mode constant

JPX3SP1

Spool partition name

JPX3MPFX

Message prefix

JPX3MDST

Message destination

JPX3FLG1

Flag byte

Bit Value: Description
JPX3GBL: Global node
JPX3ONL: Online
JPX3FLSH: Flushed
JPX3CNN: Connected
JPX3NCNN: Not connected
JPX3DOWN: Down
JPX3ATT: Attached
JPX3NATT: Not attached

JESPLEX JES2 Specific Information Section: This section holds details that are specific to JES2. To get addressability to this section, add the prefix offset (JPXOPRF), the prefix size (JPXPRSZ), and the general information section size (JPXGLN) to the header (JPXHDR) address.

The fields in the JPXJES2I section are:

Field Name

Description

JPX2LN

Length of this section

JPX2TY

Type of this section

JPX2MD

Modifier for this section

JPX2FLG1

JES2 indicators

Bit Value: Description
JPX21IND: Independent mode
JPX21BOS: BOSS indicator
JPX21PRI: Primary subsystem indicator

JPX2ITIM

Time of last checkpoint access

JPX2FLG2

Current command being processed indicator

Bit Value: Description
JPX21P: $P command
JPX21PXQ: $PXEQ command

JPX2HOLD

Current setting for MASDEF HOLD

JPX2MIND

Current setting for MASDEF MIN DORMANCY

JPX2MAXD

Current setting for MASDEF MAX DORMANCY

JPX2SYNC

Current setting for MASDEF SYNCTOL

JPX2AHLD

Actual HOLD value on the last checkpoint

JPX2ADRM

Actual DORMANCY value on the last checkpoint

JPX2RSID

Name of the member doing the reset

JPX2STAT

Specific Status Indictor

Bit Value: Description
JPX2DOWN: DOWN
JPX2DEF: DEFINED
JPX2INU: INUSE
JPX2FAIL: FAILED
JPX2UNDF: Member UNDEFINED
JPX2UPND: Member UNDEFINED-PENDING
JPX2ACTV: Member ACTIVE
JPX2INAC: Member TERMINATED
JPX2INIT: Member INITIALIZING
JPX2TERM: Member TERMINATING
JPX2JESF: Member JES2-FAILED
JPX2XCFF: Member JESXCF-FAILED
JPX2MVSG: Member MVS-GONE
JPX2DORM: Member DORMANT
JPX2DRAN: Member DRAINED
JPX2ALIC: Member awaiting ALICE processing

JPX2STA2

Second status byte

Bit Value: Description
JPX2EDEL: Member deleted
JPX2$IND: Member in independent mode
JPX2SIOT: SPIN IOT being purged
JPX2NMAL: Member has two checkpoint data sets allocated
JPX2EGON: XCF system gone
JPX2PRIM: Member is a primary subsystem
JPX2SPLX: Command prefix has SYSplex scope

JESPLEX Command Prefix Information: This section acts as a header to the array of command prefix entries.

This section follows immediately after the JES2 or JES3 specific section depending on whether JES2 or JES3 implementation.

This is a variable length section. The length depends upon the number of command prefix entries. JES2 will have only one entry. JES3 might have up to 14 entries.

The fields in the JPXCPREF section are:

Field Name: Description
JPXCLN: Length of this section
JPXCTY: Type of this section
JPXCMD: Modifier for this section
JPXPRXC: Count of command prefix array entries
JPXFPXL: Length of each command prefix array entry
JPXPFXO: Offset to the first command prefix array entry

JESPLEX Command Prefix Array Entry: This section maps out the individual entries in the command prefix array. To get addressability to this array, add the prefix offset (JPXOPRF), the prefix size (JPXPRSZ), the general information section size (JPXGENSZ), the sizes of any optional sections supplied, and the array offset (JPXPFXO) to the header (JPXHDR) address.

The fields in the JPXCPRFE section are:

Field Name

Description

JPXCPFXS

Scope Flags

Field Value: Description
JPXCSYSP: SYSPLEX Scope
JPXCSYST: System Scope

JPXCPFXP

Command prefix value