z/OS MVS Using the Subsystem Interface
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Input Parameters

z/OS MVS Using the Subsystem Interface
SA38-0679-00

Input parameters for the JES information services routine are:
  • SSOB
  • SSIB
  • IAZSSJD
SSOB Contents: The caller sets the following fields in the SSOB control block on input:
Field Name
Description
SSOBID
Identifier 'SSOB'
SSOBLEN
Length of the SSOB control block (SSOBHSIZ)
SSOBFUNC
SSI function code 83 (SSOBSSJD)
SSOBSSIB
Address of the SSIB control block or zero (if this field is zero, the life-of-job SSIB is used). See Subsystem Identification Block (SSIB) for more information about the life-of-job SSIB.
SSOBINDV
Address of the function-dependent area (IAZSSJD)

Set all other fields in the SSOB control block to binary zeros before issuing the IEFSSREQ macro.

SSIB Contents: If you do not use the life-of-job SSIB, the caller must provide an SSIB and set the following fields in the SSIB control block on input:
Field Name
Description
SSIBID
Identifier 'SSIB'
SSIBLEN
Length of the SSIB control block (SSIBSIZE)
SSIBSSNM
Subsystem name: name of the JES subsystem to which this Device Information Services request is directed

Set all other fields in the SSIB control block to binary zeros before issuing the IEFSSREQ macro.

IAZSSJD Contents: Before the first use, the caller should set all fields in the parameter list (IAZSSJD) to binary zeroes. Also, when requesting function code SSJPRSTG (release storage), the caller should not alter any output fields in the parameter list (SSJD) returned on the prior calls to SSJDOBDT (obtain data). Failure to do so might result in a storage leak. On input, the caller must set the following fields in the IAZSSJD structure (parameter list):
Field Name
Description
SSJDEYE
Eyecatcher for the parameter list (must be set to 'SSJDPL')
SSJDLNG
Length of the parameter list (SSJDSIZE)
SSJDVRM
Version of the parameter list, supplied by the caller. This is a two-byte field, which combines version and modifier. Use the SSJDVRMC constant to set this field to the most current version defined in the IASSSJD macro.
SSJDFREQ
Function to be performed on this request. Valid values of SSJDFREQ are:
Field Value
Description
SSJDOBTD
The obtain device data function returns device data in the storage managed by the SSI for that purpose. This function can be called as many times as needed. Each successive call will add more data to the output, unless the SSJDPRLS option is used to release storage.
SSJDRSTG
Release interface-managed storage. This function will release storage used by the data returned by the SSI, ignoring all options and filters in the SSI parameter list.
SSJDSTRP
Storage management anchor for use by the subsystem that responds to this request. It is expected that the caller will set this field to zero when the first time parameter list is used. And from that point, the field will be managed by the subsystem.

The JES device information services provide a number of processing options and selection filters, which impact the way the returned information is presented and allow to subset the returned device information according to a number of criteria.

If no filters are specified by the caller, all available device information is returned. If any filters are specified, at least one of the filter conditions in each of the separate filters must be matched before data will be returned.

Implicit OR is performed between filters in the same filter group. For example, if SSJDFLT1 (device status filter) is set to SSJD1ACT in addition to SSJD1INA, the SSI will return data for all active devices in addition to data for all inactive devices.

Implicit AND is performed between filters in the different filter groups. For example, if SSJDFLT1 (device status filter) is set to SSJD1ACT and SSJDFLT6 is set to SSJD6NAM (device name filter), the SSI will return only those active devices that also have names, matching the name selection filter.

If a filter is not recognized or does not apply, it will not have an impact on the result of the SSI call. For example, JES3-only filters will not have impact on the SSI output from JES2.

