List Physical Interface Data (QtocLstPhyIfcDta) API

  Required Parameter Group:

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 Physical Interface Data (QtocLstPhyIfcDta) API returns a list of physical interfaces and detailed TCP/IP related data for each one. Depending on which output format is requested, IPv4 and also IPv6 information can be requested for each physical interface.

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 receives the information, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name. 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 space information to be returned. The format names supported are:

IFCD0100 Basic physical interface data and detailed IPv4 specific data. See IFCD0100 Format for details on the format.
IFCD0200 IPv4 Filter and IPSec Physical interface data. See IFCD0100 Format and IFCD0200 Format for details on the format.
IFCD0300 Detailed IPv6 specific physical interface data. See IFCD0100 Format and IFCD0300 Format for details on the format.
IFCD0400 IPv6 Filter and IPSec Physical interface data. See IFCD0100 Format and IFCD0400 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 Physical Interface Lists

To request a list of TCP/IP data for all physical interfaces, use format IFCD0100. For detailed information about Filter and IPSec physical interface data in addition to the IFCD0100 format data, use format IFCD0200.

The physical interface description list consists of:

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
10 A CHAR(10) User space library name used
20 14    


Format of Returned Connection Data

To retrieve basic Physical interface data, and IPv4 specific statistics about each physical interface, use format IFCD0100. To retrieve IPv4 Filter and IPSec statistics about each physical interface, in addition to format IFCD0100 information, use format IFCD0200. To retrieve IPv6 specific information and statistics about each physical interface, in addition to format IFCD0100 information, use format IFCD0300. To retrieve IPv6 Filter and IPSec statistics about each physical interface, in addition to format IFCD0100 information, use format IFCD0400.


IFCD0100 Format

The following data about a physical interface is returned for the IFCD0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 BINARY(4) Line type
4 4 BINARY(4) Packet rules
8 8 BINARY(8) Total bytes received
16 10 BINARY(8) Total bytes sent
24 18 BINARY(4) Total unicast packets received
28 1C BINARY(4) Total non-unicast packets received
32 20 BINARY(4) Total inbound packets discarded
36 24 BINARY(4) Total unicast packets sent
40 28 BINARY(4) Total non-unicast packets sent
44 2C BINARY(4) Total outbound packets discarded
48 30 BINARY(4) Physical interface status
52 34 CHAR(10) Line description
62 3E CHAR(17) Physical address
79 4F CHAR(8) Date - retrieved
87 57 CHAR(6) Time - retrieved
93 5D CHAR(3) Reserved
96 60 BINARY(4) Offset to additional information
100 64 BINARY(4) Length of additional information
104 68 BINARY(4) Internet protocol version
108 6C    


Field Descriptions

Date - retrieved. Date when information is retrieved and valid. Format: YYYYMMDD, where:

YYYY Year
MM Month
DD Day

Internet protocol version. The version of the Internet Protocol (IP) that is currently in use on this line.

Possible values are:

1 IPv4
2 IPv6
3 IPv4 & IPv6

Length of additional information. The length in bytes of additional information returned that is not part of format IFCD0100.

Line description. Each TCP/IP interface is associated with a physical network. This field displays the name of the communications line description that identifies the physical network associated with an interface. In the case of a frame relay line, it displays the frame relay NWI name.

The following special values may also be displayed:

*IPI This interface is used by Internet Protocol (IP) over Internetwork Packet Exchange (IPX). A specific physical line is not associated with an interface used by IP over IPX (IPI).

Note: As of V5R2, IP over IPX is no longer supported.

*IPS The interface is used by Internet Protocol (IP) over SNA. A specific physical line is not associated with an interface used by IP over SNA (IPS).
*LOOPBACK The interface is a loopback interface. Processing associated with a loopback interface does not extend to a physical line. There is no line description associated with a loopback address.
*VIRTUALIP The virtual interface is a circuitless interface. It is used in conjunction with the associated local interface (LCLIFC) when adding standard interfaces. This special value is used to accommodate any of the following cases:
  1. Load balancing. This is the means of having a fixed source IP address regardless of which interface the traffic is being distributed.
  2. Frame-relay multi-access network to define the local network IP address. This allows for multiple virtual circuits to share the same IP network.
  3. Alternate method of network access translation (NAT). This eliminates the need for a NAT box by assigning a globally unique single IP address directly to the box without the need to define an entire network.
  4. Unnumbered networks. This provides a means of associating a local source IP address for an unnumbered point-to-point network.
