Retrieve Network Server Description (QDCRNWSD) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Network server name | Input | Char(10) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Retrieve Network Server Description (QDCRNWSD) API retrieves information about a network server description.
Authorities and Locks
- Line Description Authority
- *USE
- Network Server Description Authority
- *USE
- Network Server Description Lock
- *SHRRD
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable that is to receive the network server information.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the area that is referred to by the receiver variable parameter. If the amount of information to be returned is greater than this value, the information will be truncated to this length.
- Format name
- INPUT; CHAR(8)
The content and format of the information that is returned for each network server. The possible format names are:
NWSD0100 Basic network server information NWSD0110 Basic network server information with server OS NWSD0200 Detailed information for network server category *LANSERVER NWSD0300 Detailed information for network server category *NETWARE NWSD0400 Detailed information for network server category *BASE NWSD0500 Detailed information for network server category *AIX NWSD0600 Detailed information for network server category *IXSVR or *WINDOWSNT NWSD0700 Detailed information for network server category *GUEST NWSD0800 Detailed information for network server category *ISCSI See Format of Network Server Information for a description of these formats.
Note: Formats NWSD0200, NWSD0300, NWSD0400, and NWSD0500 are no longer supported.
- Network server name
- INPUT; CHAR(10)
The name of the network server description to be retrieved.
- 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 Network Server Information
When the network server category is unknown, specify NWSD0100 and the basic information (including network server category) will be returned. When the network server category is known, specify one of the other category-specific formats.
When the network server category and server OS is unknown, specify NWSD0110 and the basic information (including network server category and server OS) will be returned. When the network server category and the server OS is known, specify one of the other category-specific formats.
For detailed descriptions of the fields returned in these formats, see Field Descriptions.
NWSD0100 Format
Use this format to find out the network server category, plus some basic information about the network server. Then you may use the returned network server category to select one of the other (category-specific) formats to call the API again for detailed information about the network server description. This format also returns the number of lines that are currently attached to this network server.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to higher-level format |
| 12 | C | CHAR(10) | Number of attached nonswitched lines |
| 22 | 16 | CHAR(7) | Date information retrieved |
| 29 | 1D | CHAR(6) | Time information retrieved |
| 35 | 23 | CHAR(8) | Network server name |
| 43 | 2B | CHAR(10) | Online at IPL |
| 53 | 35 | CHAR(50) | Text description |
| 103 | 67 | CHAR(1) | Network server connection type |
NWSD0110 Format
Use this format to find out the network server category, server OS, plus some basic information about the network server. Then you may use the returned network server category to select one of the other (category-specific) formats to call the API again for detailed information about the network server description. This format also returns the number of lines that are currently attached to this network server.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to higher-level format |
| 12 | C | CHAR(10) | Number of attached nonswitched lines |
| 22 | 16 | CHAR(7) | Date information retrieved |
| 29 | 1D | CHAR(6) | Time information retrieved |
| 35 | 23 | CHAR(8) | Network server name |
| 43 | 2B | CHAR(10) | Online at IPL |
| 53 | 35 | CHAR(50) | Text description |
| 103 | 67 | CHAR(1) | Network server connection type |
| 104 | 68 | CHAR(10) | Server operating system |
NWSD0200 Format
This format returns detailed information about a network server of category *LANSERVER.
Note: Format NWSD0200 is no longer supported.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Returns everything from format NWSD0100 | |
| 104 | 68 | BINARY(4) | Offset to attached nonswitched lines |
| 108 | 6C | BINARY(4) | Number of attached nonswitched lines |
| 112 | 70 | BINARY(4) | Entry length of attached nonswitched line |
| 116 | 74 | BINARY(4) | Offset to network storage spaces |
| 120 | 78 | BINARY(4) | Number of storage spaces |
| 124 | 7C | BINARY(4) | Entry length of storage spaces |
| 128 | 80 | CHAR(10) | Vary on wait |
| 138 | 8A | CHAR(4) | Language version |
| 142 | 8E | CHAR(10) | Country or region code |
| 152 | 98 | CHAR(10) | Code page |
| 162 | A2 | CHAR(10) | Resource name |
| 172 | AC | CHAR(10) | Reserved |
| 182 | B6 | CHAR(10) | Domain role |
| 192 | C0 | CHAR(10) | Group profile |
| 202 | CA | CHAR(10) | NetBIOS description |
| 212 | D4 | CHAR(2) | Reserved |
| 214 | D6 | CHAR(10) | Configuration file name |
| 224 | E0 | CHAR(10) | Configuration file library name |
| 234 | EA | CHAR(10) | Start TCP/IP |
| 244 | F4 | BINARY(4) | Offset to list of TCP/IP port configurations |
| 248 | F8 | BINARY(4) | Length of TCP/IP port configuration entries |
| 252 | FC | BINARY(4) | Number of TCP/IP port configurations |
| 256 | 100 | BINARY(4) | Offset to list of TCP/IP route entries |
| 260 | 104 | BINARY(4) | Length of TCP/IP route entries |
| 264 | 108 | BINARY(4) | Number of TCP/IP route entries |
| 268 | 10C | BINARY(4) | Offset to list of TCP/IP name server entries |
| 272 | 110 | BINARY(4) | Length of TCP/IP name server entries |
| 276 | 114 | BINARY(4) | Number of TCP/IP name server entries |
| 280 | 118 | CHAR(63) | TCP/IP host name |
| 343 | 157 | CHAR(1) | Reserved |
| 344 | 158 | CHAR(255) | TCP/IP domain name |
| 599 | 257 | CHAR(1) | Reserved |
| These fields repeat for each nonswitched line | CHAR(10) | Attached nonswitched line | |
| CHAR(10) | Line category | ||
| CHAR(10) | Port number | ||
| CHAR(50) | Line text description | ||
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Drive letter | ||
| CHAR(50) | Storage space text description | ||
| These fields repeat for each TCP/IP port configuration | CHAR(10) | TCP/IP port number | |
| CHAR(15) | Internet address | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Subnet mask | ||
| CHAR(1) | Reserved | ||
| BINARY(4) | MTU for port | ||
| These fields repeat for each TCP/IP route entry | CHAR(15) | Route destination | |
| CHAR(1) | Reserved | ||
| CHAR(15) | Route subnet mask | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Next hop | ||
| CHAR(1) | Reserved | ||
| These fields repeat for each TCP/IP name server | CHAR(15) | TCP/IP name server | |
| CHAR(1) | Reserved | ||
NWSD0300 Format
This format returns detailed information about a network server of category *NETWARE.
Note: Format NWSD0300 is no longer supported.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Returns everything from format NWSD0100 | |
| 104 | 68 | BINARY(4) | Offset to attached nonswitched lines |
| 108 | 6C | BINARY(4) | Number of attached nonswitched lines |
| 112 | 70 | BINARY(4) | Entry length of attached nonswitched line |
| 116 | 74 | BINARY(4) | Offset to network storage spaces |
| 120 | 78 | BINARY(4) | Number of storage spaces |
| 124 | 7C | BINARY(4) | Entry length of storage space |
| 128 | 80 | CHAR(10) | Vary on wait |
| 138 | 8A | CHAR(4) | Language version |
| 142 | 8E | CHAR(10) | Country or region code |
| 152 | 98 | CHAR(10) | Code page |
| 162 | A2 | CHAR(10) | Resource name |
| 172 | AC | CHAR(10) | IPX description |
| 182 | B6 | CHAR(10) | Local IPX connection |
| 192 | C0 | CHAR(10) | Configuration file name |
| 202 | CA | CHAR(10) | Configuration file library name |
| 212 | D4 | CHAR(10) | Message queue name |
| 222 | DE | CHAR(10) | Message queue library name |
| 232 | E8 | CHAR(10) | Synchronize date and time |
| 242 | F2 | BINARY(4) | Offset to list of restricted device resources |
| 246 | F6 | BINARY(4) | Length of restricted device resource |
| 250 | FA | BINARY(4) | Number of restricted device resource entries |
| These fields repeat for each nonswitched line | CHAR(10) | Attached nonswitched line | |
| CHAR(10) | Line category | ||
| CHAR(10) | Port number | ||
| CHAR(10) | Line text description | ||
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Drive letter | ||
| CHAR(50) | Storage space text description | ||
| This field repeats for each restricted device resource | CHAR(10) | Restricted device resource | |
| CHAR(2) | Reserved | ||
NWSD0400 Format
This format returns detailed information about a network server of category *BASE.
Note: Format NWSD0400 is no longer supported.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Returns everything from format NWSD0100 | |
| 104 | 68 | BINARY(4) | Offset to attached nonswitched lines |
| 108 | 6C | BINARY(4) | Number of attached nonswitched lines |
| 112 | 70 | BINARY(4) | Entry length of attached nonswitched lines |
| 116 | 74 | BINARY(4) | Offset to network storage spaces |
| 120 | 78 | BINARY(4) | Number of storage spaces |
| 124 | 7C | BINARY(4) | Entry length of storage spaces |
| 128 | 80 | CHAR(10) | Vary on wait |
| 138 | 8A | CHAR(4) | Language version |
| 142 | 8E | CHAR(10) | Country or region code |
| 152 | 98 | CHAR(10) | Code page |
| 162 | A2 | CHAR(10) | Resource name |
| 172 | AC | CHAR(10) | NetBIOS description |
| 182 | B6 | CHAR(10) | Configuration file name |
| 192 | C0 | CHAR(10) | Configuration file library name |
| 202 | CA | CHAR(10) | Start NetBIOS |
| 212 | D4 | CHAR(10) | Start TCP/IP |
| 222 | DE | CHAR(2) | Reserved |
| 224 | E0 | BINARY(4) | Offset to list of TCP/IP port configurations |
| 228 | E4 | BINARY(4) | Length of TCP/IP port configuration entries |
| 232 | E8 | BINARY(4) | Number of TCP/IP port configurations |
| 236 | EC | BINARY(4) | Offset to list of TCP/IP route entries |
| 240 | F0 | BINARY(4) | Length of TCP/IP route entries |
| 244 | F4 | BINARY(4) | Number of TCP/IP route entries |
| 248 | F8 | BINARY(4) | Offset to list of TCP/IP name server entries |
| 252 | FC | BINARY(4) | Length of TCP/IP name server entries |
| 256 | 100 | BINARY(4) | Number of TCP/IP name server entries |
| 260 | 104 | CHAR(63) | TCP/IP host name |
| 323 | 143 | CHAR(1) | Reserved |
| 324 | 144 | CHAR(255) | TCP/IP domain name |
| 579 | 243 | CHAR(1) | Reserved |
| 580 | 244 | CHAR(10) | Message queue name |
| 590 | 24E | CHAR(10) | Message queue library name |
| 600 | 258 | CHAR(10) | Synchronize date and time |
| These fields repeat for each nonswitched line | CHAR(10) | Attached nonswitched line | |
| CHAR(10) | Line category | ||
| CHAR(10) | Port number | ||
| CHAR(10) | Line text description | ||
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Drive letter | ||
| CHAR(50) | Storage space text description | ||
| These fields repeat for each TCP/IP port configuration | CHAR(10) | TCP/IP port number | |
| CHAR(15) | Internet address | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Subnet mask | ||
| CHAR(1) | Reserved | ||
| BINARY(4) | MTU for port | ||
| These fields repeat for each TCP/IP route entry | CHAR(15) | Route destination | |
| CHAR(1) | Reserved | ||
| CHAR(15) | Route subnet mask | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Next hop | ||
| CHAR(1) | Reserved | ||
| These fields repeat for each TCP/IP name server | CHAR(15) | TCP/IP name server | |
| CHAR(1) | Reserved | ||
NWSD0500 Format
This format returns detailed information about a network server of category *AIX.
Note: Format NWSD0500 is no longer supported.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Returns everything from format NWSD0100 | |
| 104 | 68 | BINARY(4) | Offset to attached nonswitched lines |
| 108 | 6C | BINARY(4) | Number of attached nonswitched lines |
| 112 | 70 | BINARY(4) | Entry length of attached nonswitched lines |
| 116 | 74 | BINARY(4) | Offset to network storage spaces |
| 120 | 78 | BINARY(4) | Number of storage spaces |
| 124 | 7C | BINARY(4) | Entry length of storage spaces |
| 128 | 80 | CHAR(10) | Vary on wait |
| 138 | 8A | CHAR(10) | Resource name |
| 148 | 94 | CHAR(10) | Console buffer size |
| 158 | 9E | CHAR(10) | Delete server users |
| 168 | A8 | CHAR(10) | Set password rules |
| 178 | B2 | CHAR(10) | Synchronize date and time |
| 188 | BC | CHAR(4) | Reserved |
| 192 | C0 | BINARY(4) | Offset to list of TCP/IP port configurations |
| 196 | C4 | BINARY(4) | Length of TCP/IP port configuration entries |
| 200 | C8 | BINARY(4) | Number of TCP/IP port configurations |
| 204 | CC | CHAR(63) | TCP/IP host name |
| 267 | 10B | CHAR(1) | Reserved |
| 268 | 10C | CHAR(10) | Message queue name |
| 278 | 116 | CHAR(10) | Message queue library name |
| 288 | 120 | BINARY(4) | Default CCSID |
| 292 | 124 | CHAR(15) | AIX® version |
| 307 | 133 | CHAR(5) | Default locale |
| These fields repeat for each nonswitched line | CHAR(10) | Attached nonswitched line | |
| CHAR(10) | Line category | ||
| CHAR(10) | Port number | ||
| CHAR(10) | Line text description | ||
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Reserved | ||
| CHAR(50) | Storage space text description | ||
| CHAR(3) | Drive sequence number | ||
| CHAR(8) | Physical volume name | ||
| CHAR(15) | Volume group name | ||
| CHAR(14) | Level identifier | ||
| CHAR(1) | Remove link allowed | ||
| CHAR(1) | Reserved | ||
| These fields repeat for each TCP/IP port configuration | CHAR(10) | TCP/IP port number | |
| CHAR(15) | Internet address | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Subnet mask | ||
| CHAR(1) | Reserved | ||
| BINARY(4) | MTU for port | ||
NWSD0600 Format
This format returns detailed information about a network server of category *IXSVR or *WINDOWSNT.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| * | * | Returns everything from format NWSD0100 | |
| 0 | 0 | BINARY(4) | Offset to attached nonswitched lines |
| 4 | 4 | BINARY(4) | Number of attached nonswitched lines |
| 8 | 8 | BINARY(4) | Entry length of attached nonswitched lines |
| 12 | C | BINARY(4) | Offset to network storage spaces |
| 16 | 10 | BINARY(4) | Number of storage spaces |
| 20 | 14 | BINARY(4) | Entry length of storage spaces |
| 24 | 18 | CHAR(10) | Vary on wait |
| 34 | 22 | CHAR(10) | Resource name |
| 44 | 2C | CHAR(10) | Domain role |
| 54 | 36 | CHAR(4) | Language version |
| 58 | 3A | CHAR(10) | Reserved |
| 68 | 44 | CHAR(10) | Code page |
| 78 | 4E | CHAR(10) | Message queue name |
| 88 | 58 | CHAR(10) | Message queue library name |
| 98 | 62 | CHAR(10) | Synchronize date and time |
| 108 | 6C | BINARY(4) | Offset to list of TCP/IP port configurations |
| 112 | 70 | BINARY(4) | Length of TCP/IP port configuration entries |
| 116 | 74 | BINARY(4) | Number of TCP/IP port configurations |
| 120 | 78 | BINARY(4) | Offset to list of TCP/IP route entries |
| 124 | 7C | BINARY(4) | Length of TCP/IP route entries |
| 128 | 80 | BINARY(4) | Number of TCP/IP route entries |
| 132 | 84 | BINARY(4) | Offset to list of TCP/IP name server entries |
| 136 | 88 | BINARY(4) | Length of TCP/IP name server entries |
| 140 | 8C | BINARY(4) | Number of TCP/IP name server entries |
| 144 | 90 | CHAR(63) | TCP/IP host name |
| 207 | CF | CHAR(1) | Reserved |
| 208 | D0 | CHAR(255) | TCP/IP domain name |
| 463 | 1CF | CHAR(1) | Reserved |
| 464 | 1D0 | BINARY(4) | Offset to list of restricted device resources |
| 468 | 1D4 | BINARY(4) | Length of restricted device resource |
| 472 | 1D8 | BINARY(4) | Number of restricted device resource entries |
| 476 | 1DC | BINARY(4) | Offset to list of event logs |
| 480 | 1E0 | BINARY(4) | Length of event log |
| 484 | 1E4 | BINARY(4) | Number of event log entries |
| 488 | 1E8 | CHAR(10) | Configuration file name |
| 498 | 1F2 | CHAR(10) | Configuration file library name |
| 508 | 1FC | CHAR(10) | Install source storage size |
| 518 | 206 | CHAR(10) | Install source storage type |
| 528 | 210 | CHAR(2) | Install source storage ASP |
| 530 | 212 | CHAR(10) | System storage size |
| 540 | 21C | CHAR(10) | System storage type |
| 550 | 226 | CHAR(2) | System storage ASP |
| 552 | 228 | BINARY(4) | Offset to list of valid code pages for a language version |
| 556 | 22C | BINARY(4) | Entry length of valid code pages for a language version |
| 560 | 230 | BINARY(4) | Number of valid code pages for a language version |
| 564 | 234 | CHAR(10) | Resource type-model |
| 574 | 23E | CHAR(10) | System storage ASP name |
| 584 | 248 | BINARY(4) | System storage pool ID full |
| 588 | 24C | BINARY(4) | Install source pool ID full |
| 592 | 250 | CHAR(10) | Install source storage ASP name |
| 602 | 25A | CHAR(10) | Propagate Domain Users |
| 612 | 264 | BINARY(4) | Offset to list of cluster configuration |
| 616 | 268 | BINARY(4) | Entry length of cluster configuration |
| 620 | 26C | BINARY(4) | Number of cluster configurations |
| 624 | 270 | BINARY(4) | Offset to list of clustered servers |
| 628 | 274 | BINARY(4) | Entry length of clustered servers |
| 632 | 278 | BINARY(4) | Number of clustered servers |
| 636 | 27C | CHAR(10) | OS version |
| 646 | 286 | CHAR(10) | Shutdown timeout |
| 656 | 290 | CHAR(10) | Server operating system |
| 666 | 29A | CHAR(10) | Disable user profiles |
| 676 | 2A4 | BINARY(4) | Offset to serviceability options |
| 680 | 2A8 | BINARY(4) | Length of serviceability options |
| 684 | 2AC | BINARY(4) | Offset to list of allowed device resources |
| 688 | 2B0 | BINARY(4) | Length of allowed device resource |
| 692 | 2B4 | BINARY(4) | Number of allowed device resource entries |
| These fields repeat for each nonswitched line | CHAR(10) | Attached nonswitched line | |
| CHAR(10) | Line category | ||
| CHAR(10) | Port number | ||
| CHAR(50) | Line text description | ||
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Reserved | ||
| CHAR(50) | Storage space text description | ||
| CHAR(3) | Drive sequence number | ||
| CHAR(38) | Reserved | ||
| CHAR(2) | Auxiliary storage pool ID | ||
| CHAR(10) | Access mode | ||
| CHAR(10) | Storage link type | ||
| CHAR(10) | Auxiliary storage pool name | ||
| BINARY(4) | Auxiliary storage pool ID full | ||
| These fields repeat for each TCP/IP port configuration | CHAR(10) | TCP/IP port number | |
| CHAR(15) | Internet address | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Subnet mask | ||
| CHAR(1) | Reserved | ||
| BINARY(4) | MTU for port | ||
| CHAR(15) | Gateway address | ||
| CHAR(*) | Reserved | ||
| These fields repeat for each TCP/IP route entry | CHAR(15) | Route destination | |
| CHAR(1) | Reserved | ||
| CHAR(15) | Route subnet mask | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Next hop | ||
| CHAR(1) | Reserved | ||
| These fields repeats for each TCP/IP name server | CHAR(15) | TCP/IP name server | |
| CHAR(1) | Reserved | ||
| These fields repeats for each restricted device resource | CHAR(10) | Restricted device resource | |
| CHAR(2) | Reserved | ||
| These fields repeat for each cluster configuration | CHAR(10) | Cluster name | |
| CHAR(15) | Cluster domain name | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Quorum resource ASP | ||
| CHAR(10) | Cluster connection port | ||
| CHAR(15) | Cluster internet address | ||
| CHAR(15) | Cluster subnet mask | ||
| These fields repeat for each clustered server | CHAR(8) | Clustered server name | |
| CHAR(50) | Clustered server text description | ||
| CHAR(2) | Reserved | ||
| These fields repeats for each event log | CHAR(10) | Event log | |
| CHAR(2) | Reserved | ||
| These fields repeats for each code page valid for a language version | CHAR(10) | Code page for language version | |
| CHAR(2) | Reserved | ||
| This field is variable in length. | CHAR(*) | Serviceability options | |
| These fields repeats for each allowed device resource | CHAR(10) | Allowed device resource | |
| CHAR(2) | Reserved | ||
NWSD0700 Format
This format returns detailed information about a network server of category *GUEST.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| * | * | Returns everything from format NWSD0100 | |
| 0 | 0 | BINARY(4) | Offset to network storage spaces |
| 4 | 4 | BINARY(4) | Number of storage spaces |
| 8 | 8 | BINARY(4) | Entry length of storage spaces |
| 12 | C | CHAR(10) | Vary on wait |
| 22 | 16 | CHAR(10) | Resource name |
| 32 | 20 | CHAR(10) | Code page |
| 42 | 2A | CHAR(10) | Message queue name |
| 52 | 34 | CHAR(10) | Message queue library name |
| 62 | 3E | CHAR(10) | Synchronize date and time |
| 72 | 48 | BINARY(4) | Offset to list of restricted device resources |
| 76 | 4C | BINARY(4) | Length of restricted device resource |
| 80 | 50 | BINARY(4) | Number of restricted device resource entries |
| 84 | 54 | CHAR(10) | Partition name |
| 94 | 5E | CHAR(10) | IPL source |
| 104 | 68 | BINARY(4) | Offset to IPL stream file |
| 108 | 6C | BINARY(4) | Length of IPL stream file |
| 112 | 70 | BINARY(4) | Offset to IPL parameters |
| 116 | 74 | BINARY(4) | Length of IPL parameters |
| 120 | 78 | BINARY(4) | Offset to list of TCP/IP port configurations |
| 124 | 7C | BINARY(4) | Length of TCP/IP port configuration entries |
| 128 | 80 | BINARY(4) | Number of TCP/IP port configurations |
| 132 | 84 | BINARY(4) | Offset to list of TCP/IP route entries |
| 136 | 88 | BINARY(4) | Length of TCP/IP route entries |
| 140 | 8C | BINARY(4) | Number of TCP/IP route entries |
| 144 | 90 | BINARY(4) | Offset to list of TCP/IP name server entries |
| 148 | 94 | BINARY(4) | Length of TCP/IP name server entries |
| 152 | 98 | BINARY(4) | Number of TCP/IP name server entries |
| 156 | 9C | CHAR(63) | TCP/IP host name |
| 219 | DB | CHAR(1) | Reserved |
| 220 | DC | CHAR(255) | TCP/IP domain name |
| 475 | 1DB | CHAR(1) | Reserved |
| 476 | IDC | CHAR(10) | Shutdown timeout |
| 486 | 1E6 | CHAR(10) | Power control |
| 496 | 1F0 | BINARY(4) | Partition number |
| 500 | 1F4 | CHAR(96) | Partition name long |
| 596 | 254 | CHAR(10) | Server operating system |
| 606 | 25E | CHAR(10) | Shared pool identifier |
| 616 | 268 | BINARY(4) | System pool identifier |
| 620 | 26C | BINARY(4) | Offset to serviceability options |
| 624 | 270 | BINARY(4) | Length of serviceability options |
| 628 | 274 | BINARY(4) | Offset to list of allowed device resources |
| 632 | 278 | BINARY(4) | Length of allowed device resource |
| 636 | 27C | BINARY(4) | Number of allowed device resource entries |
| This field is variable in length. | CHAR(*) | IPL stream file | |
| This field is variable in length. | CHAR(*) | IPL parameters | |
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Reserved | ||
| CHAR(50) | Storage space text description | ||
| CHAR(3) | Drive sequence number | ||
| CHAR(38) | Reserved | ||
| CHAR(2) | Auxiliary storage pool ID | ||
| CHAR(10) | Access mode | ||
| CHAR(10) | Storage link type | ||
| CHAR(10) | Auxiliary storage pool name | ||
| BINARY(4) | Auxiliary storage pool ID full | ||
| These fields repeat for each TCP/IP port configuration | CHAR(10) | TCP/IP port number | |
| CHAR(15) | Internet address | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Subnet mask | ||
| CHAR(1) | Reserved | ||
| BINARY(4) | MTU for port | ||
| These fields repeat for each TCP/IP route entry | CHAR(15) | Route destination | |
| CHAR(1) | Reserved | ||
| CHAR(15) | Route subnet mask | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Next hop | ||
| CHAR(1) | Reserved | ||
| This field repeats for each TCP/IP name server | CHAR(15) | TCP/IP name server | |
| CHAR(1) | Reserved | ||
| This field repeats for each restricted device resource | CHAR(10) | Restricted device resource | |
| CHAR(2) | Reserved | ||
| This field is variable in length. | CHAR(*) | Serviceability options | |
| This field repeats for each allowed device resource | CHAR(10) | Allowed device resource | |
| CHAR(2) | Reserved | ||
NWSD0800 Format
This format returns detailed information about a network server of category *ISCSI.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| * | * | Returns everything from format NWSD0110 | |
| 0 | 0 | BINARY(4) | Offset to attached nonswitched lines |
| 4 | 4 | BINARY(4) | Number of attached nonswitched lines |
| 8 | 8 | BINARY(4) | Entry length of attached nonswitched lines |
| 12 | C | BINARY(4) | Offset to network storage spaces |
| 16 | 10 | BINARY(4) | Number of storage spaces |
| 20 | 14 | BINARY(4) | Entry length of storage spaces |
| 24 | 18 | CHAR(10) | Vary on wait |
| 34 | 22 | CHAR(10) | Resource name |
| 44 | 2C | CHAR(10) | Domain role |
| 54 | 36 | CHAR(4) | Language version |
| 58 | 3A | CHAR(10) | Code page |
| 68 | 44 | CHAR(10) | Message queue name |
| 78 | 4E | CHAR(10) | Message queue library name |
| 88 | 58 | CHAR(10) | Synchronize date and time |
| 98 | 62 | CHAR(2) | Reserved |
| 100 | 64 | BINARY(4) | Offset to list of TCP/IP port configurations |
| 104 | 68 | BINARY(4) | Length of TCP/IP port configuration entries |
| 108 | 6C | BINARY(4) | Number of TCP/IP port configurations |
| 112 | 70 | BINARY(4) | Offset to list of TCP/IP name server entries |
| 116 | 74 | BINARY(4) | Length of TCP/IP name server entries |
| 120 | 78 | BINARY(4) | Number of TCP/IP name server entries |
| 124 | 7C | CHAR(63) | TCP/IP host name |
| 187 | BB | CHAR(1) | Reserved |
| 188 | BC | CHAR(255) | TCP/IP domain name |
| 443 | 1BB | CHAR(1) | Reserved |
| 444 | 1BC | BINARY(4) | Offset to list of restricted device resources |
| 448 | 1C0 | BINARY(4) | Length of restricted device resource |
| 452 | 1C4 | BINARY(4) | Number of restricted device resource entries |
| 456 | 1C8 | BINARY(4) | Offset to list of event logs |
| 460 | 1CC | BINARY(4) | Length of event log |
| 464 | 1D0 | BINARY(4) | Number of event log entries |
| 468 | 1D4 | CHAR(10) | Configuration file name |
| 478 | 1DE | CHAR(10) | Configuration file library name |
| 488 | 1E8 | CHAR(10) | Install source storage size |
| 498 | 1F2 | CHAR(10) | Install source storage type |
| 508 | 1FC | CHAR(10) | System storage size |
| 518 | 206 | CHAR(10) | System storage type |
| 528 | 210 | BINARY(4) | Offset to list of valid code pages for a language version |
| 532 | 214 | BINARY(4) | Entry length of valid code pages for a language version |
| 536 | 218 | BINARY(4) | Number of valid code pages for a language version |
| 540 | 21C | CHAR(10) | System storage ASP name |
| 550 | 226 | CHAR(2) | Reserved |
| 552 | 228 | BINARY(4) | System storage pool ID full |
| 556 | 22C | BINARY(4) | Install source pool ID full |
| 560 | 230 | CHAR(10) | Install source storage ASP name |
| 570 | 23A | CHAR(10) | Propagate Domain Users |
| 580 | 244 | BINARY(4) | Offset to list of cluster configuration |
| 584 | 248 | BINARY(4) | Entry length of cluster configuration |
| 588 | 24C | BINARY(4) | Number of cluster configurations |
| 592 | 250 | BINARY(4) | Offset to list of clustered servers |
| 596 | 254 | BINARY(4) | Entry length of clustered servers |
| 600 | 258 | BINARY(4) | Number of clustered servers |
| 604 | 25C | CHAR(10) | OS version |
| 614 | 266 | CHAR(10) | Shutdown timeout |
| 624 | 270 | BINARY(4) | Offset to list of storage paths |
| 628 | 274 | BINARY(4) | Entry length of storage paths |
| 632 | 278 | BINARY(4) | Number of storage paths |
| 636 | 27C | BINARY(4) | Offset to list of virtual Ethernet paths |
| 640 | 280 | BINARY(4) | Entry length of virtual Ethernet paths |
| 644 | 284 | BINARY(4) | Number of virtual Ethernet paths |
| 648 | 288 | BINARY(4) | Removable media path |
| 652 | 28C | BINARY(4) | Default storage path |
| 656 | 290 | CHAR(10) | Communications message queue name |
| 666 | 29A | CHAR(10) | Communications message queue library name |
| 676 | 2A4 | CHAR(10) | NWS configuration connection security name |
| 686 | 2AE | CHAR(10) | NWS configuration connection security library name |
| 696 | 2B8 | CHAR(10) | NWS configuration remote name |
| 706 | 2C2 | CHAR(10) | NWS configuration remote library name |
| 716 | 2CC | BINARY(4) | Default IP security rule |
| 720 | 2D0 | BINARY(4) | Shutdown TCP port |
| 724 | 2D4 | BINARY(4) | Virtual Ethernet control port |
| 728 | 2D8 | BINARY(4) | Offset to list of multi-path group |
| 732 | 2DC | BINARY(4) | Entry length of multi-path group |
| 736 | 2E0 | BINARY(4) | Number of multi-path group |
| 740 | 2E4 | BINARY(4) | Activation timer |
| 744 | 2E8 | CHAR(72) | Multi path IQN |
| 816 | 330 | CHAR(10) | Disable user profiles |
| 826 | 33A | CHAR(10) | Shared pool identifier |
| 836 | 344 | BINARY(4) | System pool identifier |
| 840 | 348 | BINARY(4) | Offset to serviceability options |
| 844 | 34C | BINARY(4) | Length of serviceability options |
| 848 | 350 | BINARY(4) | Offset to list of allowed device resources |
| 852 | 354 | BINARY(4) | Length of allowed device resource |
| 856 | 358 | BINARY(4) | Number of allowed device resource entries |
| These fields repeat for each nonswitched line | CHAR(10) | Attached nonswitched line | |
| CHAR(10) | Line category | ||
| CHAR(10) | Port number | ||
| CHAR(50) | Line text description | ||
| These fields repeat for each network storage list | CHAR(10) | Storage space size | |
| CHAR(10) | Storage space name | ||
| CHAR(1) | Reserved | ||
| CHAR(50) | Storage space text description | ||
| CHAR(3) | Drive sequence number | ||
| CHAR(40) | Reserved | ||
| CHAR(10) | Access mode | ||
| CHAR(10) | Storage link type | ||
| CHAR(10) | Auxiliary storage pool name | ||
| BINARY(4) | Auxiliary storage pool ID full | ||
| BINARY(4) | Storage path number | ||
| These fields repeat for each TCP/IP port configuration | CHAR(10) | TCP/IP port number | |
| CHAR(15) | Internet address | ||
| CHAR(1) | Reserved | ||
| CHAR(15) | Subnet mask | ||
| CHAR(1) | Reserved | ||
| BINARY(4) | MTU for port | ||
| CHAR(15) | Gateway address | ||
| CHAR(*) | Reserved | ||
| These fields repeats for each TCP/IP name server | CHAR(15) | TCP/IP name server | |
| CHAR(1) | Reserved | ||
| These fields repeats for each restricted device resource | CHAR(10) | Restricted device resource | |
| CHAR(2) | Reserved | ||
| These fields repeats for each event log | CHAR(10) | Event log | |
| CHAR(2) | Reserved | ||
| These fields repeats for each code page valid for a language version | CHAR(10) | Code page for language version | |
| CHAR(2) | Reserved | ||
| These fields repeat for each cluster configuration | CHAR(10) | Cluster name | |
| CHAR(15) | Cluster domain name | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Quorum resource ASP | ||
| CHAR(10) | Cluster connection port | ||
| CHAR(15) | Cluster internet address | ||
| CHAR(15) | Cluster subnet mask | ||
| These fields repeat for each clustered server | CHAR(8) | Clustered server name | |
| CHAR(50) | Clustered server text description | ||
| CHAR(2) | Reserved | ||
| These fields repeat for each storage path | CHAR(10) | Network server host adapter name | |
| CHAR(10) | Storage path resource name | ||
| CHAR(2) | Storage path status | ||
| CHAR(72) | Storage path IQN | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Path number | ||
| BINARY(4) | Remote interface 1 rule | ||
| BINARY(4) | Remote interface 2 rule | ||
| BINARY(4) | Remote interface 3 rule | ||
| BINARY(4) | Remote interface 4 rule | ||
| These fields repeat for each virtual Ethernet path | CHAR(10) | Port number for virtual Ethernet | |
| CHAR(10) | Network server host adapter name | ||
| CHAR(10) | Virtual Ethernet path resource name | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | Remote interface 1 rule | ||
| BINARY(4) | Remote interface 2 rule | ||
| BINARY(4) | Remote interface 3 rule | ||
| BINARY(4) | Remote interface 4 rule | ||
| This field repeats for multi-path group | BINARY(4) | Multi path group number | |
| This field is variable in length. | CHAR(*) | Serviceability options | |
| These fields repeats for each allowed device resource | CHAR(10) | Allowed device resource | |
| CHAR(2) | Reserved | ||
Field Descriptions
Some of the fields in the various formats returned by this API are described in greater detail in the CRTNWSD command that was used to create the network server description object. They also are described in the online help for the CRTNWSD command. For these fields, the CL parameter keyword is specified in parentheses following the field name. The CL command name is specified in the field description.
In certain cases, numeric values are assigned by this API to represent character values for some of the returned fields. Where a numeric value is assigned, the numeric value and the equivalent character value are listed as an Exception in the following field descriptions.
Access mode. The access mode specified when linking the storage space to the network server description. Access modes include:
| *UPDATE | The storage is linked with exclusive update access. |
| *READ | The storage is linked with shareable read only access. |
| *SHRUPD | The storage is linked to a clustered server with shared read/write access. |
Activation timer. Specifies the amount of time (in seconds) the system will wait for the connection to be established to the remote system's service processor. (See the ACTTMR parameter in the CRTNWSD command.)
AIX version. The version of AIX that is installed on the storage space linked to the network server.
Allowed device resource (ALWDEVRSC). The allowed device resource names that can be used from the system by the network server. (See the ALWDEVRSC parameter in the CRTNWSD command.)
Attached nonswitched line. The name of a line that is associated with this network server.
Auxiliary storage pool ID. The auxiliary storage pool (ASP) identifier used to hold the network storage space.
This field returns blanks when Network server connection type is *ISCSI. Possible values are:
| -1 | A special value of -1 is returned if the size of this field is exceeded. Use the Auxiliary storage pool ID full field instead. |
| 1 | System auxiliary storage pool |
| 2-32 | Basic auxiliary storage pools |
| 33-99 | Independent auxiliary storage pools |
Auxiliary storage pool ID full. The auxiliary storage pool (ASP) identifier used to hold the network storage space. Possible values are:
| 1 | System auxiliary storage pool |
| 2-32 | Basic auxiliary storage pools |
| 33-255 | Independent auxiliary storage pools |
Auxiliary storage pool name. The name of the auxiliary storage pool (ASP) used to hold the network storage space. A value of *SYSBAS indicates the ASP is part of the system ASP (ASP number 1) or a basic ASP (ASP numbers 2-32).
Bytes available. The number of bytes of data available to be returned to the user.
Bytes returned. The number of bytes that were returned to the user. This is the lesser of the number of bytes available to be returned or the length of the receiver variable.
Cluster connection port. The name of the cluster connection port.
Cluster domain name. The domain name of the cluster.
Cluster internet address. The internet address of the cluster.
Cluster name. The name of the cluster.
Clustered server name. The name of the clustered network server.
Cluster subnet mask. The subnet mask being used with the cluster. The mask is in the form, nnn.nnn.nnn.nnn, where nnn is a decimal number that ranges from 0 through 255.
Clustered server text description. The brief description of the clustered network server.
Code page (CODEPAGE). The ASCII code page that represents the character set to be used by this network server. (See the CODEPAGE parameter in the CRTNWSD command.)
Code page for language version. Valid code page for a language version.
Communications message queue library name. The name of the communications message queue library to receive network server host adapter communications status messages.
Communications message queue name. The name of the message queue to receive network server host adapter communications status messages.(See the CMNMSGQ parameter in the CRTNWSD command.)
Configuration file library name. The name of the library that contains configuration data to be used in activating or further defining the server.
Configuration file name (CFGFILE). The name of the source file that contains configuration data to be used in activating or further defining the server. (See the CFGFILE parameter in the CRTNWSD command.)
Console buffer size. The maximum number of bytes to use for the AIX console message buffer.
Country or region code (CNTRYCODE). The country or region code that represents the character set to be used by this network server. The country or region code controls the format of dates.
Date information retrieved. The date that the information was provided by the API. It is returned as 7 characters in the form CYYMMDD, as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Default CCSID. The default coded character set identifier (CCSID) of AIX that is installed in the storage space linked to the network server. This information is updated when the network server is varied off or when the AIX update400 command is run.
Default IP security rule. The relative entry of the IP security rules (IPSECRULES) parameter defined in the NWS Configuration (NWSCFG) object of type *CNNSEC that is used as the default for all the remote ports security.
Exception:
- Value of -3 implies *NONE
(See the DFTSECRULE parameter in the CRTNWSD command.)
Default locale. The default locale of the network server. A locale is made up of the language, cultural data, and character sets used to identify a set of language conventions. This information is updated when the network server is varied off or when the AIX update400 command is run.
Default storage path. The default path that was specified on the network server description.
Exception:
- Value of -2 implies *MLTPTHGRP
(See the DFTSTGPTH parameter in the CRTNWSD command.)
Delete server users. Whether the system will delete user identities on the network server that were created by using the network server interfaces.
Disable user profiles(DSBUSRPRF). Specifies whether to disable the integrated servers user profiles when the corresponding IBM i user profiles are disabled. This field returns blanks when Server operating system is *ESX, *ESXE, *LINUX32 or *LINUX64. (See the DSBUSRPRF parameter in the CRTNWSD command.)
| *AUTO | Integrated server user profiles are disabled if corresponding IBM i user profiles are disabled. |
| *NO | Integrated server user profiles are not disabled if corresponding IBM i user profiles are disabled. |
Domain role (DMNROLE). The domain controller role that is performed by this network server. This field returns blanks when Server operating system is *ESX, *ESXE, *LINUX32 or *LINUX64. (See the DMNROLE parameter in the CRTNWSD command.)
Drive letter. The drive that is associated with this storage space for the network server.
Drive sequence number. The sequencing number assigned to a network storage space in either the static storage area or the dynamic storage area. Since there are two distinct disk link arrays, it is possible for storage in the dynamic storage area to have the same drive sequence number as storage linked in the static storage area.
Entry length of attached nonswitched lines. The entry length in bytes of each element in the list of attached nonswitched lines returned with this format. A value of zero is returned if the list is empty.
Entry length of cluster configuration. The entry length in bytes of each element in the list of cluster configuration.
Entry length of clustered servers. The entry length in bytes of each element in the list of clustered servers.
Entry length of multi-path group. The entry length in bytes of each element in the list of multi-path group.
Entry length of storage paths. The entry length in bytes of each element in the list of storage paths.
Entry length of storage spaces. The entry length in bytes of each element in the list of storage spaces.
Entry length of valid code pages for a language version. The entry length in bytes of each element in the list of valid code pages for a language version returned with this format.
Entry length of virtual Ethernet paths. The entry length in bytes of each element in the list of virtual Ethernet paths.
Event log (EVTLOG). The event log messages that are received from the server.
This field returns blanks when Server operating system is *ESX, *ESXE, *LINUX32 or *LINUX64. This field contains the following values:
| *SYS | The system event log messages are received. |
| *SEC | The security event log messages are received. |
| *APP | The application event log messages are received. |
(See the EVTLOG parameter in the CRTNWSD command.)
Gateway address. The internet address of the gateway for the port.
Exception:
- Value of blanks indicates no gateway address.
Group profile. The System i™ users who are authorized to log on to this network server.
Install source pool ID full (SVRSTGASP). The auxiliary storage pool (ASP) identifier used to hold the install source storage space. Possible values are:
| 0 | Auxiliary storage pool identifier unavailable. This occurs when the install source storage space is not found, is not linked to the network server, or when Server operating system is *ESX, *ESXE, or *AUX. |
| 1 | System auxiliary storage pool |
| 2-32 | Basic auxiliary storage pools |
| 33-255 | Independent auxiliary storage pools |
(See the SVRSTGASP parameter in the CRTNWSD command.)
Install source storage ASP (SVRSTGASP). The auxiliary storage pool (ASP) identifier used to hold the install source storage space. Possible values are:
| -1 | A special value of -1 is returned if the size of this field is exceeded. Use the Install source pool ID full field instead. |
| 0 | Auxiliary storage pool identifier unavailable. This occurs when the install source storage space is not found, is not linked to the network server, or when Server operating system is *ESX, *ESXE, or *AUX. |
| 1 | System auxiliary storage pool |
| 2-32 | User auxiliary storage pools |
| 33-99 | Independent auxiliary storage pools |
(See the SVRSTGASP parameter in the CRTNWSD command.)
Install source storage ASP name (STGASPDEV). The name of the auxiliary storage pool (ASP) used to hold the install source storage space. A value of *SYSBAS indicates the ASP is part of the system ASP (ASP number 1) or a basic ASP (ASP numbers 2-32). This field returns blanks when Server operating system is *ESX, *ESXE, or *AUX.
Install source storage size (SVRSTGSIZE). The size in megabytes of the drive that holds the files used to install the integrated server. A value of zero is returned if the storage space size is unknown, or when Server operating system is *ESX, *ESXE, or *AUX. (See the SVRSTGSIZE parameter in the CRTNWSD command.)
Install source storage type. The type of drive that holds the files used to install the server. This field returns blanks when Server operating system is *ESX or *ESXE. Possible storage types are:
| *SVRSTG | Server storage space object |
| *NWSSTG | Network server storage space |
| *UNKNOWN | Server storage space type is unknown. This occurs when the install source storage space is not found or is not linked to the network server. |
Internet address. The internet address assigned to each port.
IPL parameters (IPLPARM). A string of characters that will be passed to the load image at IPL time. It consists of commands or configuration information for the guest operating system. This field is specified in UCS-2 (CCSID 13488). The following special value also may be returned:
| *NONE | IPL parameters are not specified. |
(See the IPLPARM parameter in the CRTNWSD command.)
IPL source (IPLSRC). The source of the load image that the partition is started from. (See the IPLSRC parameter in the CRTNWSD command.)
IPL stream file (IPLSTMF). The path of the stream file containing the load image. This field is specified in UCS-2 (CCSID 13488). The following special value may also be returned:
| *NONE | IPL stream file is not specified. |
(See the IPLSTMF parameter in the CRTNWSD command.)
IPX description. The name of the IPX description.
Language version (LNGVER). The language version of the network server product.
(See the LNGVER parameter in the CRTNWSD command.)Length of event log. The length in bytes of each element in the list of event logs.
Length of allowed device resource. The length in bytes of each element in the list of allowed device resources.
Length of IPL parameters. The length, in Unicode characters, of the IPL parameter element.
Length of IPL stream file. The length, in Unicode characters, of the IPL stream file element.
Length of restricted device resource. The length in bytes of each element in the list of restricted device resources.
Length of serviceability options. The length, in Unicode characters, of the serviceability options element.
Length of TCP/IP name server entries. The length in bytes of each element in the list of TCP/IP name servers.
Length of TCP/IP port configuration entries. The length in bytes of each element in the list of TCP/IP port configuration entries.
Length of TCP/IP route entries. The length in bytes of each element in the list of TCP/IP route entries. A value of zero is returned if the list is empty.
Level identifier. The identifier assigned by the system to every storage spaces within a particular AIX volume group.
Line category. This value will be one of the following:
| *ETH | Ethernet |
| *TRN | Token Ring Network |
The category value is derived from the command that is used to create the line description.
Line name. The name of the line description.
Line text description. A brief description of the line.
Local IPX connection. Whether a connection is to be made to local IPX at the time that this network server is varied on.
Message queue library name. The name of the message queue library to receive server messages.
Message queue name (MSGQ). The name of the message queue to receive server messages. (See the MSGQ parameter in the CRTNWSD command.)
MTU for port. The maximum transmission unit (MTU) value specifies the maximum value in bytes that can be transmitted over the TCP/IP interface.
Multi path IQN. The iSCSI qualified name (IQN) associated with the multi path.
Multi path group number. The storage paths that represent the multi-path group. Possible values are:
| 1-4 | Relative storage paths. |
(See the MLTPTHGRP parameter in the CRTNWSD command.)
NetBIOS description. The name of the NetBIOS description.
Network server connection type (TYPE). The types of network server descriptions. Possible values follow:
| 5 | *WINDOWSNT - used for Windows server |
| 6 | *GUEST - used for a guest operating system running in a logical partition |
| 7 | *IXSVR - uses an Integrated xSeries® Server (IXS) or Integrated xSeries Adapter (IXA) connection, or for *AUX Operating System types, is an auxiliary integrated server. |
| 8 | *ISCSI - used for server using iSCSI connections |
(See the TYPE parameter in the CRTNWSD command.)
Network server host adapter name. The name of the network server host adapter device associated with this network server description.
Network server name (NWSD). The name of the network server description. (See the NWSD parameter in the CRTNWSD command.)
Next hop. The internet address of the next system (gateway) on the route.
Number of allowed device resource entries. The number of elements in the list of allowed device resources.
Number of attached nonswitched lines. The number of elements in the list of attached nonswitched lines that are returned with this format. A value of zero is returned if the list is empty.
Number of cluster configurations. The number of elements in the list of cluster configuration.
Number of clustered servers. The number of elements in the list of clustered servers.
Number of event log entries. The number of elements in the list of event logs.
Number of multi-path group. The number of elements in the list of multi-path group.
Number of restricted device resource entries. The number of elements in the list of restricted device resources.
Number of storage paths. The number of elements in the list of storage paths.
Number of storage spaces. The number of elements in the list of storage spaces.
Number of TCP/IP name server entries. The number of elements in the list of TCP/IP name server entries.
Number of TCP/IP port configurations. The number of elements in the list of TCP/IP port configurations.
Number of TCP/IP route entries. The number of elements in the list of TCP/IP route entries. A value of zero is returned if the list is empty.
Number of valid code pages for a language version. The number of elements in the list of valid code pages for a language version.
Number of virtual Ethernet paths. The number of elements in the list of virtual Ethernet paths.
NWS configuration connection security library name. The name of the NWS configuration connection security library.
NWS configuration connection security name. The name for the NWS configuration connection security description.
NWS configuration remote library name. The name for the remote network server configuration description library.
NWS configuration remote name. The NWS configuration name for the remote network server configuration description.
Offset to attached nonswitched lines. The offset in bytes to the first element in the list of attached nonswitched lines that are returned with this format. A value of zero is returned if the list is empty.
Offset to higher-level format. The offset in bytes to the network server specific information.
Offset to IPL parameters. The offset in bytes to the IPL parameters element.
Offset to IPL stream file. The offset in bytes to the IPL stream file element.
Offset to list of allowed device resources. The offset in bytes to the first element in the list of allowed device resources.
Offset to list of cluster configuration. The offset in bytes to the first element in the list of cluster configuration.
Offset to list of clustered servers. The offset in bytes to the first element in the list of clustered servers.
Offset to list of event logs. The offset in bytes to the first element in the list of event logs.
Offset to list of multi-path group. The offset in bytes to the first element in the list of multi-path group.
Offset to list of restricted device resources. The offset in bytes to the first element in the list of restricted device resources.
Offset to list of storage paths. The offset in bytes to the first element in the list of storage paths.
Offset to list of TCP/IP name server entries. The offset in bytes to the first element in the list of TCP/IP name server entries.
Offset to list of TCP/IP port configurations. The offset in bytes to the first element in the list of TCP/IP port configurations.
Offset to list of TCP/IP route entries. The offset in bytes to the first element in the list of TCP/IP route entries. A value of zero is returned if the list is empty.
Offset to list of valid code pages for a language version. The offset in bytes to the first element in the list of valid code pages for a language version.
Offset to list of virtual Ethernet paths. The offset in bytes to the first element in the list of virtual Ethernet paths.
Offset to network storage spaces. The offset in bytes to the first element in the list of network storage spaces.
Offset to serviceability options. The offset in bytes to the serviceability options element.
Online at IPL (ONLINE). Whether or not the network server is varied on automatically when the system is turned on. (See the ONLINE parameter in the CRTNWSD command.)
OS version. Version of the operating system currently installed on the network server.
Path number. The relative path number used for the storage path.
Partition name (PARTITION). The name of the logical partition to be used by this network server. This field has been replaced by Partition name long. (See the PARTITION parameter in the CRTNWSD command.)
Partition name long (PARTITION). The name of the logical partition to be used by this network server. The name can be up to 48 characters in length. This field is specified in UCS-2 (CCSID 13488).(See the PARTITION parameter in the CRTNWSD command.) The following special value may also be returned:
| *NONE | Partition name is not specified. |
Partition number (PTNNBR). The number of the logical partition to be used by this network server. (See the PTNNBR parameter in the CRTNWSD command.) Possible values are:
| 0 | Partition number is not specified. |
| 1-254 | Partition number is specified. |
Physical volume name. The physical volume name of the storage space as it is defined on the network server. The physical volume name is the name that the AIX operating system assigns to a network server storage space when it is defined to the system.
Pool identifier (POOL). Specifies the shared storage pool this integrated server should use. (See the SHRPOOL parameter in the CRTNWSD command.)
| *BASE | The specified pool definition is defined to be the base system pool. |
| *SHRPOOL1 - *SHRPOOL60 | The specified pool definition is defined to be a shared pool. |
Port number (PORTS). The port number on the network server to which a line is physically attached.
| *INTERNAL | The network server internal token ring is configured. |
| *VRTETHPTP | The network server virtual Ethernet point to point port is configured. |
| *VRTETH0 | Virtual Ethernet port 0 is configured. |
| *VRTETH1 | Virtual Ethernet port 1 is configured. |
| *VRTETH2 | Virtual Ethernet port 2 is configured. |
| *VRTETH3 | Virtual Ethernet port 3 is configured. |
| *VRTETH4 | Virtual Ethernet port 4 is configured. |
| *VRTETH5 | Virtual Ethernet port 5 is configured. |
| *VRTETH6 | Virtual Ethernet port 6 is configured. |
| *VRTETH7 | Virtual Ethernet port 7 is configured. |
| *VRTETH8 | Virtual Ethernet port 8 is configured. |
| *VRTETH9 | Virtual Ethernet port 9 is configured. |
(See the PORTS parameter in the CRTNWSD command.)
Port number for virtual Ethernet (VRTETHPTH). The port the virtual Ethernet path will use.
| *VRTETHPTP | The network server virtual Ethernet point to point port is configured. |
| *VRTETH0 | Virtual Ethernet port 0 is configured. |
| *VRTETH1 | Virtual Ethernet port 1 is configured. |
| *VRTETH2 | Virtual Ethernet port 2 is configured. |
| *VRTETH3 | Virtual Ethernet port 3 is configured. |
| *VRTETH4 | Virtual Ethernet port 4 is configured. |
| *VRTETH5 | Virtual Ethernet port 5 is configured. |
| *VRTETH6 | Virtual Ethernet port 6 is configured. |
| *VRTETH7 | Virtual Ethernet port 7 is configured. |
| *VRTETH8 | Virtual Ethernet port 8 is configured. |
| *VRTETH9 | Virtual Ethernet port 9 is configured. |
(See the VRTETHPTH parameter in the CRTNWSD command.)
Power control (PWRCTL). Specifies whether the partition associated with the network server description will be powered down when the network server description is varied offline.(See the PWRCTL parameter in the CRTNWSD command.)
| *YES | IPL power down of the partition associated with the network server description will occur when the network server description is varied offline. |
| *NO | IPL power down of the partition associated with the network server description will not occur when the network server description is varied offline. |
Propagate domain users (PRPDMNUSR). Allows users to determine if domain user enrollment should be allowed on a particular NWSD.
This field returns blanks when Server operating system is *ESX, *ESXE, *LINUX32 or *LINUX64.
| *YES | Allow propagation of domain user enrollment for this NWSD. |
| *NO | Do not allow propagation of domain user enrollment for this NWSD. |
(See the PRPDMNUSR parameter in the CRTNWSD command.)
Quorum resource ASP. The Quorum resource ASP name.
Remote interface 1 rule. The remote interface security rule. The possible values are:
| 1-16 | Security rules. |
Exception:
- Value of -1 implies *DFTSECRULE
- Value of -3 implies *NONE
- When the Network server host adapter name is *NONE, this field may be non-zero and does not apply.
(See the STGPTH and VRTETHPTH parameter in the CRTNWSD command.)
Remote interface 2 rule. The remote interface security rule. The possible values are:
| 1-16 | Security rules. |
Exception:
- Value of -1 implies *DFTSECRULE
- Value of -3 implies *NONE
- When the Network server host adapter name is *NONE, this field may be non-zero and does not apply.
(See the STGPTH and VRTETHPTH parameter in the CRTNWSD command.)
Remote interface 3 rule. The remote interface security rule. The possible values are:
| 1-16 | Security rules. |
Exception:
- Value of -1 implies *DFTSECRULE
- Value of -3 implies *NONE
- When the Network server host adapter name is *NONE, this field may be non-zero and does not apply.
(See the STGPTH and VRTETHPTH parameter in the CRTNWSD command.)
Remote interface 4 rule. The remote interface security rule. The possible values are:
| 1-16 | Security rules. |
Exception:
- Value of -1 implies *DFTSECRULE
- Value of -3 implies *NONE
- When the Network server host adapter name is *NONE, this field may be non-zero and does not apply.
(See the STGPTH and VRTETHPTH parameter in the CRTNWSD command.)
Removable media path. The storage path that the removable media uses.
(See the RMVMEDPTH parameter in the CRTNWSD command.)
Remove link allowed. Whether this storage space can be unlinked using the Remove Network Server Storage Link (RMVNWSSTGL) command while this network server description is varied on.
Reserved. An ignored field.
Resource name (RSRCNAME). The unique name that is assigned by the system to the physical equipment (in this case, a communications port) attached to the system. (See the RSRCNAME parameter in the CRTNWSD command.)
Exception:
- Value of *AUTO means a hardware resource is determined by the partition associated with a *GUEST network server.
- Value of *NONE means a hardware resource is not associated with this network server.
Resource type-model. The hardware resource type for the file server used when the server was installed originally.
Exception:
- Value of *UNKNOWN means the file server hardware resource type is determined the first time the network server description is varied on.
Restricted device resource (RSTDDEVRSC). The restricted device resource name that cannot be used from the system by the network server. (See the RSTDDEVRSC parameter in the CRTNWSD command.)
Route destination. The internet address of the remote system.
Route subnet mask. The subnet mask being used with the route. The mask is in the form, nnn.nnn.nnn.nnn, where nnn is a decimal number that ranges from 0 through 255.
Server operating system. The type of operating system installed on the network server. The possible values are:
| *AIXPPC | AIX on POWER® operating system. |
| *AUX | An auxiliary integrated server operating system. |
| *ESX | VMware® ESX server. |
| *ESXE | VMware ESX embedded server. |
| *LINUX32 | Linux® x86-32 operating system. |
| *LINUX64 | Linux x86-64 operating system. |
| *LINUXPPC | Linux on POWER operating system. |
| *OPSYS | IBM i on POWER operating system. |
| *UNKNOWN | The operating system is undefined. |
| *WIN32 | Windows x86-32 operating system. |
| *WIN64 | The operating system is Windows 64 bit. |
Serviceability options (SRVOPT). A string of characters that specifies serviceability options. This parameter allows serviceability options to be provided and is intended to be used under the direction of a service provider. This field is specified in UCS-2 (CCSID 13488). The following special value also may be returned:
| *NONE | Serviceability options are not specified. |
(See the SRVOPT parameter in the CRTNWSD command.)
Set password rules. Whether the default rules for passwords on the network server are set to the IBM i system values and defaults or are allowed to use the default rules for passwords of the network server.
Shutdown TCP port. The TCP port to use for shutdown.(See the SHUTDPORT parameter in the CRTNWSD command.)
Shutdown timeout (SHUTDTIMO). Time in minutes to wait for the servers operating system to shutdown before forcing the hardware offline. (See the SHUTDTIMO parameter in the CRTNWSD command.)
Start NetBIOS. Whether the NetBIOS protocol is activated when the network server is varied on.
Start TCP/IP. Whether the TCP/IP protocol is activated when the network server is varied on.
Storage link type. The type of link that was specified when the storage space link was added to the network server description. The possible links are:
| *NO | The storage is linked as static storage. |
| *YES | The storage is linked as dynamic storage. |
| *QR | The storage is linked as a quorum resource for a clustered server. |
| *SHR | The storage is linked as a shared disk for a clustered server. |
Storage path (STGPTH). Specifies the storage paths to be used by the storage spaces. The information consists of three parts that include the network server host description, the storage path resource, and the security rules for this path. (See the STGPTH parameter in the CRTNWSD command.)
Storage path IQN. Specifies storage path iSCSI qualified name.
Exception:
- When the Network server host adapter name is *NONE, this field is set to blanks.
Storage path number. Specifies the storage path number in the network server description (NWSD) that this storage space uses. (See the STGPTHNBR parameter in the ADDNWSSTGL command.)
Exception:
- Value of -1 implies *DFTSTGPTH
- Value of -2 implies *MLTPTHGRP
Storage path resource name. The resource name for this storage path.
Exception:
- Value of *NONE means a hardware resource is not associated with this storage path.
- When the Network server host adapter name is *NONE, this field is set to blanks.
Storage path status. The status of storage path resource. Possible values are:
| 00 | Vary-Off |
| 01 | Ready |
| 02 | Active |
| 03 | Degraded |
| 04 | Fail |
Exception:
- When the Network server host adapter name is *NONE, this field is set to blanks.
Storage space name. The text that is entered to describe the storage space.
Storage space size. The size that is associated with this storage space for the network server.
Storage space text description. The names of existing client storage spaces.
Subnet mask. The subnet mask that is assigned to each internet address. The mask is in the form, nnn.nnn.nnn.nnn, where nnn is a decimal number that ranges from 0 through 255.
Synchronize date and time (SYNCTIME). Whether the system has synchronized the network server date and time with the system date and time. This field returns blanks when Server operating system is *ESX or *ESXE.
| *YES | IBM i will synchronize the integrated server date and time with the IBM i date and time. |
| *NO | IBM i only synchronizes the integrated server date and time with the IBM i date and time once when the network server description is varied on. |
| *NONE | IBM i will never synchronize the integrated server date and time with the IBM i date and time. |
(See the SYNCTIME parameter in the CRTNWSD command.)
System pool identifier. Specifies the system pool that was assigned to this integrated server at varied on. The system-related pool identifier for each of the system pools that currently has main storage allocated to it.
| 0 | No pool is assigned as the network server description is not active. |
| 2 | The specified pool definition is defined to be the base system pool. |
| 3 - 64 | The specified pool definition is defined to be a shared pool. |
System storage ASP (SVRSTGASP). The auxiliary storage pool (ASP) identifier used to hold the system storage space. Possible values are:
| -1 | A speci-al value of -1 is returned if the size of this field is exceeded. Use the System storage pool ID full field instead. |
| 0 | Auxiliary storage pool identifier unavailable. This occurs when the system storage space is not found, is not linked to the network server, or when Server operating system is *ESXE or *AUX. |
| 1 | System auxiliary storage pool |
| 2-32 | User auxiliary storage pools |
| 33-99 | Independent auxiliary storage pools |
(See the SVRSTGASP parameter in the CRTNWSD command.)
System storage ASP name. The name of the auxiliary storage pool (ASP) used to hold the system storage space. A value of *SYSBAS indicates the ASP is part of the system ASP (ASP number 1) or a basic ASP (ASP numbers 2-32). This field returns blanks when Server operating system is *ESXE or *AUX.
System storage pool ID full (SVRSTGASP). The auxiliary storage pool (ASP) identifier used to hold the system storage space. Possible values are:
| 0 | Auxiliary storage pool identifier unavailable. This occurs when the system storage space is not found, is not linked to the network server, or when Server operating system is *ESXE or *AUX. |
| 1 | System auxiliary storage pool |
| 2-32 | Basic auxiliary storage pools |
| 33-255 | Independent auxiliary storage pools |
(See the SVRSTGASP parameter in the CRTNWSD command.)
System storage size (SVRSTGSIZE). The size in megabytes of the drive on which the integrated server is installed. A value of zero is returned if the storage space size is unknown, or when Server operating system is *ESXE or *AUX. (See the SVRSTGSIZE parameter in the CRTNWSD command.)
System storage type. The type of storage space on which the integrated server is installed. This field returns blanks when Server operating system is *ESXE or *AUX. Possible storage types are:
| *SVRSTG | Server storage space |
| *NWSSTG | Network server storage space |
| *UNKNOWN | Server storage space type is unknown. This occurs when the install source storage space is not found or is not linked to the network server. |
TCP/IP domain name (TCPDMNNAME). The local domain name that is associated with the network server. (See the TCPDMNNAME parameter in the CRTNWSD command.)
TCP/IP host name (TCPHOSTNAM). The short form of the host name to be associated with the network server. (See the TCPHOSTNAM parameter in the CRTNWSD command.)
TCP/IP name server (TCPNAMSVR). The internet address of the name server system that is used by the network server. (See the TCPNAMSVR parameter in the CRTNWSD command.)
TCP/IP port configuration (TCPPORTCFG). The TCP/IP configuration values specific to a port on a network server. The information consists of four parts that include the network server port, the internet address assigned to the port, the subnet mask of the port, and the maximum transmission unit. (See the TCPPORTCFG parameter in the CRTNWSD command.)
TCP/IP port number. The TCP/IP port number on the network server.
| *INTERNAL | The network server internal token ring is configured. |
| *VRTETHPTP | The network server virtual Ethernet point to point port is configured. |
| *VRTETH0 | Virtual Ethernet port 0 is configured. |
| *VRTETH1 | Virtual Ethernet port 1 is configured. |
| *VRTETH2 | Virtual Ethernet port 2 is configured. |
| *VRTETH3 | Virtual Ethernet port 3 is configured. |
| *VRTETH4 | Virtual Ethernet port 4 is configured. |
| *VRTETH5 | Virtual Ethernet port 5 is configured. |
| *VRTETH6 | Virtual Ethernet port 6 is configured. |
| *VRTETH7 | Virtual Ethernet port 7 is configured. |
| *VRTETH8 | Virtual Ethernet port 8 is configured. |
| *VRTETH9 | Virtual Ethernet port 9 is configured. |
(See the TCPPORTCFG parameter in the CRTNWSD command.)
TCP/IP route (TCPRTE). The TCP/IP route identifies routes from the network server to remote systems. The route consists of three parts that include the route destination, the subnet mask, and the next hop interface. (See the TCPRTE parameter in the CRTNWSD command.)
Text description (TEXT). A brief description of the network server and its location. (See the TEXT parameter in the CRTNWSD command.)
Time information retrieved. The time that the information was provided by the API. It is returned as 6 characters in the form HHMMSS where:
| HH | Hour |
| MM | Minute |
| SS | Second |
Vary on wait (VRYWAIT). Whether the line is varied on synchronously or asynchronously. (See the VRYWAIT parameter in the CRTNWSD command.)
Exception:
- Value of -15 implies *NOWAIT
Virtual Ethernet control port. The TCP port used by the remote system for virtual Ethernet control. (See the VRTETHCTLP parameter in the CRTNWSD command.)
Virtual Ethernet paths (VRTETHPTH). The virtual Ethernet path that can be used by the Ethernet line descriptions that are attached to network server. The information consists of four parts that include the port number, network server host adapter description, the virtual Ethernet path resource, and the security rules for this path. (See the LANPATH parameter in the CRTNWSD command.)
Virtual Ethernet path resource name. The resource name for this virtual Ethernet path.
Volume group name. The volume group to which this network server storage space is assigned on the network server. A volume group is a collection of one or more physical volumes. Every physical volume must be assigned to a volume group before it can be used.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF2625 E | Not able to allocate object &1. |
| CPF2634 E | Not authorized to object &1. |
| CPF26AE E | Network server description &1 not found. |
| CPF2704 E | Line description &1 not found. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8125 E | Line description &4 damaged. |
| CPF814C E | Network server description &4 damaged. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V4R2