name | String | false | The name of the interface. |
interfaceType | IfaceType | false | The type of the interface. |
layer | Layer | false | Denotes whether this is a Layer 2 (physical) or Layer 3 (logical) interface. |
mtu | Integer | true | The max transmission unit size in octets for the physical interface. Note that this is the L2 MTU, which is normalized to include the length of the L2 payload, but not the L2 header and trailers (such as the MAC source and destination, Ethernet type, or VLAN headers). Some vendors include the length of the L2 header when reporting the L2 MTU, and as a result the MTU value reported by the device will differ from the value reported here. For example, Cisco IOS-XR includes L2 headers. An interface that reports a 1514 byte MTU on IOS-XR is normalized to 1500 after subtracting 14 bytes of L2 headers. |
loopbackMode | Bool | false | When set to true, the interface is logically looped back, such that packets that are forwarded via the interface are received on the same interface. |
aliases | List<String> | false | The set of all names that refer to this interface. For example, on Cisco, an interface named "eth1" might also be referred to as "Ethernet1". This field would then include both "eth1" and "Ethernet1". |
description | String | true | A textual description of the interface. |
adminStatus | AdminStatus | false | The desired state of the interface. Here, it reflects the administrative state as set by enabling or disabling the interface. |
operStatus | OperStatus | false | The current operational state of the interface. |
subinterfaces | List<SubInterface> | false | The list of subinterfaces (logical interfaces) associated with a physical interface. |
ethernet | Ethernet | false | Ethernet-specific configuration and state of the interface. |
acls | IfaceAcls | false | Access control list details specific to this interface. |
routedVlan | RoutedVlan | true | Non-null when the interface is a logical interface providing L3 routing for VLANs. |
bridge | Bridge | true | Non-null when the interface is a bridge (BVI, BDI, etc.) |
aggregation | Aggregation | true | Non-null when the interface is set to type IF_AGGREGATE. |
tunnel | Tunnel | true | In the case that the interface is logical tunnel interface, the parameters for the tunnel are specified within this subtree. |
teTunnel | TeTunnel | true | In the case that the interface is a logical Traffic Engineering (TE) tunnel interface, the parameters for the TE tunnel are specified within this subtree. |
links | List<PhysicalLink> | false | The other interfaces that this interface connects to. |
cdp | DeviceDiscoveryIfaceInfo | false | -- |
lldp | DeviceDiscoveryIfaceInfo | false | -- |