*OPC This special value is used if you are adding an OptiConnect interface over TCP/IP. This interface is attached to the optical bus (OptiConnect).
*TNLCFG64 This special value means this line description is a Configured 6-4 (IPv6 over IPv4) tunneling line. IPv6 Neighbor Discovery does not work over a Configured tunnel, so you don't get the benefit of stateless autoconfiguration.

Note: As of V5R4, this value is no longer supported.

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).
Note: As of V5R2, IP over IPX is no longer supported.
IPS - An Internet Protocol (IP) over SNA interface. WLS - Wireless local area network protocol. TDLC - Twinaxial Datalink Control. Used for TCP/IP over Twinax.
-2 NONE - Line is not defined. There is no line type value for these interfaces.
-3 ERROR - This value is displayed if any system errrors 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. This value is rather associated with a frame relay NWI than with a line.
4 ASYNC - Asynchronous communications protocol.
5 PPP - Point-to-point Protocol.
6 X.25 - X.25 protocol.
7 DDI - Distributed Data Interface.
8 OPC - OptiConnect interface.
9 LOOPBACK - Loopback interface.
10 IPv6 Tunneling Line - Any kind of IPv6 over IPv4 tunnel.

Note: As of V5R4, this value is no longer supported.

11 PPPoE - Point-to-Point over Ethernet interface.

Offset to additional information. The offset in bytes to the rest of the information if a format other than IFCD0100 is requested.

Packet rules.Indicates what kind of packet rules data is available for a particular line.

0 None - No NAT and no filters are loaded for the line specified.
1 NAT - NAT is enabled for this line.
2 Filters - Filters are defined for this line.
3 NAT and Filters - 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.

Physical address. The MAC address of the interface. Format: XX:XX:XX:XX:XX:XX, where 'X' is a hexadecimal digit.

Physical interface status. The current operational state of the physical interface (line).

0 Unknown - The status of this physical interface is unknown.
1 Active - The physical interface is operational.
2 Inactive - The physical interface is not operational.
3 Failed - The desired state of the physical interface is active, but it is currently in the inactive state.
4 Starting - The system is processing the request to start this physical interface.
5 Ending - The system is processing the request to start this physical interface.
6 Recovery Pending - An error has been detected with this physical interface and the system is recovering.
7 Recovery Canceled - An error has been detected with this physical interface and system recovery has been canceled.

Reserved. An ignored field.

Time - retrieved. Time when information is retrieved and valid. Format: HHMMSS, in 24 hour time, where:

HH Hour
MM Minute
SS Second

Total bytes received. The total number of bytes received on the interface, including framing characters.

Total bytes sent. The total number of bytes transmitted out of the interface, including framing characters.

Total inbound packets discarded. The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space.

Total non-unicast packets received. The number of non-unicast (that is, broadcast or multicast) packets delivered to a higher-layer protocol.

Total non-unicast packets sent. The total number of packets that higher-level protocols requested be transmitted to a non-unicast (that is, broadcast or multicast) address, including those that were discarded or not sent.

Total outbound packets discarded. The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

Total unicast packets received. The number of unicast packets delivered to a higher-layer protocol.

Total unicast packets sent. The total number of packets that higher-level protocols requested to be transmitted to a unicast address, including those that were discarded or not sent.


IFCD0200 Format

