Interface
Keys
Leafs
Children
Enum Classes
- class InterfacesState.Interface
Bases:
EntityClass Hierarchy :
InterfacesStateInterfaceThis class represents state data.
The list of interfaces on the device.
System-controlled interfaces created by the system are
always present in this list, whether they are configured or
not.
- name(key)
The name of the interface. A server implementation MAY map this leaf to the ifName MIB object. Such an implementation needs to use some mechanism to handle the differences in size and characters allowed between this leaf and ifName. The definition of such a mechanism is outside the scope of this document
type: str
config: False
- type
The type of the interface
type: one of the below values:
IanaInterfaceTypemandatory: True
config: False
- admin_status
The desired state of the interface. This leaf has the same read semantics as ifAdminStatus
type:
AdminStatusmandatory: True
config: False
- oper_status
The current operational state of the interface. This leaf has the same semantics as ifOperStatus
type:
OperStatusmandatory: True
config: False
- last_change
The time the interface entered its current operational state. If the current state was entered prior to the last re-initialization of the local network management subsystem, then this node is not present
type: str
pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2})
config: False
- if_index
The ifIndex value for the ifEntry represented by this interface
type: int
range: 1..2147483647
mandatory: True
config: False
- phys_address
The interface’s address at its protocol sub-layer. For example, for an 802.x interface, this object normally contains a Media Access Control (MAC) address. The interface’s media-specific modules must define the bit and byte ordering and the format of the value of this object. For interfaces that do not have such an address (e.g., a serial line), this node is not present
type: str
pattern: ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?
config: False
- higher_layer_if
A list of references to interfaces layered on top of this interface
type: list of str
refers to:
nameconfig: False
- lower_layer_if
A list of references to interfaces layered underneath this interface
type: list of str
refers to:
nameconfig: False
- speed
An estimate of the interface’s current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this node should contain the nominal bandwidth. For interfaces that have no concept of bandwidth, this node is not present
type: int
range: 0..18446744073709551615
config: False
units: bits/second
- statistics
A collection of interface-related statistics objects
type:
Statisticsconfig: False