Field Name
Description
SSJDPOPT
Processing options:
Bit Value
Description
SSJDPRLS
Release storage used by old data before returning new data.
SSJDPD64
Return data in 64-bit virtual private storage (above the bar). If the caller’s job is prevented by the job attributes to allocate storage above the bar (see MEMLIMIT parameter on JOB JCL statement), the interface will allocate storage in the 31-bit virtual private storage (below the bar). If this option is not selected, the data is always returned in the 31-bit virtual private storage (below the bar).
SSJDPDMC
Perform security label dominance check. In order for the caller to obtain device data, the caller’s security label should dominate the security label of the device. Otherwise, the device is invisible to the caller. This check is always performed for non-authorized callers. This option is only valid for JES2.
SSJDPOP2
Processing options (2):
Bit Value
Description
SSJDP2AD
Return additional data (line, logon or NETSRV device) with remote WS and NJE connection
SSJDP2NF
Apply name filter (see SSJD6NAM) to NJE connections rather than devices of other types
SSJDP2SD
Return all subdevices for the selected device regardless of filtering (applies to offloads, lines and NJE connections)
SSJDFOPT
Output formatting options:
Bit Value
Description
SSJDFLIN
"Line view" data for remote workstations and NJE connections is arranged according to lines that are used to access them. To access "line view" data, use the SSJDLIN8/SSJDLINP pointer. Otherwise, data is arranged according to device type or class; to access this data, use pointers other than SSJDLIN8/SSJDLINP.
SSJDFDRM
Destination filter (see SSJD9DST) should also be checked against remote number for remote print/punch devices and against device number for local print/punch devices. This option is only valid for JES2.

The SSJD1CHR and SSJDZOMO fields can be used to specify the EBCDIC wildcard characters for selection strings that support wildcards. If SSJD1CHR and SSJDZOMO are not specified (both set to hex zeroes), the default wildcard characters are ? (question mark) for SSJD1CHR and * (asterisk) for SSJDZOMO. For example, if either value is specified, both of the provided values are used even if one value is hex zero. It is an error to specify equal values for SSJD1CHR and SSJDZOMO, unless the equal values are hex zeroes.

SSJD1CHR
Wildcard character - matches one character.
SSJDZOMO
Wildcard character - matches 0 or more characters.

Device status filter group includes all filters in SSJDFLT1 and SSJDFLT2 (see descriptions of device statuses).

SSJDFLT1
Filter by device status (1):
Bit Value
Description
SSJD1ACT
Select active devices
SSJD1INA
Select inactive devices
SSJD1HOT
Select printers with hot writer (JES3)
SSJD1DRG
Select draining devices
SSJD1DRN
Select drained devices (JES2) or offline devices (JES3)
SSJD1NRM
Composite (multi-bit) value for status filter - select devices in a "normal" state. Devices in this state are available to process work
SSJDFLT2
Filter by device status (2):
Bit Value
Description
SSJD2STE
Select startable devices
SSJD2STG
Select starting devices
SSJD2HTD
Select halted devices
SSJD2PAU
Select paused devices
SSJD2HTG
Select halting devices
SSJD2INT
Select devices requiring intervention or attention
SSJD2PRB
Composite (multi-bit) value for status filter selects devices in a "problem" state. Devices in this state might require operator attention.
SSJD2NRS
Select unresponsive devices
SSJD2END
Select devices with processors ended due to error (JES2)

Device type filter group includes all filters in SSJDFLT3 and SSJDFLT4:

Field Name
Description
SSJDFLT3
Filter by device type (1):
Bit Value
Description
SSJD3PRT
Select printers
SSJD3PUN
Select punches
SSJD3RDR
Select readers
SSJD3CON
Select consoles
SSJD3JXM
Select job transmitters
SSJD3JRC
Select job receivers
SSJD3SXM
Select SYSOUT transmitters
SSJD3SRC
Select SYSOUT receivers
SSJD3XMT
Composite device type filter–select all transmitters
SSJD3RCV
Composite device type filter–select all receivers
SSJDFLT4
Filter by device type (2):
Bit Value
Description
SSJD4LIN
Select line devices
SSJD4LGN
Select logon devices
SSJD4NSV
Select NETSRV devices
SSJD4OFL
Select OFFLOAD devices
SSJD4NJE
Select NJE connections

Device class filter group includes all filters in SSJDFLT5.

Attention: Do not use SSJDFLT5 to filter for line devices. If any combination of SSJDFLT5 bits are selected other than all off or all on, lines will not be returned.
Field Name
Description
SSJDFLT5
Filter by device class:
Bit Value
Description
SSJD5LCL
Select local devices
SSJD5RMT
Select remote devices
SSJD5OFL
Select OFFLOAD devices (transmitters and receivers)
SSJD5NJE
Select NJE devices (transmitters and receivers)
SSJD5IFC
Select interface devices (logon and NETSRV devices)

Remaining filters are independent and are not combined in filter groups. (There is an implicit AND relationship between these filters.)