This format returns detailed IPv4 Filter and IPSec Physical interface data in addition to data about a physical interface from the IFCD0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Offset Type Field
Dec Hex
0 0
Returns everything from format IFCD0100.
Decimal and hexadecimal offsets are reached by using the offset to additional information field in format IFCD0100. CHAR(8) Date - filter rules loaded or unloaded
CHAR(6) Time - filter rules loaded or unloaded
CHAR(2) Reserved
BINARY(8) Outbound filter packets discarded
BINARY(8) Outbound filter packets permitted
BINARY(8) Outbound packets non-filtered
BINARY(8) Outbound IPSec packets
BINARY(8) Outbound IPSec packets discarded - no connection
BINARY(8) Outbound IPSec packets discarded - ondemand
BINARY(8) Outbound IPSec packets discarded - VPN NAT
BINARY(8) Outbound IPSec packets discarded - other
BINARY(8) Outbound NAT packets
BINARY(8) Outbound NAT packets discarded
BINARY(8) Outbound packets discarded - other
BINARY(8) Outbound packets discarded - rule exception
BINARY(8) Inbound IPSec packets
BINARY(8) Inbound IPSec packets permitted
BINARY(8) Inbound IPSec packets discarded - no connection
BINARY(8) Inbound IPSec packets discarded - no AH/ESP
BINARY(8) Inbound IPSec packets discarded - ondemand
BINARY(8) Inbound IPSec packets discarded - VPN NAT
BINARY(8) Inbound IPSec packets discarded - anti-replay fail
BINARY(8) Inbound IPSec packets discarded - selector mismatch
BINARY(8) Inbound IPSec packets discarded - mode mismatch
BINARY(8) Inbound IPSec packets discarded - authentication error
BINARY(8) Inbound IPSec packets discarded - other
BINARY(8) Inbound NAT packets
BINARY(8) Inbound filter packets discarded
BINARY(8) Inbound filter packets permitted
BINARY(8) Inbound packets non-filtered
BINARY(8) Inbound packets discarded - other
BINARY(8) Inbound packets discarded - rule exception
BINARY(4) NAT rules
BINARY(4) Filter rules
BINARY(4) IPSec rules


Field Descriptions

Date - filter rules loaded or unloaded. Date when the filter rules were most recently successfully loaded on or unloaded from this interface. Format: YYYYMMDD, where:

YYYY Year
MM Month
DD Day

The following is a special value:

00000000 Rules have never been loaded since interface was loaded.

Filter rules. Indicates whether filter rules exist on the system. The possible values are:

0 No filter rules exist.
1 Filter rules exist.

Inbound IPSec packets. Total inbound IPSec packets (AH or ESP) processed without error.

Inbound IPSec packets permitted. Total inbound packets permitted by pre-IPSec filters.

Inbound IPSec packets discarded - authentication error. Authentication error or failed.

Inbound IPSec packets discarded - no connection. Total inbound packets discarded because a VPN connection was not started.

Inbound IPSec packets discarded - no AH/ESP. Total inbound packets discarded because packet should have had a AH or ESP header, and did not.

Inbound IPSec packets discarded - ondemand. Total inbound packets discarded due to a starting on-demand VPN connection.

Inbound IPSec packets discarded - anti-replay fail. Total inbound packets discarded due to failed anti-replay audit.

Inbound IPSec packets discarded - mode mismatch. Total inbound packets discarded because the mode (tunnel or transport) of the packet did not match the mode of the VPN connection.

Inbound IPSec packets discarded - other. Total inbound packets discarded for other reasons, relating to IPSec.

Inbound IPSec packets discarded - selector mismatch. Total inbound packets discarded because the packet did not match the VPN connection (selectors).

Inbound IPSec packets discarded - VPN NAT. Total inbound packets that could not be NAT'd because an IP address was not available from a VPN NAT pool.

Inbound NAT packets. Total inbound packets processed by conventional NAT.

Inbound filter packets discarded. Total inbound packets discarded by filter action = DENY.

Inbound filter packets permitted. Total inbound packets permitted by filter action = PERMIT.

Inbound packets non-filtered. Total inbound packets not filtered (occurs only when no filters exist).

Inbound packets discarded - other. Total inbound packets discarded for some other reason.

Inbound packets discarded - rule exception. Total inbound packets discarded for exception reason.

IPSec rules. Indicates whether IPSec filter rules exist on the system. The possible values are:

0 No IPSec filter rules exist.
1 IPSec filter rules exist.

NAT rules. Indicates whether NAT rules exist on the system. The possible values are:

0 No NAT rules exist.
1 NAT rules exist.

Outbound filter packets discarded. Total outbound packets discarded by filter action = DENY.

