Output Parameters

Output parameters for the function routine are:

SSOBRETN
SSJPRETN
IAZJPNJN (NJE Node Information service)

SSOBRETN Contents: When control returns to the caller and register 15 contains a zero, the NJE Node 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, see SSJPRETN for reason code.

SSJPPARM (16)

Error in the parameter list. For example, the SSJP extension has an invalid format:

It is not an SSJP
The service version number is not supported
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).
NJNDSUBF (256): Function code specified in SSJPFREQ not supported.
NJNDSPTE (260): Invalid NJNLSTRP pointer.
NJNDRNGE (264): The high bound for the range of node numbers that is specified by NJNLRNGH is less than the low bound specified by NJNLRNGL
NJNDRNGZ (268): The low bound for the range of node numbers, NJNLRNGL, is set to zero.
NJNDOWNE (272): The own or home node filter, NJNLCOWN, should not be used with other connection status filters.
NJNDSTRE (276): The caller did not provide enough storage to hold all the data returned by the subfunction call.
NJNDINTE (280): Internal error building the system information data area.

NJE Node Information service, IAZJPNJN contents: For the NJE Node Information service (function code SSJPNJOD) the following is returned in IAZJPNJN:

Field Name: Description
NJNLSVRM: Subsystem version number (currently 2).
NJNLDPTR: Pointer to data for first NJE node data area.
NJNLMPTR: Pointer to first system information data area.
NJNLDNUM: Number of NJE node data areas returned.
NJNLMNUM: Number of member data areas returned.

The following DSECTs define data structures returned by NJE node SSI.

After a successful call to the SSI, field NJNLDPTR points to a chain of data areas representing data for each NJE node. In addition, the field NJNLMPTR points to a chain of data areas representing member information.

For each NJE node that passes the filter requirements, an element is added to the chain pointed to by NJNLDPTR. Each element is composed of the following sections:

DSECT Name: DSECT Description
NJNHDR: NJE Node Data Header Section
NJNFPREF: Prefix Section
NJNCMN: NJE Node Common Section

In addition to the preceding common sections, JES2 returns the following sections:

DSECT Name: DSECT Description
N2NGEN: JES2 General Data Section
N2NPATH: JES2 Path Information Section
Note: This is an optional section that contains one or more of the following entries:
N2NPTEN: JES2 Path Information Entry

In addition to the common sections listed above, JES3 returns the following sections:

DSECT Name: DSECT Description
N3NGEN: JES3 General Data Section
N3NPATH: JES3 Path Information Section
Note: This is an optional section that contains one or more of the following entries:
N3NPTEN: JES3 Path Information Entry

The following is a layout of the various sections of the NJE Node Information output data area.

          NODE INFO SECTION                                
          +----------------+                                
   NJNHDR | NJNHNEXT  =-----------> POINTER TO THE NEXT     
          |                |        NJNHDR IN THE CHAIN.    
          |                |        ZERO IF END OF CHAIN.   
          |                |                                
          +----------------+                                
 NJNFPREF | Prefix Section |                                
          |                |                                
          +----------------+                                
   NJNCMN | NJE Node       |                                
          | Common Info    |                                
          | Section        |                                
          |                |                                
          +----------------+                                
   N2NGEN | Optional JES2  |      NOTE: Included if JES2    
          | NJE Node Info  |                                
          | Section        |                                
          |                |                                
          +----------------+                                
  N2NPATH | Optional JES2  |      NOTE: Included if JES2    
          | Path Info      |                                
          | Section        |                                
          |                |                                
          +----------------+                                
  N2NPTEN | Optional JES2  |      NOTE: Number of entries   
  (1..N)  | Path Info      |            specified in        
          | Array Entries  |            N2NPNENT.           
          |                |                                
          +----------------+                                
   N3NGEN | Optional JES3  |      NOTE: Included if JES3    
          | NJE Node Info  |                                
          | Section        |                                
          |                |                                
          +----------------+                                
  N3NPATH | Optional JES3  |      NOTE: Included if JES3    
          | Path Info      |                                
          | Section        |                                
          |                |                                
          +----------------+                                
  N3NPTEN | Optional JES3  |      NOTE: Number of entries   
  (1..N)  | Path Info      |            specified in        
          | Array Entries  |            N3NPNENT.           
          |                |                                
          +----------------+

