List Node List Entries (QFVLSTNL) API
Required Parameter Group:
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Qualified node list name | Input | Char(20) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The List Node List Entries (QFVLSTNL) API returns, in a user space, a list of the nodes contained in the specified node list object.
Authorities and Locks
- Node List Object Authority
- *USE
- Node List Object Lock
- *SHRRD
- User Space Authority
- *CHANGE
- User Space Library Authority
- *EXECUTE
- User Space Lock
- *EXCLRD
Required Parameter Group
- Qualified user space name
- INPUT; CHAR (20)
The name of the user space that is to receive the generated list. The first 10 characters contain the user space name. The second 10 characters contain the name of the library where the user space is located.
The following special values can be used for the library name:
*CURLIB The current library. *LIBL The library list.
- Format name
- INPUT; CHAR(8)
The format of the data placed in the user space. The valid value is:
NODL0100 All node list entry information returned. This format is explained in NODL0100 List Data Section.
- Qualified node list name
- INPUT; CHAR(20)
The name of the node list object from which the entries are to be retrieved. The first 10 characters contain the node list name. The second 10 characters contain the name of the library where the node list is located.
Special values for the name of the node list library are:
*CURLIB The current library. *LIBL The library list.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of the Generated Lists
The returned user space will contain:
- A user area
- A generic header
- An input parameter section
- A header section
- A list data section
For details about the user area and generic header, see User spaces. For details about the other items, see the following sections. For a detailed description of each field in the information returned, see Field Descriptions.
Input Parameter Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name specified |
| 28 | 1C | CHAR(10) | Node list object name specified |
| 38 | 26 | CHAR(10) | Node list object library name specified |
Header Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name used |
| 10 | A | CHAR(10) | User space library name used |
| 20 | 14 | CHAR(10) | Node list object name used |
| 30 | 1E | CHAR(10) | Node list object library name used |
NODL0100 List Data Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Address type |
| 1 | 1 | CHAR(20) | Remote location name (for address type 1) |
| 21 | 15 | CHAR(50) | Text description |
| 71 | 47 | CHAR(1) | Reserved |
| 72 | 48 | BINARY(4) | Text description CCSID |
| 76 | 4C | CHAR(256) | Remote location name (for address type 1, 2, or 3) |
Field Descriptions
Address type. The type of address returned. The following values are used:
| 1 | SNA APPN address type. The network ID and control point name are given in both the remote location name field at offset 1 and at offset 76. |
| 2 | Internet protocol (IP) address type. The host name is given in the remote location name field at offset 76. |
| 3 | Internet protocol (IP) address type. The internet address is given in the remote location name field at offset 76. |
Format name specified. The format name specified as input for the API.
Node list object library name specified. The name of the node list object library as specified on the call to the API.
Node list object library name used. The actual name of the node list object library used to report data.
Node list object name specified. The node list object name as specified on the call to the API. Nodes with an SNA address type are identified by a network ID and a control point name. Nodes with an internet protocol (IP) type are identified by a host name or an internet address. The system-recognized identifier for the object type is *NODL.
Node list object name used. The actual node list object name used to report data. The system-recognized identifier for the object type is *NODL.
Remote location name (for address type x). The name of a system in a network.
The remote location name field at offset 1 contains an 8-character SNA network ID, an 8-character control point name, and 4 reserved characters. The remote location name field at offset 1 is only used if the address type is 1 (SNA). Otherwise, the field at offset 1 is blank.
The contents of the remote location name field at offset 76 depends on the address type:
| 1 | Contains the same name as the field at offset 1: an 8-character SNA network ID, an 8-character control point name, and 4 reserved characters. |
| 2 | Contains a 255-character host name and 1 reserved character. |
| 3 | Contains a 15-character internet address and 241 reserved characters. |
Reserved. An ignored field.
Text description. The text description of the node list entry.
Text description CCSID. The coded character set identifier (CCSID) used for the text description.
User space library name specified. The user space library name as specified on the call to the API.
User space library name used. The actual user space library name used to report data.
User space name specified. The user space name as specified on the call to the API.
User space name used. The actual user space name used to report data.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF813E E | Node list &4 in &9 damaged. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9807 E | One or more libraries in library list deleted. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R3
[ Back to top | Network Management APIs | APIs by category ]