Outbound filter packets permitted. Total outbound packets permitted by filter action = PERMIT.

Outbound packets non-filtered. Total outbound packets not filtered (occurs only when no filters exist).

Outbound IPSec packets. Total outbound IPSec packets (AH or ESP) processed without error.

Outbound IPSec packets discarded - no connection. Total outbound packets that could not be handled by IPSec because a VPN connection was not started.

Outbound IPSec packets discarded - ondemand. Total outbound packets discarded due to a starting on-demand VPN connection.

Outbound IPSec packets discarded - other. Total outbound packets that could not be handled for other reasons.

Outbound IPSec packets discarded - VPN NAT. Total outbound packets that could not be NAT'd because an IP address was not available from a VPN NAT pool.

Outbound NAT packets. Total outbound packets processed by conventional NAT.

Outbound NAT packets discarded. Total outbound packets that could not be handled by masquerade NAT due to lack of available conversation.

Outbound packets discarded - other. Total outbound packets discarded for some other reason.

Outbound packets discarded - rule exception. Total outbound packets discarded for exception reason.

Reserved. An ignored field.

Time - filter rules loaded or unloaded. Time when the filter rules were most recently successfully loaded on or unloaded from this interface. Format: HHMMSS, in 24 hour time, where:

HH Hour
MM Minute
SS Second

The following is a special value:

000000 Rules have never been loaded since interface was loaded.

IFCD0300 Format

This format returns detailed IPv6 specific information and statistics for each Physical interface, in addition to data about a physical interface from the IFCD0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Offset Type Field
Dec Hex
0 0
Returns everything from format IFCD0100.
Decimal and hexadecimal offsets are reached by using the offset to additional information field in format IFCD0100. BINARY(4) Packet rules - IPv6
BINARY(8) Total IPv6 bytes received
BINARY(8) Total IPv6 bytes sent
BINARY(4) Total IPv6 unicast packets received
BINARY(4) Total IPv6 multicast packets received
BINARY(4) Total IPv6 anycast packets received
BINARY(4) Total inbound IPv6 packets discarded
BINARY(4) Total IPv6 unicast packets sent
BINARY(4) Total IPv6 multicast packets sent
BINARY(4) Total IPv6 anycast packets sent
BINARY(4) Total outbound IPv6 packets discarded
CHAR(25) IPv6 interface identifier
CHAR(7) Reserved
BINARY(8) IPv6 interface identifier binary
BINARY(4) MTU - configured
BINARY(4) MTU - current
BINARY(4) Hop limit - configured
BINARY(4) Hop limit - current
BINARY(4) Use stateless autoconfig
BINARY(4) Use stateful address configuration
BINARY(4) Use other stateful configuration
BINARY(4) Accept router advertisements
BINARY(4) Accept redirects
BINARY(4) Neighbor discovery base reachable time - configured
BINARY(4) Neighbor discovery base reachable time - current
BINARY(4) Neighbor discovery reachable time
BINARY(4) Neighbor solicitation retransmit interval - configured
BINARY(4) Neighbor solicitation retransmit interval - current
BINARY(4) Duplicate address detection max transmits
CHAR(15) Local tunnel endpoint IPv4 address
CHAR(1) Reserved
BINARY(4) Local tunnel endpoint IPv4 address binary
BINARY(4) Autostart
CHAR(50) Text description
CHAR(2) Reserved
BINARY(4) Text description CCSID
BINARY(4) Autoconfig line status
BINARY(4) Use privacy extensions
Start of changeBINARY(4) DHCP DNS updates
BINARY(4) Disable global Stateless Address Auto-Configuration
BINARY(4) Total inbound IPv6 packet errors
BINARY(4) Total inbound IPv6 unknown protocol
BINARY(4) Total outbound IPv6 packets errorsEnd of change


Field Descriptions

Accept redirects. Whether the system is currently accepting and using ICMPv6 Redirects that it receives on this physical interface.

Possible values are:

0 No - this interface is not accepting redirects.

Note: As of V5R4, the physical interface will always accept redirects. As a result, 0 will never be returned.

1 Yes - this interface is accepting redirects.