Field Name
Description
SSJDFLT6
Device attribute filters:
Bit Value
Description
SSJD6NAM
Select by device name (see SSJDDVNM)
SSJD6DGN
Select by device group name (see SSJDDGNM) (JES3)
SSJD6SYS
Select by owning system name (see SSJDSYSN)
SSJD6MBR
Select by owning member name (see SSJDMBRN)
SSJD6LIN
Select by related line name (see SSJDLNNM) (JES2)

Note that if none of the system/member selection filters (SSJD6SYS and SSJD6MBR) are specified, data is only returned for the local JESPLEX member (for example, the subsystem that processes the SSI call). To see data for other JESPLEX members, some selection through these filters must be specified. For example, to obtain data for all members in the current JESPLEX, set SSJD6SYS bit on and set value of SSJDSYSN to “match all” wildcard selection. For JES3, information is always reported by the global system.

The following filters only apply to specific device types, which support the relevant attribute. Applying these filters to other devices will not impact the result. For example, if a device type filter is used to select punches, specifying JES-mode printer filter will not have any effect on the result.

Field Name
Description
SSJDFLT7
Filters which only apply to specific device types (1):
Bit Value
Description
SSJD7RWN
Select remote devices by remote workstation name (see SSJDRWNM)
SSJD7NJN
Select NJE devices by adjacent node name (see SSJDADJN) (JES2)
SSJD7NJA
Select SNA NJE connections by SNA application name (see SSJDAPNM) (JES2)
SSJD7NJK
Select TCP NJE connections by TCP socket name (see SSJDSKNM) (JES2)
SSJD7NJB
Select remote and NJE devices connected via BSC
SSJD7NJS
Select remote and NJE devices connected via SNA
SSJD7NJT
Select remote and NJE devices connected via TCP/IP
SSJDFLT8
Filters that only apply to specific device types (2):
Bit Value
Description
SSJD8JES
Select JES mode printers
SSJD8FSS
Select FSS mode printers
SSJDFLT9
Filters that only apply to specific device types (3) - filter by attributes used in the work selection criteria in effect for a device:
Bit Value
Description
SSJD9CLS
Select by output class name in the work selection criteria (see SSJDWSCL)
SSJD9FRM
Select by form name in the work selection criteria (see SSJDWSFM)
SSJD9JBN
Select by job name in the work selection criteria (see SSJDWSJN)
SSJD9DST
Select by destination ID in the work selection criteria (see SSJDWSDS). Also see option SSJDFDRM in SSJDFOPT.
SSJD9WRT
Select by writer name in the work selection criteria (see SSJDWSWR)
SSJD9PRM
Select by processing mode in the work selection criteria (see SSJDWSPR)
SSJDFLTZ
Filters that only apply to specific device types (4) - filter by attributes of the work unit currently processed by a device:
Bit Value
Description
SSJDZJOB
Select by name of the job currently processed by a device (see SSJDAJOB)
SSJDZCRT
Select by name of the owner of the job currently processed, or by name of creator of the SYSOUT dataset currently processed by a device (see SSJDACRT)

The following fields provide actual selection values for filters that are requested by the filter selection flags described above.

