List Network Server Configuration (QFPRLNWS) API
Required Parameter Group:
1 | Qualified user space name | Input | Char(20) |
2 | Format name | Input | Char(8) |
3 | Network server configuration name | Input | Char(10) |
4 | Configuration type | Input | Char(10) |
5 | Error Code | I/O | Char(*) |
Threadsafe: NO
The List Network Server Configuration (QFPRLNWS) API returns a list of network server configurations.
Authorities and Locks
- User space
- *CHANGE
- User space library
- *EXECUTE
- User space lock
- *EXCLRD
Required Parameter Group
- Qualified user space name
-
INPUT; CHAR(20)
The user space that receives the generated list, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the user space library.
You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Format name
-
INPUT; CHAR(8)
The format of the returned network server configuration information. Supported format names are:
FPRL0100 Returns information about a specific network server configuration or all network server configuration. - Network server configuration name
-
INPUT; CHAR(10)
The name of the network server configuration for which information is retrieved.
Object name Object of this name only, of the specified configuration type Generic object name All objects that have names matching the generic string, of the specified configuration type *ALL All objects of the specified configuration type - Configuration type
-
INPUT; CHAR(10)
Type of configuration to list.
*ALL All objects of the specified configuration description type *CNNSEC Connection security network server configurations only *RMTSYS Remote system network server configurations only *SRVPRC Service processor network server configurations only - 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 List
The list consists of:- A user area
- A generic header
- An input parameter section
- A list data section
For details about the user area and generic header, see User spaces. The remaining items are described in the following sections. For detailed descriptions of the fields in the tables, see Field Descriptions.
Input Parameter Section
The following information is returned in the input parameter section. For detailed descriptions of the fields in this table, see Field Descriptions.Offset | Type | Field | |
---|---|---|---|
Dec | Hex | ||
0 | 0 | Char(10) | User space name specified |
10 | A | Char(10) | User space library specified |
20 | 14 | Char(8) | Format name specified |
28 | 1C | Char(10) | Network server configuration name specified |
38 | 26 | Char(10) | Configuration type specified |
FPRL0100 Format
The following table shows the information returned in the list data section of the user space for the FPRL0100 format. The offsets listed are from the beginning of the user space. For a detailed description of each field, see Field Descriptions.
Offset | Type | Field | |
---|---|---|---|
Dec | Hex | ||
0 | 0 | Char(10) | Network server configuration name |
10 | A | Char(10) | Configuration type |
20 | 14 | Char(50) | Text description |
Field Descriptions
The field descriptions are always in alphabetical order.Configuration type specified. The configuration type, as specified on the call to the API.
- *ALL
- *CNNSEC
- *RMTSYS
- *SRVPRC
Configuration type. The configuration type.
- *CNNSEC
- *RMTSYS
- *SRVPRC
Format name specified. The format name as specified on the call to the API.
Network server configuration name specified. The name of the network server configuration, as specified in the call to the API.
Network server configuration name. The name of the network server configuration.
Text description. A brief description of the network server configuration.
User space library specified. The name of the user space library as specified on the call to the API.
User space name specified. The name of the user space as specified on the call to the API.
Error Messages
Message ID | Error Message Text |
---|---|
CPF2105 E | Object &1 in &2 type *&3 not found. |
CPF2110 E | Library &1 not found. |
CPF2189 E | Not authorized to object &1 in &2 type *&3. |
CPF24B4 E | Severe error while addressing parameter list |
CPF26A8 E | Configuration description type not valid for this API. |
CPF3C21 E | Format name &1 is not valid. |
CPF3CF1 E | Error code parameter not valid. |
CPF3CF2 E | Error(s) occurred during running of &1 API. |
CPF9820 E | Not authorized to use library &1. |
CPFA31E E | Required parameter &1 omitted. |
CPFB752 E | Internal error in &2 API. |
API introduced: V5R4