List Network Interfaces (QtocLstNetIfc) API
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Error Code | I/O | Char(*) |
Service Program: QTOCNETSTS
Threadsafe: Yes
The List Network Interfaces (QtocLstNetIfc) API returns a list of all logical TCP/IP interfaces with details. This API returns all IPv4 logical interfaces using one output format name, and all IPv6 logical interfaces using a different output format name.
As of V6R1, TCP/IP stack must not necessarily be active for this API to be called, so TCP84C0 will no longer be issued. This API can be used to retrieve the information stored in the TCP/IP configuration files.
Authorities and Locks
- User Space Library Authority
- *EXECUTE
- User Space Authority
- *CHANGE
- User Space Lock
- *SHRNUP
Required Parameter Group
- Qualified user space name
- INPUT; CHAR(20)
The user space that is to receive the created list. The first ten characters contain the user space name, and the second ten characters contain the name of the library in which the user space is located. 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 logical interface information to be returned. The format names supported are:
NIFC0100 Detailed information about each TCP/IPv4 network interface. See NIFC0100 Format for details on the format. NIFC0200 Detailed information about each TCP/IPv6 network interface. See NIFC0200 Format for details on the format.
- 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 Interface Lists
To request a list of all logical interfaces, use format NIFC0100.
The interface description list consists of:
- A user area
- A generic header
- An input parameter section
- A header section
- A list data section:
- NIFC100 format, or
- NIFC0200 format
For details about the user area and generic header, see User spaces. For details about the remaining items, see the following sections.
When you retrieve list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see Examples: APIs and exit programs.
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 | ||
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 | ||
Format of Returned Connection Data
To retrieve the list of TCP/IPv4 network interfaces, request format NIFC0100, and you will get a repeating list of NIFC0100 tables, each one returning information about a single IPv4 network interface. To retrieve the list of TCP/IPv6 network interfaces, request format NIFC0200, and you will get a repeating list of NIFC0200 tables, each one returning information about a single IPv6 network interface.
NIFC0100 Format
The following information about each TCP/IPv4 logical interface is returned for the NIFC0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(15) | Internet address |
| 15 | F | CHAR(1) | Reserved |
| 16 | 10 | BINARY(4) | Internet address binary |
| 20 | 14 | CHAR(15) | Network address |
| 35 | 23 | CHAR(1) | Reserved |
| 36 | 24 | BINARY(4) | Network address binary |
| 40 | 28 | CHAR(10) | Network name |
| 50 | 32 | CHAR(10) | Line description |
| 60 | 3C | CHAR(10) | Interface name |
| 70 | 46 | CHAR(2) | Reserved |
| 72 | 48 | BINARY(4) | Interface status |
| 76 | 4C | BINARY(4) | Interface type of service |
| 80 | 50 | BINARY(4) | Interface MTU |
| 84 | 54 | BINARY(4) | Interface line type |
| 88 | 58 | CHAR(15) | Host address |
| 103 | 67 | CHAR(1) | Reserved |
| 104 | 68 | BINARY(4) | Host address binary |
| 108 | 6C | CHAR(15) | Interface subnet mask |
| 123 | 7B | CHAR(1) | Reserved |
| 124 | 7C | BINARY(4) | Interface subnet mask binary |
| 128 | 80 | CHAR(15) | Directed broadcast address |
| 143 | 8F | CHAR(1) | Reserved |
| 144 | 90 | BINARY(4) | Directed broadcast address binary |
| 148 | 94 | CHAR(8) | Change date |
| 156 | 9C | CHAR(6) | Change time |
| 162 | A2 | CHAR(15) | Associated local interface |
| 177 | B1 | CHAR(3) | Reserved |
| 180 | B4 | BINARY(4) | Associated local interface binary |
| 184 | B8 | BINARY(4) | Change status |
| 188 | BC | BINARY(4) | Packet rules |
| 192 | C0 | BINARY(4) | Automatic start |
| 196 | C4 | BINARY(4) | TRLAN bit sequencing |
| 200 | C8 | BINARY(4) | Interface type |
| 204 | CC | BINARY(4) | Proxy ARP enabled |
| 208 | D0 | BINARY(4) | Proxy ARP allowed |
| 212 | D4 | BINARY(4) | Configured MTU |
| 216 | D8 | CHAR(24) | Network name - full |
| 240 | F0 | CHAR(24) | Interface name - full |
| 264 | 108 | CHAR(50) | Alias name |
| 314 | 13A | CHAR(2) | Reserved |
| 316 | 13C | BINARY(4) | Alias name CCSID |
| 320 | 140 | BINARY(4) | Offset to preferred interface list |
| 324 | 144 | BINARY(4) | Number of entries in preferred interface list |
| 328 | 148 | BINARY(4) | Length of one preferred interface list entry |
| 332 | 14C | CHAR(50) | Interface description |
| 382 | 17E | CHAR(2) | Reserved |
| 384 | 180 | BINARY(4) | DHCP created |
| 388 | 184 | BINARY(4) | DHCP dynamic DNS updates |
| 392 | 188 | BINARY(8) | DHCP lease expiration |
| 400 | 190 | CHAR(8) | DHCP lease expiration - date |
| 408 | 198 | CHAR(6) | DHCP lease expiration - time |
| 414 | 19E | BINARY(8) | DHCP lease obtained |
| 422 | 1A6 | CHAR(8) | DHCP lease obtained - date |
| 430 | 1AE | CHAR(6) | DHCP lease obtained - time |
 436 |