Accept router advertisements. Whether the system is currently accepting and using Router Advertisements that it receives on this physical interface.

Possible values are:

0 No - this interface is not accepting router advertisements.

Note: As of V5R4, the physical interface will always accept router advertisements. As a result, 0 will never be returned.

1 Yes - this interface is accepting router advertisements.

Autoconfig line status. Whether this physical interface is currently using, not using, or is configured for stateless autoconfig.

Possible values are:

0 Autonfig is not active on this physical interface.
1 Autonfig has been configured on this physical interface.
2 Autonfig is active on this physical interface.

Autostart. Specifies whether the physical interface is automatically started when the TCP/IP stack is activated by the Start TCP/IP (STRTCP) command.

Possible values are:

0 No - The physical interface is not started when TCP/IP is started.
1 Yes - The physical interface is automatically started when TCP/IP is started.

Start of changeDHCP DNS updates. Specifies whether dynamic updates to Domain Name System (DNS) tables are enabled for the Dynamic Host Configuration Protocol or not.

Possible values are:

0 DNS updates are disabled.
1 DNS updates are enabled.

Disable global Stateless Address Auto-Configuration.Whether the Stateless Address Auto-Configuration (SAAC) is able to accept global addresses or not.

Possible values are:

0 Enable global SAAC.
1 Disable global SAAC.End of change

Duplicate address detection max transmits. The maximum number of consecutive Neighbor Solicitation messages which will be sent using this physical interface when TCP/IPv6 performs Duplicate Address Detection (DAD) on a tentative address.

The following special value may be returned:

0 This physical interface is currently configured to not perform Duplicate Address Detection.

Hop limit - configured. The configured IPv6 Hop Limit value specified for this physical interface. The Hop limit field is the IPv6 replacement for the IPv4 Time to live (TTL) field. The Hop limit value specifies a relative limit on the number of hops across which an IPv6 datagram remains active. The Hop limit value is hop count that is decremented by each gateway to prevent Internet routing loops. The default Hop limit value is 64. Valid values range from 1 through 255 hops.

Hop limit - current. The IPv6 Hop Limit value currently in effect for this physical interface. The Hop Limit field is the IPv6 replacement for the IPv4 Time to live (TTL) field. The Hop Limit value specifies a relative limit on the number of hops across which an IPv6 datagram remains active. The Hop Limit value is hop count that is decremented by each gateway to prevent Internet routing loops. The default Hop Limit value is 64. If the current Hop Limit value differs from the configured Hop Limit value, then it has been set by a Hop Limit value received in a Router Advertisement packet. Valid values range from 1 through 255 hops.

IPv6 interface identifier. A 64-bit number which is combined with prefixes to create complete IPv6 addresses for the physical interface. By default it is based on the link layer (MAC) address, if one exists. The interface identifier is represented here in standard IPv6 address format notation. It does not include a leading "::" for the first 64 bits of a full IPv6 address, and it may include an embedded IPv4 address at the end. This field is NULL padded.

IPv6 interface identifier binary. Binary representation of the IPv6 interface identifier.

Local tunnel endpoint IPv4 address. The IPv4 address of the local tunnel endpoint of this tunnel, returned in dotted decimal format. This field is NULL padded.

The following special value may be returned:

0.0.0.0 This physical interface is not a tunnel, so this field does not apply.

Note: As of V5R4, tunneling is not supported. As a result, this field is always set to 0.0.0.0.

Local tunnel endpoint IPv4 address binary. Binary representation of the Local tunnel endpoint IPv4 address.

The following special value may be returned:

0 This physical interface is not a tunnel

Note: As of V5R4, tunneling is not supported. As a result, this field is always set to 0.

MTU - configured. The configured maximum transmission unit (MTU) value specified for this physical interface.

The following is a special value:

0 LIND - The MTU was configured as *LIND, the MTU value from the line description.

MTU - current. Maximum transmission unit (MTU) value currently in effect for this physical interface.

The following is a special value:

0 LIND - The interface is not active currently and the MTU was configured as *LIND.