Device name filter consists of two parts:
  • Single name filter (SSJDDVNM). This part supports wildcards.
  • Name range list filter (SSJDDVNA and SSJDDVN#). This part does not support wildcards.

The device will pass the device name filter if it matches any of these two parts. Both parts of the device name filter are controlled by the same bit (SSJD6NAM in SSJDFLT6).

Name range list is specified by a pointer to a list (SSJDDVNA) and the number of elements in the list (SSJDDVN#). Each element in the list is a pair of 10-character device names that define a range of device names. To disable the single name filter (SSJDDVNM), set this field to blank. To disable the name range list filter, set the pointer (SSJDDVNA) or the number of elements (SSJDDVN#) to binary zero. For example, one way to select devices with the name R1.PR1 and devices with the names in the range of PRT100-PRT200 is to set single name filter (SSJDDVNM) to 'R1.PR1' (this will match a single device name), and create a list with one element - a pair of values 'PRT100' and 'PRT200' (this will match a range of device names).

The function of the device name filter is independent of the device type and the device class filters. There is an implicit OR relationship between the device name filter and the type and class filters. For example, if the device name filter is set to select devices with name 'PRT5*', SSJD3PRT is set to select printers, and SSJD5RMT is set to select remote devices, the interface will return all remote printers and any other device that matches 'PRT5*'.

Field Name
Description
SSJDDVNM
Single device name for selection. This field supports wildcards (used with SSJD6NAM)
SSJDDVNA
Pointer to device name range list (used with SSJD6NAM)
SSJDDVN#
Number of elements in the device name range list (used with SSJD6NAM)
Device group name filter is supported by JES3 and consists of two parts:
  • Single group name filter (SSJDDGNM). This part supports wildcards.
  • Group name range list filter (SSJDDGNA and SSJDDGN#). This part does not support wildcards.

JES3 device group will pass the filter if it matches any of these two parts. Both parts of the device group name filter are controlled by the same bit (SSJD6DGN in SSJDFLT6).

Group name range list is specified by a pointer to a list (SSJDDGNA) and number of elements in the list (SSJDDGN#). Each element in the list is a pair of 8-character device group names that define a range of device group names.

To disable the single name part of the filter (SSJDDGNM), set this field to blank.

To disable the name range list part of the filter, set pointer (SSJDDGNA) or the number of elements (SSJDDGN#) to binary zero.

For example, to select devices with the device group name DGRP1 and devices with the device group names in the range of DGRP100-DGRP200, set a single name filter (SSJDDGNM) to 'DGRP1' (this will match a single device group), and create a list with one element - a pair of values 'DGRP100' and 'DGRP200' (this will match a range of device group names).

Field Name
Description
SSJDDGNM
Single device group name for selection. This field supports wildcards. (used with SSJD6DGN)
SSJDDGNA
Pointer to device group name range list. (used with SSJD6DGN)
SSJDDGN#
Number of elements in the device group name range list. (used with SSJD6DGN)

More selection values for filters:

Field Name
Description
SSJDSYSN
System name for selection (used with SSJD6SYS in SSJDFLT6). This field supports wildcards.
SSJDMBRN
Member name for selection (used with SSJD6MBR in SSJDFLT6). This field supports wildcards.
SSJDLNNM
Line name for selection (used with SSJD6LIN in SSJDFLT6). This field supports wildcards.
SSJDRWNM
Remote workstation name for selection (used with SSJD7RWN in SSJDFLT7). This field supports wildcards.
SSJDADJN
Adjacent node name for selection (used with SSJD7NJN in SSJDFLT7). This field supports wildcards.
SSJDAPNM
SNA application name for selection (used with SSJD7NJA in SSJDFLT7). This field supports wildcards.
SSJDSKNM
TCP socket name for selection (used with SSJD7NJK in SSJDFLT7). This field supports wildcards.
SSJDWSCL
Output class name for selection (used with SSJD9CLS in SSJDFLT9). This field supports wildcards.
SSJDWSFM
Form name for selection (used with SSJD9FRM in SSJDFLT9). This field supports wildcards.
SSJDWSJN
Job name for selection (used with SSJD9JBN in SSJDFLT9). This field supports wildcards.
SSJDWSDS
Single destination name for selection. This field supports wildcards.
SSJDWSWR
Writer name for selection (used with SSJD9WRT in SSJDFLT9). This field supports wildcards.
SSJDWSPR
Processing mode for selection (used with SSJD9PRM in SSJDFLT9). This field supports wildcards.
SSJDAJOB
Name of the job currently processed by device (used with SSJDZJOB in SSJDFLTZ). This field supports wildcards.
SSJDACRT
Owner of the job that is currently processed by device or creator of SYSOUT dataset that is currently processed by device (used with SSJDZCRM in SSJDFLTZ). This field supports wildcards.
Destination filter consists of two parts:
  • Single destination name filter (SSJDWSDS). This part of the filter supports wildcards.
  • Destination name list filter (SSJDDSTA and SSJDDDST#). This part of the filter does not support wildcards.

Device will pass the filter if its destination name matches any of these two parts. Both parts of the destination name filter are controlled by the same bit (SSJD9DST in SSJDFLT9).

Destination name list is specified by a pointer to a list (SSJDDSTA) and the number of elements in the list (SSJDDST#). Each element in the list is an 18-character destination name.

To disable the single name part of the filter, set the field (SSJDWSDS) to blank.

To disable the list part of the filter, set pointer (SSJDDSTA) or the number of elements (SSJDDST#) to binary zero.

Field Name
Description
SSJDWSDS
Single destination name for selection. This field supports wildcards.
SSJDDSTA
Pointer to destination name list.
SSJDDST#
Number of elements in the destination name list.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014