In addition to the Node information, NLNLMPTR will point to the first element in a separate chain of system information elements. One such element is returned for each SSI call to obtain data. A single element contains an entry for each system that meets the selection filters. These entries contain basic information about the systems in the JESPLEX that were processed to obtain data for this SSI call. The element consists of the following contiguous data structures:

Header Section mapped by NJSHDR
Prefix section mapped by JPSYSPRF in macro IAZJPLXI
System information section mapped by JPSYSINF in macro IAZJPLXI

Note: Repeated calls to the obtain data subfunction of this SSI (SSJPNJOD) without intervening call to release storage subfunction (SSJPNJRS), will cause data from a new SSI call to be added ahead of the data from an earlier SSI call.

NJE Node Data Header Section: The fields in the NJNHDR section are:

Field Name: Description
NJNHEYE: Eyecatcher. This should be set to ‘JPNJNODE’.
NJNHOHDR: Offset to the NJNFPREF prefix section.
NJNHNEXT: Address of next NJE node element.
NJNHJPLX: Address of system information entry of member reporting this NJE node.

Prefix Section: This section contains the total length of the data returned for an NJE node.

The fields in the NJNFPREF section are:

Field Name: Description
NJNFLNG: Total length of all the sections for this element. This does not include the length of the header section.
NJNFTYPE: Type of this section.
NJNFMOD: Modifier for this section.

NJE Node Common Section: This section contains attributes common for JES2 and JES3.

The fields in the NJNCMN section are:

Field Name

Description

NJNCLNG

Length of this section

NJNCTYPE

Type of this section

NJNCMOD

Modifier for this section

NJNCNAME

Node name

NJNCSYSN

Name of the reporting system

NJNCMBRN

MAS member name of the reporting system (JES2 Only)

NJNCSFLG

Node status flags:

Bit Value: Description
NJNCSLCL: Set if this node is the own or home node
NJNCSCNC: Set if this node is a connected node where at least one path is connected
NJNCSPND: Set if this node is a pending node where at least one path is pending
NJNCSADJ: Set if this node is an adjacent node
NJNCSDIR: Set if this node is a directly attached node

NJNCFLG1

Processing flags:

Bit Value: Description
NJNC1SPW: Send the signon password
NJNC1VPW: Verify the signon password
NJNC1EPW: Encrypt the job password
NJNC1PWL: Local password check (JES3 only)
NJNC1SSG: Secure sign-on
NJNC1CSG: Compatible sign-on

NJNCFLG2

More processing flags:

Bit Value: Description
NJNC2TRC: Trace requested
NJNC2RST: Autoconnect or restart
NJNC2HDJ: Hold received jobs
NJNC2HDS: Hold received SYSOUT

NJNCLINE

The associated line name. This line is:

a dedicated line (JES2 only)
a default line (JES3 only)

NJNCRINT

Automatic restart (reconnect) interval in minutes

NJNCRETR

Maximum number of reconnection retries. Zero in this field means an indefinite number of retries.

NJNCSECL

Security label (JES2 only)

JES2 General Data Section: This section contains node attributes that are unique for JES2.

The fields in the N2NGEN section are:

Field Name

Description

N2NGLNG

Length of this section

N2NGTYPE

Type of this section

N2NGMOD

Modifier for this section

N2NGNUM

Node number

N2NGSFLG

Node status flags:

Bit Value: Description
N2NGSPMD: Path manager is down
N2NGSNOP: Non path manager mode
N2NGSEND: End node (no forwarding)
N2NGSPRV: Private node
N2NGSDIR: Only allow direct connection

N2NGFLG1

Processing flags:

Bit Value: Description
N2NG1ADV: Authority to device commands
N2NG1AJB: Authority to job commands
N2NG1ANT: Authority to net commands
N2NG1ASY: Authority to system commands
N2NG1XMJ: Transmit jobs
N2NG1XMS: Transmit SYSOUT
N2NG1RCJ: Receive SYSOUT
N2NG1RCS: Receive sysout

N2NGFLG2

More processing flags:

Bit Value: Description
N2NG2ARS: Accept resistance

N2NGCMPT

Compaction table id