Neighbor discovery base reachable time - configured. The configured Neighbor Discovery (ND) Base Reachable Time value, in seconds, specified for this physical interface. The ND Base Reachable Time value is a base time value used for computing the random ND Reachable Time value. The default ND Base Reachable Time is 30 seconds. Valid values range from 10 through 100 seconds.

Note: As of V5R4, this field is always set to 30.

Neighbor discovery base reachable time - current. The Neighbor Discovery (ND) Base Reachable Time value, in seconds, currently in effect for this physical interface. The ND Base Reachable Time value is a base time value used for computing the random ND Reachable Time value. The default ND Base Reachable Time is 30 seconds. If the current ND Base Reachable Time value differs from the configured value, then it has been set by a ND Base Reachable Time value received in a Router Advertisement packet. Valid values range from 10 through 100 seconds.

Note: As of V5R4, this field is always set to 30.

Neighbor discovery reachable time. The current Neighbor Discovery (ND) Reachable Time value, in seconds, for this physical interface. The ND Reachable Time value is the amount of time, in seconds, that a neighbor is considered reachable after receiving a reachability confirmation. The ND Reachable Time value is randomly calculated, using the ND Base Reachable Time and a couple constants. This calculation is performed to prevent Neighbor Unreachability Detection (NUD) messages from synchronizing with each other.

Note: As of V5R4, this field is always set to 0.

Neighbor solicitation retransmit interval - configured. The configured Neighbor Solicitation (NS) Retransmit Interval value, in seconds, specified for this physical interface. The NS Retransmit Interval is the time, in seconds, between retransmissions of Neighbor Solicitation messages to a neighbor when resolving the link-layer address, or when probing the reachability of a neighbor. The default NS retransmit interval is 1 second. Valid values range from 1 through 10 seconds.

Note: As of V5R4, this field is always set to 1.

Neighbor solicitation retransmit interval - current. The Neighbor Solicitation (NS) Retransmit Interval value currently in effect for this physical interface. The NS Retransmit Interval is the time, in seconds, between retransmissions of Neighbor Solicitation messages to a neighbor when resolving the link-layer address, or when probing the reachability of a neighbor. The default NS Retransmit Interval is 1 second. If the current NS Retransmit Interval value differs from the configured value, then it has been set by a NS Retransmit Interval value received in a Router Advertisement packet. Valid values range from 1 through 10 seconds.

Note: As of V5R4, this field is always set to 1.

Packet rules - IPv6. Indicates what kind of IPv6 packet rules are loaded on a particular line.

Possible values are:

-1 Other - An unknown Packet rules value.
0 None - No NAT and no filters are loaded for the line specified.
1 NAT - NAT is enabled for this line.
2 Filters - Filters are defined for this line.
3 NAT and Filters - NAT enabled and Filters defined for this line.
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 for this line.

Reserved. An ignored field.

Text description. User added text description associated with the physical interface.

Text description CCSID. Coded character set ID for the text description.

Start of changeTotal inbound IPv6 packet errors. The number of inbound IPv6 packets which were chosen to be discarded due to errors found when they were being received.

Total inbound IPv6 unknown protocol. The number of inbound IPv6 packets which were chosen to be discarded because they were intended to an unknown higher-layer protocol.End of change

Total inbound IPv6 packets discarded. The number of inbound IPv6 packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space.

Total IPv6 anycast packets received. The number of IPv6 anycast packets delivered to a higher-layer protocol.

Total IPv6 anycast packets sent. The number of IPv6 anycast packets that higher-level protocols requested be transmitted, including those that were discarded.

Total IPv6 bytes received. The total number of IPv6 bytes received on the interface, including framing characters.

Total IPv6 bytes sent. The total number of IPv6 bytes transmitted out of the interface, including framing characters.

Total IPv6 multicast packets received. The number of IPv6 multicast packets delivered to a higher-layer protocol.

Total IPv6 multicast packets sent. The number of IPv6 multcast packets that higher-level protocols requested be transmitted, including those that were discarded.

Total IPv6 unicast packets received. The number of IPv6 unicast packets delivered to a higher-layer protocol.

Total IPv6 unicast packets sent. The number of IPv6 unicast packets that higher-level protocols requested be transmitted, including those that were discarded.