1B4 | BINARY(4) | Use DHCP unique identifier |
| 440 | 1B8 | CHAR(15) | DHCP server IP address |
| 455 | 1C7 | CHAR(1) | Reserved |
| 456 | 1C8 | BINARY(4) | Virtual LAN identifier |
| 460 | 1CC | BINARY(4) | Preferred interface default route |
| This field repeats for each preferred interface list entry | CHAR(*) | Preferred interface list entry (See Format of Preferred Interface List Entry for more information ) | |
Format of Preferred Interface List Entry
The preferred interface list entry describes the data returned for each entry in the preferred interface list of the NIFC0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(15) | Preferred interface Internet address |
| 15 | F | CHAR(1) | Reserved |
| 16 | 10 | BINARY(4) | Preferred interface Internet address binary |
| 20 | 14 | CHAR(*) | Reserved |
Field Descriptions
Alias name. Name given to the interface to use as an alternate to the IP address.
Alias name CCSID. Coded character set ID for the alias name.
Associated local interface. The Internet address, in dotted decimal notation, of the local interface that has been associated with this interface. The following is a special value:
| *NONE | No association has been made between this interface and another local interface. |
Associated local interface binary. Binary representation of the associated local interface. The following is a special value:
| 0 | No association has been made between this interface and another local interface. |
Automatic start. Whether the interface is started automatically when the TCP/IP stack is activated. Possible values are:
| 0 | NO. This interface is not started automatically. |
| 1 | YES. This interface is started automatically. |
Change date. The date of the most recent change to this interface in the dynamic tables used by the TCP/IP protocol stack. It is returned as 8 characters in the form YYYYMMDD, where:
| YYYY | Year |
| MM | Month |
| DD | Day |
Change status. The status of the most recent change to this interface in the dynamic tables used by the TCP/IP protocol stack.
| 1 | Add interface request processed |
| 2 | Change interface request processed |
| 3 | Start interface request processed |
| 4 | End interface request processed |
Change time. The time of the most recent change to this interface in the dynamic tables used by the TCP/IP protocol stack. It is returned as 6 characters in the form HHMMSS, where:
| HH | Hour |
| MM | Minute |
| SS | Second |
Configured MTU. The configured maximum transmission unit value specified for this interface. The following is a special value:
| 0 | LIND. The interface is not active currently and the MTU was specified as *LIND. |
DHCP created. Specifies whether this interface was created using Dynamic Host Configuration Protocol (DHCP) or not. Possible values are:
| 1 | This interface was created using DHCP |
| 0 | This interface was not created using DHCP |
DHCP dynamic DNS updates. Specifies whether dynamic updates to Domain Name System (DNS) tables are enabled or not. Possible values are:
| 1 | DNS updates are enabled. |
| 0 | DNS updates are disabled. |
DHCP lease expiration. This field specifies the date and time when the DHCP lease will expire.
DHCP lease expiration - date. This field specifies the date when the DHCP lease will expire.
DHCP lease expiration - time. This field specifies the time when the DHCP lease will expire.
DHCP lease obtained.This field specifies the date and time when the DHCP lease was obtained or renewed. This is a system time-stamp.
DHCP lease obtained - date. This field specifies the date when the DHCP lease was obtained or renewed.
DHCP lease obtained - time. This field specifies the time when the DHCP lease was obtained or renewed.
DHCP server IP address. The Internet address, in dotted
decimal notation, of the DHCP server from which the DHCP lease was obtained
or renewed. This field will contain blanks for interfaces that are not
created by DHCP.
Directed broadcast address. The Internet address, in dotted decimal notation, used to broadcast to all systems attached to the same network or subnetwork as this interface. The following is a special value:
| *NONE | The interface is attached to a network that does not support a broadcast operation. |
Directed broadcast address binary. Binary representation of the directed broadcast address. The following is a special value:
| 0 | The interface is attached to a network that does not support a broadcast operation. |
Host address. Host portion of the Internet address, in dotted decimal notation, as determined by the subnet mask specified for this interface.
Host address binary. Binary representation of the host address.
Interface line type. Type of line used by an interface. The following link protocols are supported:
| -1 | OTHER - IPI - An Internet Protocol (IP) over Internetwork Pack Exchange (IPX) interface. IPS - An Internet Protocol (IP) over SNA interface. Note: As of V5R2, IP over IPX is no longer supported. |
| -2 | NONE - Line is not defined. This is used for the following interfaces: *LOOPBACK, *VIRTUALIP, *OPC. There is no line type value for these interfaces. |
| -3 | ERROR - This value is displayed if any system errors other than those for *NOTFND are received while trying to determine the link type for an interface. |
| -4 | NOTFND - Not found. This value is displayed if the line description object for this interface cannot be found. |
| 1 | ELAN - Ethernet local area network protocol. |
| 2 | TRLAN - Token-ring local area network protocol. |
| 3 | FR - Frame relay network protocol. |
| 4 | ASYNC - Asynchronous communications protocol. |
| 5 | PPP - Point-to-point Protocol. |
| 6 | WLS - Wireless local area network protocol. |
| 7 | X.25 - X.25 protocol. |
| 8 | DDI - Distributed Data Interface protocol. |
| 9 | TDLC - Twinaxial Datalink Control. Used for TCP/IP over Twinax. |
| 10 | L2TP (Virtual PPP) - Layer Two Tunneling protocol. |
| 12 | VETH - Virtual Ethernet protocol. |
| 13 | PPPoE - Point-to-Point over Ethernet protocol. |
Interface description. Configured free form comment field about this interface.
Interface MTU. Maximum transmission unit value specified for this interface. The following are special values:
| -1 | OTHER. IPI - An Internet Protocol (IP) over Internetwork Pack Exchange (IPX) interface. IPS - An Internet Protocol (IP) over SNA interface. Note: As of V5R2, IP over IPX is no longer supported. |
| 0 | LIND - The interface is not active currently and the MTU was specified as *LIND. |
Interface name. The first 10 characters of the name of this interface.
Interface name - full. The complete 24 character interface name.
Interface status. Current status of this logical interface.
| 0 | Inactive - The interface has not been started. The interface is not active. |
| 1 | Active - The interface has been started and is running. |
| 2 | Starting - The system is processing the request to start this interface. |
| 3 | Ending - The system is processing the request to end this interface. |
| 4 | RCYPND - An error with the physical line associated with this interface was detected by the system. The line description associated with this interface is in the recovery pending (RCYPND) state. |
| 5 | RCYCNL - A hardware failure has occurred and the line description associated with this interface is in the recovery canceled (RCYCNL) state. |
| 6 | Failed - The line description associated with this interface has entered the failed state. |
| 7 | Failed (TCP) - An error was detected in the IBM® TCP/IP Vertical Licensed Internal Code. |
| 8 | DOD - Point-to-Point (PPP) Dial-on-Demand. |
| 9 | Acquiring - The interface address is being acquired from the DHCP server. |
Interface subnet mask. The subnet mask for the network, subnet, and host address fields of the Internet address, in dotted decimal notation, that defines the subnetwork for an interface.
Interface subnet mask binary. Binary representation of the interface subnet mask.
Interface type. The interface types are:
| 0 | Broadcast capable |
| 1 | Non-broadcast capable |
| 2 | Unnumbered network |
Interface type of service. The way in which the Internet hosts and routers should make trade-offs between throughput, delay, reliability and cost. The following are special values:
| -1 | OTHER - IPI - An Internet Protocol (IP) over Internetwork Pack Exchange (IPX) interface. IPS - An Internet Protocol (IP) over SNA interface. Note: As of V5R2, IP over IPX is no longer supported. |
| 1 | NORMAL - Used for delivery of datagrams. |
| 2 | MINDELAY - Prompt delivery of datagrams with the minimize delay indication. |
| 3 | MAXTHRPUT - Datagrams with maximize throughput indication. |
| 4 | MAXRLB - Datagrams with maximize reliability indication. |
| 5 | MINCOST - Datagram with minimize monetary cost indication. |
Internet address. The Internet address, in dotted decimal notation, of an interface.
Internet address binary. Binary representation of the Internet address.
Length of one preferred interface list entry. The length of a preferred interface list entry. For virtual interfaces, a length of zero means that a preferred interface list is not being used. For other types of interfaces, this field is set to zero.
Line description Name of the communications line description that identifies the physical network associated with an interface. The following are special values:
| *IPI | This interface is used by Internet Protocol (IP)
over Internetwork Packet Exchange (IPX).
Note: As of V5R2, IP over IPX is no longer supported. |
| *IPS | This interface is used by Internet Protocol (IP) over SNA. |
| *LOOPBACK | This is a loopback interface. Processing associated with a loopback interface does not extend to a physical line. |
| *VIRTUALIP | The virtual interface is a circuitless interface. It is used in conjunction with the associated local interface (LCLIFC) when adding standard interfaces. |
| *OPC | This interface is attached to the optical bus (OptiConnect). |
Network address. Internet address, in dotted decimal notation, of the IP network or subnetwork to which the interface is attached.
Network address binary. Binary representation of the network address.
Network name. The first 10 characters of the name of the network that this interface is a part of.
Network name - full. The complete 24 character name of the network that this interface is a part of.
Number of entries in preferred interface list. The number of entries in the preferred interface list. For virtual interfaces, zero means that a preferred interface list is not being used. For other types of interfaces, this field is set to zero.
Offset to preferred interface list. The offset from the start of the user space to the beginning of the preferred interface list. For virtual interfaces, zero means that a preferred interface list is not being used. For other types of interfaces, this field is set to zero.
Packet rules. The kind of packet rules data available for a particular line.
| -1 | OTHER - An unknown Packet rules value. |
| 0 | None - No filters and no NAT are loaded for the line specified. |
| 1 | NAT - NAT is enabled for this line. |
| 2 | Filters - Filters are defined for this line. |
| 3 | Filters and NAT - NAT enabled and filters defined. |
| 4 | Filters and IPSec - Filters and IPSec filters are defined for this line. |
| 5 | NAT and Filters and IPSec - NAT enabled and Filters and IPsec filters defined. |
Preferred interface list entry. Specifies information about an interface in the preferred interface list. The order in which the list entries are returned is also the order in which the system uses the interfaces as Proxy Agents.
Preferred interface Internet address. The Internet address, in dotted decimal notation, of an interface in the preferred interface list.
Preferred interface Internet address binary. The binary representation of an interface Internet address in the preferred interface list.
Preferred interface default route. This field describes whether the preferred proxy interfaces are based on the system's default route. Possible values are:
| 0 | The default route is not used to determine the preferred interface. |
| 1 | The default route is used to determine the preferred interface. |
Proxy ARP allowed. This field applies to Opticonnect (*OPC)
and Virtual Ethernet
interfaces only. For those types of interfaces, this field
indicates whether Proxy ARP has been configured to be allowed or not
allowed.
| 0 | NO - Proxy ARP not allowed. |
| 1 | YES - Proxy ARP allowed. |
| 2 | Unsupported - Proxy ARP allowed field is not supported by this interface. |
Proxy ARP enabled. Whether Proxy ARP is currently active for this interface. Proxy ARP allows physically distinct separate networks to appear as if they are a single logical network. It provides connectivity between physically separate network without creating any new logical networks and without updating any route tables.
| 0 | NO - Proxy ARP not enabled. |
| 1 | YES - Proxy ARP enabled. |
Reserved. An ignored field.
TRLAN bit sequencing. The order the Address Resolution Protocol (ARP) puts bits into the hardware address for Token Ring. Possible values are:
| 1 | MSB - The most significant bit is placed first. |
| 2 | LSB - The least significant bit is placed first. |
Use DHCP unique identifier. Whether the DHCP unique identifier (DUID) is used as the
client identification for the Dynamic Host Configuration Protocol (DHCP) or not. Possible
values are:
| 0 | NO - The hardware (MAC) address is used for the client ID. |
| 1 | YES - The DHCP unique identifier is used for the client ID. |
Virtual LAN identifier. The virtual LAN to which this interface belongs according to IEEE standard 802.1Q. This field is only valid for interfaces defined for Ethernet lines.
The following are possible returned values:
| 0 | NONE - No virtual LAN identifier is associated with this interface. |
| 1 - 4094 | The virtual LAN identifier associated with this
interface. |
NIFC0200 Format
The following information about each TCP/IPv6 logical interface is returned for the NIFC0200 format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(45) | Internet IPv6 address |
| 45 | 2D | CHAR(3) | Reserved |
| 48 | 30 | CHAR(16) | Internet IPv6 address binary |
| 64 | 40 | CHAR(3) | Interface prefix length |
| 67 | 43 | CHAR(1) | Reserved |
| 68 | 44 | BINARY(4) | Interface prefix length binary |
| 72 | 48 | BINARY(4) | Address type |
| 76 | 4C | BINARY(4) | Address state |
| 80 | 50 | BINARY(8) | Address preferred lifetime |
| 88 | 58 | CHAR(8) | Address preferred lifetime expiration date |
| 96 | 60 | CHAR(6) | Address preferred lifetime expiration time |
| 102 | 66 | CHAR(2) | Reserved |
| 104 | 68 | BINARY(8) | Address valid lifetime |
| 112 | 70 | CHAR(8) | Address valid lifetime expiration date |
| 120 | 78 | CHAR(6) | Address valid lifetime expiration time |
| 126 | 7E | CHAR(10) | Line name |
| 136 | 88 | BINARY(4) | Interface line type |
| 140 | 8C | CHAR(50) | Interface description |
| 190 | BE | CHAR(45) | Network IPv6 address |
| 235 | EB | CHAR(1) | Reserved |
| 236 | EC | CHAR(16) | Network IPv6 address binary |
| 252 | FC | CHAR(45) | Host IPv6 address |
| 297 | 129 | CHAR(3) | Reserved |
| 300 | 12C | CHAR(16) | Host IPv6 address binary |
| 316 | 13C | BINARY(4) | Interface status |
| 320 | 140 | BINARY(4) | Automatic start |
| 324 | 144 | BINARY(4) | Packet rules |
| 328 | 148 | BINARY(4) | Interface source |
| 332 | 14C | BINARY(4) | Duplicate address detection transmits |
| 336 | 150 | BINARY(4) | Multicast - number of references |
| 340 |
154 | BINARY(4) | Virtual LAN identifier |
| 344 | 158 | CHAR(8) | Change date |
| 352 | 160 | CHAR(6) | Change time |
| 358 | 166 | CHAR(2) | Reserved |
| 360 | 168 | BINARY(4) | Interface description CCSID |
| 364 | 16C | BINARY(4) | MTU - configured |
| 368 | 170 | BINARY(4) | MTU - current |
| 372 | 174 | BINARY(4) | Duplicate address detection maximum transmits |
| 376 | 178 | CHAR(50) | Alias name |
| 426 | 1AA | CHAR(6) | Reserved |
| 432 | 1B0 | BINARY(4) | Alias Name CCSID |
| 436 | 1B4 | BINARY(4) | On-link |
| 440 | 1B8 | BINARY(4) | Address class |
| 444 | 1BC | BINARY(4) | Offset to preferred physical interface list |
| 448 | 1C0 | BINARY(4) | Number of entries in preferred physical interface list |
| 452 | 1C4 | BINARY(4) | Length of one preferred physical interface list entry |
| 456 | 1C8 | BINARY(8) | DHCP lease obtained |
| 464 | 1D0 | CHAR(8) | DHCP lease obtained - date |
| 472 | 1D8 | CHAR(6) | DHCP lease obtained - time |
| 478 | 1DE | CHAR(30) | DHCP server unique identifier |
| 508 | 1FC | BINARY(4) | DHCP server unique identifier length |
| 512 | 200 | CHAR(10) | Current proxy agent line |
| 522 | 20A | CHAR(2) | Reserved |
| 524 | 20C | BINARY(4) | Current proxy agent line virtual LAN identifier |
| This field repeats for each preferred physical interface list entry | CHAR(*) | Preferred physical interface list entry (See Format of Preferred Physical Interface List Entry for more information.) | |
Format of Preferred Physical Interface List Entry
The preferred physical interface list entry describes the data returned for each entry in the preferred physical interface list of the NIFC0200 format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Preferred physical interface name |
| 10 | A | CHAR(2) |
Reserved |
| 12 | C | BINARY(4) | Virtual LAN identifier |
| 16 | 10 | ||
Field Descriptions
Address class. The class of IPv6 address that is assigned to this network interface.
Possible values are:
| 1 | Public - the interface is a public one. |
| 2 | Temporary - the interface is a temporary one used for privacy extensions. |
Address preferred lifetime. The length of time that a "valid" address is preferred, in seconds. When the preferred lifetime expires, the address becomes Deprecated. See the Address State field description for more information. Valid values range from 0 through 4294967295 seconds. Negative values indicate that the Address preferred lifetime expired that number of seconds ago.
The following are special values:
| -1000000000 | Infinite - this address has an infinite preferred lifetime. |
| -1000000001 | Not Applicable - this address is not in the Preferred address state, so this field does not apply. |
Address preferred lifetime expiration date. The date when this address will no longer be preferred. If the Address preferred lifetime expiration date and time are in the future, the address is still preferred. If the Address preferred lifetime expiration date and time are in the past, then this address is no longer preferred. The Address preferred lifetime expiration date is returned as 8 characters in the form YYYYMMDD.
The meaning of the characters is as follows:
| YYYY | Year |
| MM | Month |
| DD | Day |
The following are special values:
| 00000000 | Infinite - this address has an infinite preferred lifetime which never expires. |
| 00000001 | Not Applicable - this address is not in the Preferred address state, so this field does not apply. |
Address preferred lifetime expiration time. The time when this address will no longer be in the preferred state. If the Address preferred lifetime expiration date and time are in the future, the address is still preferred. If the Address preferred lifetime expiration date and time are in the past, then this address is no longer preferred. The Address preferred lifetime expiration time is returned as 6 characters in the form HHMMSS.
The meaning of the characters is as follows:
| HH | Hour |
| MM | Minute |
| SS | Second |
The following are special values:
| 000000 | Infinite - this address has an infinite preferred lifetime which never expires. |
| 000001 | Not Applicable - this address is not in the preferred address state, so this field does not apply. |
Address state. The current state of this IPv6 address. This field is no longer available and will always be set to 4.
Possible value is:
| 4 | Preferred - an address assigned to a physical interface whose use by upper layer protocols is unrestricted. Preferred addresses may be used as the source (or destination) address of packets sent from (or to) the physical interface. |
Address type. The type of IPv6 address that is assigned to this network interface.
Possible values are:
| 1 | Unicast - an identifier for a single interface. A packet sent to a unicast address is delivered to the interface identified by that address. |
| 2 | Multicast - an identifier for a set of interfaces (typically belonging to different nodes). A packet sent to a multicast address is delivered to all interfaces identified by that address. |
| 3 | Anycast - an identifier for a set of interfaces (typically belonging to different nodes). A packet sent to an anycast address is delivered to one of the interfaces identified by that address (the "nearest" one, according to the routing protocols' measure of distance). |
Address valid lifetime. The length of time, in seconds, that an address remains in a "valid" state (Preferred or Deprecated). When the valid lifetime expires, the address becomes Expired. See the Address State field description for more information. Valid values range from 0 through 4294967295 seconds. Negative values indicate that the Address valid lifetime expired that number of seconds ago.
The following are special values:
| -1000000000 | Infinite - this address has an infinite valid lifetime. |
| -1000000001 | Not Applicable - this address is not in a valid address state, so this field does not apply. |
Address valid lifetime expiration date. The date when this address will expire or did expire. If the Address valid lifetime expiration date and time are in the future, the address has not expired yet. If the Address valid lifetime expiration date and time are in the past, then this address has expired and is still being returned for a short period of time to indicate that the interface ceased to function because its valid lifetime expired. The Address valid lifetime expiration date is returned as 8 characters in the form YYYYMMDD.
The meaning of the characters is as follows:
| YYYY | Year |
| MM | Month |
| DD | Day |
The following are special values:
| 00000000 | Infinite - this address has an infinite valid lifetime which never expires. |
| 00000001 | Not Applicable - this address is not in a valid address state, so this field does not apply. |
Address valid lifetime expiration time. The time when this address will expire or did expire. If the Address valid lifetime expiration date and time are in the future, the address has not expired yet. If the Address valid lifetime expiration date and time are in the past, then this address has expired and is still being returned for a short period of time to indicate that the interface ceased to function because its valid lifetime expired. The Address valid lifetime expiration time is returned as 6 characters in the form HHMMSS.
The meaning of the characters is as follows:
| HH | Hour |
| MM | Minute |
| SS | Second |
The following are special values:
| 000000 | Infinite - this address has an infinite valid lifetime which never expires. |
| 000001 | Not Applicable - this address is not in a valid address state, so this field does not apply. |
Alias name. Name given to interface to use as an alternate to the IP address.
Alias name CCSID. Coded character set ID for the alias name.
Automatic start. Whether the interface is started automatically when the TCP/IPv6 stack is activated. Possible values are:
| 0 | NO. This interface is not started automatically. |
| 1 | YES. This interface is started automatically. |
Change date. The date of the most recent change to this interface in the dynamic tables used by the TCP/IPv6 protocol stack. It is returned as 8 characters in the form YYYYMMDD, where:
| YYYY | Year |
| MM | Month |
| DD | Day |
Change time. The time of the most recent change to this interface in the dynamic tables used by the TCP/IPv6 protocol stack. It is returned as 6 characters in the form HHMMSS, where:
| HH | Hour |
| MM | Minute |
| SS | Second |
Current proxy agent line. Name of the communication line description that is used with the IPv6 interface for virtual IP address (VIPA) proxy Neighbor Discovery. The following is a special value:
| *NONE | No association has been made between this interface and another physical interface. |
Current proxy agent line virtual LAN identifier. The virtual LAN to which the proxy agent line
belongs according to IEEE standard 802.1Q.
The following are possible returned values:
| 0 | NONE - No virtual LAN identifier is associated with the current proxy agent line. |
| 1 - 4094 | The virtual LAN identifier associated with the current proxy agent line. |
DHCP lease obtained. This field specifies the date and time when the DHCP lease was obtained or renewed. This is a system time-stamp.
DHCP lease obtained - date. This field specifies the date when the DHCP lease was obtained or renewed.
DHCP lease obtained - time. This field specifies the time when the DHCP lease was obtained or renewed.
DHCP server unique identifier. This field specifies the DHCP unique identifier (DUID) of the DHCP server from which the IP address was obtained.
DHCP server unique identifier length. The length of the server's DHCP unique DHCP identifier.
Duplicate address detection maximum transmits. Specifies the maximum number of Duplicate Address Detection (DAD) transmissions the stack will send out on the interface.
Duplicate address detection transmits. Specifies the number of Duplicate Address Detection (DAD) transmissions the stack has sent out on this interface.
Note: As of V5R4, this data is no longer available and is always set to 0.
Host IPv6 address. Host portion of the Internet address, in IPv6 address format, as determined by the prefix length configured for this interface. This field is NULL padded.
Host IPv6 address binary. Binary representation of the host IPv6 address. Even though this field is defined as a character field, a binary IPv6 address is returned in it.
Interface description. Configured free form comment field about this interface.
Interface description CCSID. Coded character set ID for the interface description field.
Interface line type. Type of line used by the interface. The following link protocols are supported:
| -1 | OTHER |
| -2 | NONE - Line is not defined. This value is used for the following interfaces: *LOOPBACK, *VIRTUALIP. There is no line type value for this interface. |
| -3 | ERROR - This value is displayed if any system errors other than those for *NOTFND are received while trying to determine the link type for an interface. |
| -4 | NOTFND - Not found. This value is displayed if the line description object for this interface cannot be found. |
| 1 | ELAN - Ethernet local area network protocol. |
| 5 | PPP - Point-to-point Protocol. |
| 10 | L2TP (Virtual PPP) - Layer Two Tunneling Protocol. |
| 12 | VETH - Virtual Ethernet protocol. |
| 13 | PPPoE - Point-to-Point over Ethernet protocol. |
Interface prefix length. The prefix length defines how many bits of the interface IPv6 address are in the prefix. It is a zoned decimal number which specifies how many of the left-most bits of the address make up the prefix. The prefix length is used to generate network and host addresses. This field is NULL padded.
Interface prefix length binary. Binary representation of the interface prefix length.
Interface source Specifies how this interface was added to the TCP/IPv6 stack.
Possible values are:
| 1 | Stateless - the interface was added to the stack by the IPv6 stateless autoconfiguration mechanism. |
| 2 | Stateful - the interface was added to the stack by the IPv6 stateful configuration mechanism (that is, DHCPv6). |
| 3 | Manual - the interface was added to the stack by manual configuration. |
| 4 | Loopback - the interface was added to the stack as the loopback interface. |
Interface status. Current status of this logical interface.
| 0 | Inactive - The interface has not been started. The interface is not active. |
| 1 | Active - The interface has been started and is running. |
| 2 | Starting - The system is processing the request to start this interface. |
| 3 | Ending - The system is processing the request to end this interface. |
| 4 | RCYPND - An error with the physical line associated with this interface was detected by the system. The line description associated with this interface is in the recovery pending (RCYPND) state. |
| 5 | RCYCNL - A hardware failure has occurred and the line description associated with this interface is in the recovery canceled (RCYCNL) state. |
| 6 | Failed - The line description associated with this interface has entered the failed state. |
| 7 | Failed (TCP) - An error was detected in the IBM TCP/IP Vertical Licensed Internal Code. |
Internet IPv6 address. The Internet address, in IPv6 address format, of the interface. The following is a special value:
| *IP6SAC | This is an IPv6 SAC created interface. |
Internet IPv6 address binary. Binary representation of the Internet IPv6 address. Even though this field is defined as a character field, a binary IPv6 address is returned in it.
Length of one preferred physical interface list entry. The length of a preferred physical interface list entry.
Line name. Name of the communications line description that identifies the physical network associated with an interface. This field is blank-padded.
The following are special values:
| *LOOPBACK | This is the IPv6 loopback interface. Processing associated with a loopback interface does not extend to a physical line. |
| *VIRTUALIP | The virtual interface is a circuitless interface. It is used in conjunction with the associated local interface (LCLIFC) when adding standard interfaces. |
MTU - configured. The configured maximum transmission unit (MTU) value specified for this interface.
The following is a special value:
| 0 | LIND - The MTU was configured as *LIND, the MTU size is the maximum frame size found in the line description object associated with this interface. |
MTU - current. Maximum transmission unit (MTU) value currently in effect for this interface.
The following is a special value:
| 0 | LIND - The interface is not active currently and the MTU was configured as *LIND. |
Multicast - number of references. The number of Sockets clients that have joined this multicast group.
The following is a special value:
| -1 | This interface is not a Multicast address and this field does not apply. |
Note: As of V5R4, this data is no longer available and is always set to 0.
Network IPv6 address. Internet address, in IPv6 address format, of the IPv6 network or subnetwork to which the interface is attached. This field is NULL padded.
Network IPv6 address binary. Binary representation of the network IPv6 address. Even though this field is defined as a character field, a binary IPv6 address is returned in it.
Number of entries in preferred physical interface list. The number of entries in the preferred physical interface list.
Offset to preferred physical interface list. The offset from the start of the user space to the beginning of the preferred physical interface list.
On-link. Whether or not this interface and all IPv6 addresses with the same prefix are on the same link. Possible values are:
| 0 | Off-link - Addresses with the same prefix are not assumed to be on the same link. |
| 1 | On-link - Addresses with the same prefix are assumed to be on the same link and directly reachable. |
Packet rules. The kind of packet rules data available for the particular line this interface is associated with.
| -1 | OTHER - An unknown Packet rules value. |
| 0 | None - No filters and no NAT are loaded for the line specified. |
| 1 | NAT - NAT is enabled for this line. |
| 2 | Filters - Filters are defined for this line. |
| 3 | Filters and NAT - NAT enabled and filters defined. |
| 4 | Filters and IPSec - Filters and IPSec filters are defined for this line. |
| 5 | NAT and Filters and IPSec - NAT enabled and Filters and IPsec filters defined. |
Preferred physical interface name. Name of a communications line description in the preferred physical interface list.
Reserved. An ignored field.
Virtual LAN identifier. The virtual LAN to which this interface belongs according to
IEEE standard 802.1Q. This field is only valid for interfaces defined for Ethernet lines.
The following are possible returned values:
| 0 | NONE - No virtual LAN identifier is associated with this interface. |
| 1 - 4094 | The virtual LAN identifier associated with this
interface. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| TCP84C5 E | API error listing TCP/IP Network Status list information. |
| TCP84C6 E | Internal operations error - RESULT &1 CC &2 RC &3 ERRNO &4. |
| TCP84C9 I | Information returned incomplete. |
| CPF0F03 E | Error in retrieving the user space that was created by the caller. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1E E | Required parameter &1 omitted. |
| 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. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| 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. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V5R1
| Top | Communications APIs | APIs by category |