N2NGREST

Node resistance

N2NGSUBN

NJE subnet name

N2NGLOGM

VTAM® logmode

N2NGLOGN

Logon device name

N2NGNSVN

NETSRV name

N2NGLNID

Binary device identifier for NJNCLINE

N2NGLGID

Binary device identifier for NJNGLOGN

N2NGNSID

Binary device identifier for NJNGNSVN

JES2 Path Information Section: This section contains an array of JES2 Path Information Entries.

The fields in the N2NPATH section are:

Field Name: Description
N2NPLNG: Length of this section including all the Path Information entries
N2NPTYPE: Type of this section
N2NPMOD: Modifier for this section
N2NPOENT: Offset to the first Path Information entry
N2NPNENT: Number of Path Information entries
N2NPSENT: Size of each Path Information entry

JES2 Path Information Entry: This section contains NJE path attributes unique to JES2.

The fields in the N2NPTEN section are:

Field Name

Description

N2NPSFLG

Path status flags:

Bit Value: Description
N2NPSVLN: Connected by line
N2NPSVMB: Connected by member
N2NPSAWR: Awaiting reset
N2NPSSGN: Signon in progress
N2NPSPND: Connection pending

N2NPNAM1

Set to the intermediate node name when path status is one of the following situations:

Connected by line: N2NPSVLN
Connection pending: N2NPSPND
Awaiting reset: N2NPSAWR

N2NPNAM2

Associated line name or member name. Set to the associated line name if the path status is set to:

Connected by line: N2NPSVLN
Signon in progress: N2NPSSGN

Set to the associated member name if the path status is set to:

Connected by member: N2NPSVMB
Connection pending: N2NPSPND

N2NPREST

Path resistance

JES3 General Data Section: This section contains attributes unique to JES3.

The fields in the N3NGEN section are:

Field Name

Description

N3NGLNG

Length of this section

N3NGTYPE

Type of this section

N3NGMOD

Modifier for this section

N3NGSFLG

Node connection status:

Bit Value: Description
N3NGSSNA: Connected via SNA
N3NGSBSC: Connected via BSC
N3NGSTCP: Connected via TCP
N3NGSIND: Indirect node
N3NGSALS: Alias of home node
N3NGSCTC: CTC node
N3NGSSGS: Send signature
N3NGSSGV: Verify signature

N3NGFLG1

Processing flags:

Bit Value: Description
N3NG1DFC: Default class
N3NG1XNR: Writer name is required to hold SYSOUT for external writer
N3NG1NTH: Net hold
N3NG1TLS: Secure socket (TLS)

N3NGEPR

NETPR

N3NGEPU

NETPU

N3NGBUFS

Buffer size

N3NGPRCL

PRTDEF class

N3NGTSCL

PRTTSO class

N3NGXWCL

PRTXWTR class

N3NGPUCL

PUNDEF class

N3NGPART

Spool partition

N3NGBDTI

Bulk data transfer (BDT) id

N3NGSTRM

Stream

N3NGMAXL

Maximum number of lines

N3NGNRJT

Number of job transmitters

N3NGNRJR

Number of job receivers

N3NGNROT

Number of output transmitters

N3NGNROR

Number of output receivers

JES3 Path Information Section: This section contains an array of JES3 path information entries.

The fields in the N3NPATH section are:

Field Name: Description
N3NPLNG: Length of this section
N3NPTYPE: Type of this section
N3NPMOD: Modifier for this section
N3NPOENT: Offset to first JES3 Path Information entry
N3NPNENT: Number of entries
N3NPSENT: Size of each entry

JES3 Path Information Entry: This section contains the NJE path attributes that are unique for JES3.

The fields in the N3NPTEN section are:

Field Name: Description
N3NPNNAM: Node name

System information header: The prefix information addressed by this header is mapped by the JPSYSPRF section of the IAZJPLXI macro. In addition, the system information addressed from this prefix section is mapped by the JPSYSINF section of the IAZJPLXI macro.

The fields in the NJSHDR section are:

Field Name: Description
NJSHEYE: Eyecatcher. Should be set to ‘JPNJSYSI’
NJSHOHDR: Offset to first (prefix) section
NJSHNEXT: Address of the next NJSHDR header element