Start of changeTotal outbound IPv6 packets errors. The number of outbound IPv6 packets which were chosen to be discarded due to errors found when they were being transmitted.End of change

Total outbound IPv6 packets discarded. The number of outbound IPv6 packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

Use privacy extensions. Whether the TCP/IPv6 stack is using privacy extensions on this physical interface or not.

Possible values are:

0 NO - The system is not using privacy extensions on this physical interface.
1 YES - The system is using privacy extensions on this physical interface.

Use other stateful configuration. Whether the TCP/IPv6 stack has been informed by a Router Advertisement to use non-address stateful (that is, DHCPv6) configuration information that it receives on this physical interface.

Possible values are:

-1 UNKNOWN - The system has not received any Router Advertisements on this physical interface.
0 NO - The system has been informed to not use any non-address stateful configuration information that it receives on this physical interface.
1 YES - The system has been informed to use any non-address stateful configuration information that it receives on this physical interface.

Note: As of V5R4, this field is always set to 0.

Use stateful address configuration. Whether the TCP/IPv6 stack has been informed by a Router Advertisement to use stateful (that is, DHCPv6) configuration information that it receives on this physical interface for the purpose of address autoconfiguration.

Possible values are:

-1 UNKNOWN - The system has not received any Router Advertisements on this physical interface.
0 NO - The system has been informed to not use stateful configuration information that it receives on this physical interface for the purpose of address autoconfiguration.
1 YES - The system has been informed to use stateful configuration information that it receives on this physical interface for the purpose of address autoconfiguration.

Note: As of V5R4, this field is always set to 0.

Use stateless autoconfig. Whether the TCP/IPv6 stack performs stateless autoconfiguration on this physical interface or not.

Possible values are:

0 NO - The system will not perform the stateless autoconfig algorithms on this physical interface.
1 YES - The system will perform the stateless autoconfig algorithms on this physical interface.


IFCD0400 Format

This format returns detailed IPv6 Filter and IPSec Physical interface data in addition to data about a physical interface from the IFCD0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Offset Type Field
Dec Hex
0 0
Returns everything from format IFCD0100.
Decimal and hexadecimal offsets are reached by using the offset to additional information field in format IFCD0100. CHAR(8) Date - filter rules loaded or unloaded
CHAR(6) Time - filter rules loaded or unloaded
CHAR(2) Reserved
BINARY(8) Outbound filter packets discarded
BINARY(8) Outbound filter packets permitted
BINARY(8) Outbound packets non-filtered
BINARY(8) Outbound IPSec packets
BINARY(8) Outbound IPSec packets discarded - no connection
BINARY(8) Outbound IPSec packets discarded - ondemand
BINARY(8) Outbound IPSec packets discarded - VPN NAT
BINARY(8) Outbound IPSec packets discarded - other
BINARY(8) Outbound NAT packets
BINARY(8) Outbound NAT packets discarded
BINARY(8) Outbound packets discarded - rule exception
BINARY(8) Outbound packets discarded - other
BINARY(8) Inbound IPSec packets
BINARY(8) Inbound IPSec packets permitted
BINARY(8) Inbound IPSec packets discarded - no AH/ESP
BINARY(8) Inbound IPSec packets discarded - no connection
BINARY(8) Inbound IPSec packets discarded - ondemand
BINARY(8) Inbound IPSec packets discarded - VPN NAT
BINARY(8) Inbound IPSec packets discarded - anti-replay fail
BINARY(8) Inbound IPSec packets discarded - selector mismatch
BINARY(8) Inbound IPSec packets discarded - mode mismatch
BINARY(8) Inbound IPSec packets discarded - authentication error
BINARY(8) Inbound IPSec packets discarded - other
BINARY(8) Inbound NAT packets
BINARY(8) Inbound filter packets discarded
BINARY(8) Inbound filter packets permitted
BINARY(8) Inbound packets non-filtered
BINARY(8) Inbound packets discarded - rule exception
BINARY(8) Inbound packets discarded - other
BINARY(4) NAT rules
BINARY(4) Filter rules
BINARY(4) IPSec rules


Field Descriptions

Date - filter rules loaded or unloaded.

Date when the filter rules were most recently successfully loaded on or unloaded from this interface. Format: YYYYMMDD, where:

YYYY Year
MM Month
DD Day

The following is a special value:

00000000 Rules have never been loaded since interface was loaded.

Filter rules. Indicates whether filter rules exist on the system. The possible values are:

0 No filter rules exist.
1 Filter rules exist.

Inbound IPSec packets. Total inbound IPSec packets (AH or ESP) processed without error.

Inbound IPSec packets permitted. Total inbound packets permitted by pre-IPSec filters.

Inbound IPSec packets discarded - authentication error. Authentication error or failed.

Inbound IPSec packets discarded - no AH/ESP. Total inbound packets discarded because packet should have had a AH or ESP header, and did not.

Inbound IPSec packets discarded - no connection. Total inbound packets discarded because a VPN connection was not started.

Inbound IPSec packets discarded - ondemand. Total inbound packets discarded due to a starting on-demand VPN connection.

Inbound IPSec packets discarded - anti-replay fail. Total inbound packets discarded due to failed anti-replay audit.

Inbound IPSec packets discarded - mode mismatch. Total inbound packets discarded because the mode (tunnel or transport) of the packet did not match the mode of the VPN connection.

Inbound IPSec packets discarded - other. Total inbound packets discarded for other reasons, relating to IPSec.

Inbound IPSec packets discarded - selector mismatch. Total inbound packets discarded because the packet did not match the VPN connection (selectors).

Inbound IPSec packets discarded - VPN NAT. Total inbound packets that could not be NAT'd because an IP address was not available from a VPN NAT pool.

Inbound NAT packets. Total inbound packets processed by conventional NAT.

Inbound filter packets discarded. Total inbound packets discarded by filter action = DENY.

Inbound filter packets permitted. Total inbound packets permitted by filter action = PERMIT.

Inbound packets non-filtered. Total inbound packets not filtered (occurs only when no filters exist).

Inbound packets discarded - other. Total inbound packets discarded for some other reason.

Inbound packets discarded - rule exception. Total inbound packets discarded for exception reason.

IPSec rules. Indicates whether IPSec filter rules exist on the system. The possible values are:

0 No IPSec filter rules exist.
1 IPSec filter rules exist.

NAT rules. Indicates whether NAT rules exist on the system. The possible values are:

0 No NAT rules exist.
1 NAT rules exist.

Outbound filter packets discarded. Total outbound packets discarded by filter action = DENY.

Outbound filter packets permitted. Total outbound packets permitted by filter action = PERMIT.

Outbound packets non-filtered. Total outbound packets not filtered (occurs only when no filters exist).

Outbound IPSec packets. Total outbound IPSec packets (AH or ESP) processed without error.

Outbound IPSec packets discarded - no connection. Total outbound packets that could not be handled by IPSec because a VPN connection was not started.

Outbound IPSec packets discarded - ondemand. Total outbound packets discarded due to a starting on-demand VPN connection.

Outbound IPSec packets discarded - other. Total outbound packets that could not be handled for other reasons.

Outbound IPSec packets discarded - VPN NAT. Total outbound packets that could not be NAT'd because an IP address was not available from a VPN NAT pool.

Outbound NAT packets. Total outbound packets processed by conventional NAT.

Outbound NAT packets discarded. Total outbound packets that could not be handled by masquerade NAT due to lack of available conversation.

Outbound packets discarded - other. Total outbound packets discarded for some other reason.

Outbound packets discarded - rule exception. Total outbound packets discarded for exception reason.

Reserved. An ignored field.

Time - filter rules loaded or unloaded. Time when the filter rules were most recently successfully loaded on or unloaded from this interface. Format: HHMMSS, in 24 hour time, where:

HH Hour
MM Minute
SS Second

The following is a special value:

000000 Rules have never been loaded since interface was loaded.


Error Messages

Message ID Error Message Text
TCP84C5 E API error providing TCP/IP Network Status list information.
TCP84C6 E Internal operations error - RESULT &1 CC &2 RC &3 ERRNO &4.
CPF24B4 E Severe error while addressing parameter list.
CPF3C21 E Format name &1 is not valid.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
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

[ Back to top | Communications APIs | APIs by category ]