This module defines configuration and state variables for VLANs, in addition to VLAN parameters associated with interfaces
openconfig-extensions
description:
Type definition representing a single-tagged VLAN
type: uint16
description:
Type definition representing a range of single-tagged
VLANs. A range is specified as x..y where x and y are
valid VLAN IDs (1 <= vlan-id <= 4094). The range is
assumed to be inclusive, such that any VLAN-ID matching
x <= VLAN-ID <= y falls within the range.
type: string
description:
Type definition representing a single double-tagged/QinQ VLAN
identifier. The format of a QinQ VLAN-ID is x.y where X is the
'outer' VLAN identifier, and y is the 'inner' VLAN identifier.
Both x and y must be valid VLAN IDs (1 <= vlan-id <= 4094)
with the exception that y may be equal to a wildcard (*). In
cases where y is set to the wildcard, this represents all inner
VLAN identifiers where the outer VLAN identifier is equal to
x.
type: string
description:
A type definition representing a range of double-tagged/QinQ
VLAN identifiers. The format of a QinQ VLAN-ID range can be
specified in two formats. Where the range is outer VLAN IDs
the range is specified as x..y.z. In this case outer VLAN
identifiers meeting the criteria x <= outer-vlan-id <= y are
accepted if and only if the inner VLAN-ID is equal to y - or
any inner-tag if the wildcard is specified. Alternatively the
ange can be specified as x.y..z. In this case only VLANs with an
outer-vlan-id qual to x are accepted (x may again be the
wildcard). Inner VLANs are accepted if they meet the inequality
y <= inner-vlan-id <= z.
type: union
type: string
type: string
description:
VLAN interface mode (trunk or access)
type: enumeration
description:
Reference to a VLAN by name or id
type: union
type: vlan-id
type: string
description:
Operations that can be performed on a VLAN stack.
type: enumeration
description:
Base identity for TPID values that can be matched or that override
the VLAN ethertype value
description:
Default TPID value for 802.1q single-tagged VLANs.
base identity: TPID_TYPES
description:
TPID value for 802.1ad provider bridging, QinQ or
stacked VLANs.
base identity: TPID_TYPES
description:
Alternate TPID value.
base identity: TPID_TYPES
description:
Alternate TPID value.
base identity: TPID_TYPES
description:
A wildcard that matches any of the generally used TPID values
for singly- or multiply-tagged VLANs. Equivalent to matching
any of TPID_0X8100, TPID_0X88A8, TPID_0X9100 and TPID_0x9200.
This value is only applicable where the TPID of a packet is
being matched.
base identity: TPID_TYPES
This module defines configuration and state variables for VLANs, in addition to VLAN parameters associated with interfaces
openconfig-vlan-types
openconfig-interfaces
openconfig-if-ethernet
openconfig-if-aggregate
iana-if-type
openconfig-extensions
Model for managing network interfaces and subinterfaces. This module also defines convenience types / groupings for other models to create references to interfaces:
base-interface-ref (type) - reference to a base interface interface-ref (grouping) - container for reference to a interface + subinterface interface-ref-state (grouping) - container for read-only (opstate) reference to interface + subinterface
This model reuses data items defined in the IETF YANG model for interfaces described by RFC 7223 with an alternate structure (particularly for operational state data) and with additional configuration items.
Portions of this code were derived from IETF RFC 7223. Please reproduce this note if possible.
IETF code is subject to the following copyright and license: Copyright (c) IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).
ietf-interfaces
openconfig-yang-types
openconfig-types
openconfig-extensions
openconfig-transport-types
description:
Reusable type for by-name reference to a base interface.
This type may be used in cases where ability to reference
a subinterface is not required.
type: leafref
description:
User-defined identifier for an interface, generally used to
name a interface reference. The id can be arbitrary but a
useful convention is to use a combination of base interface
name and subinterface index.
type: string
description:
Top level container for interfaces, including configuration
and state data.
nodetype: container (rw)
description:
The list of named interfaces on the device.
nodetype: list (rw)
list keys: [name]
description:
References the name of the interface
nodetype: leaf (list key) (rw)
type: leafref
description:
Configurable items at the global, physical interface
level
nodetype: container (rw)
description:
The name of the interface.
A device MAY restrict the allowed values for this leaf,
possibly depending on the type of the interface.
For system-controlled interfaces, this leaf is the
device-specific name of the interface. The 'config false'
list interfaces/interface[name]/state contains the currently
existing interfaces on the device.
If a client tries to create configuration for a
system-controlled interface that is not present in the
corresponding state list, the server MAY reject
the request if the implementation does not support
pre-provisioning of interfaces or if the name refers to
an interface that can never exist in the system. A
NETCONF server MUST reply with an rpc-error with the
error-tag 'invalid-value' in this case.
The IETF model in RFC 7223 provides YANG features for the
following (i.e., pre-provisioning and arbitrary-names),
however they are omitted here:
If the device supports pre-provisioning of interface
configuration, the 'pre-provisioning' feature is
advertised.
If the device allows arbitrarily named user-controlled
interfaces, the 'arbitrary-names' feature is advertised.
When a configured user-controlled interface is created by
the system, it is instantiated with the same name in the
/interfaces/interface[name]/state list.
nodetype: leaf (rw)
type: string
description:
The type of the interface.
When an interface entry is created, a server MAY
initialize the type leaf with a valid value, e.g., if it
is possible to derive the type from the name of the
interface.
If a client tries to set the type of an interface to a
value that can never be used by the system, e.g., if the
type is not supported or if the type does not match the
name of the interface, the server MUST reject the request.
A NETCONF server MUST reply with an rpc-error with the
error-tag 'invalid-value' in this case.
nodetype: leaf (rw)
type: identityref
description:
Set the max transmission unit size in octets
for the physical interface. If this is not set, the mtu is
set to the operational default -- e.g., 1514 bytes on an
Ethernet interface.
nodetype: leaf (rw)
type: uint16
description:
Sets the loopback type on the interface. Setting the
mode to something besides NONE activates the loopback in
the specified mode.
nodetype: leaf (rw)
type: oc-opt-types:loopback-mode-type
description:
A textual description of the interface.
A server implementation MAY map this leaf to the ifAlias
MIB object. Such an implementation needs to use some
mechanism to handle the differences in size and characters
allowed between this leaf and ifAlias. The definition of
such a mechanism is outside the scope of this document.
Since ifAlias is defined to be stored in non-volatile
storage, the MIB implementation MUST map ifAlias to the
value of 'description' in the persistently stored
datastore.
Specifically, if the device supports ':startup', when
ifAlias is read the device MUST return the value of
'description' in the 'startup' datastore, and when it is
written, it MUST be written to the 'running' and 'startup'
datastores. Note that it is up to the implementation to
decide whether to modify this single leaf in 'startup' or
perform an implicit copy-config from 'running' to
'startup'.
If the device does not support ':startup', ifAlias MUST
be mapped to the 'description' leaf in the 'running'
datastore.
nodetype: leaf (rw)
type: string
description:
This leaf contains the configured, desired state of the
interface.
Systems that implement the IF-MIB use the value of this
leaf in the 'running' datastore to set
IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry
has been initialized, as described in RFC 2863.
Changes in this leaf in the 'running' datastore are
reflected in ifAdminStatus, but if ifAdminStatus is
changed over SNMP, this leaf is not affected.
nodetype: leaf (rw)
type: boolean
default: true
description:
Optionally set the tag protocol identifier field (TPID) that
is accepted on the VLAN
nodetype: leaf (rw)
type: identityref
default: oc-vlan-types:TPID_0X8100
description:
Operational state data at the global interface level
nodetype: container (ro)
description:
The name of the interface.
A device MAY restrict the allowed values for this leaf,
possibly depending on the type of the interface.
For system-controlled interfaces, this leaf is the
device-specific name of the interface. The 'config false'
list interfaces/interface[name]/state contains the currently
existing interfaces on the device.
If a client tries to create configuration for a
system-controlled interface that is not present in the
corresponding state list, the server MAY reject
the request if the implementation does not support
pre-provisioning of interfaces or if the name refers to
an interface that can never exist in the system. A
NETCONF server MUST reply with an rpc-error with the
error-tag 'invalid-value' in this case.
The IETF model in RFC 7223 provides YANG features for the
following (i.e., pre-provisioning and arbitrary-names),
however they are omitted here:
If the device supports pre-provisioning of interface
configuration, the 'pre-provisioning' feature is
advertised.
If the device allows arbitrarily named user-controlled
interfaces, the 'arbitrary-names' feature is advertised.
When a configured user-controlled interface is created by
the system, it is instantiated with the same name in the
/interfaces/interface[name]/state list.
nodetype: leaf (ro)
type: string
description:
The type of the interface.
When an interface entry is created, a server MAY
initialize the type leaf with a valid value, e.g., if it
is possible to derive the type from the name of the
interface.
If a client tries to set the type of an interface to a
value that can never be used by the system, e.g., if the
type is not supported or if the type does not match the
name of the interface, the server MUST reject the request.
A NETCONF server MUST reply with an rpc-error with the
error-tag 'invalid-value' in this case.
nodetype: leaf (ro)
type: identityref
description:
Set the max transmission unit size in octets
for the physical interface. If this is not set, the mtu is
set to the operational default -- e.g., 1514 bytes on an
Ethernet interface.
nodetype: leaf (ro)
type: uint16
description:
Sets the loopback type on the interface. Setting the
mode to something besides NONE activates the loopback in
the specified mode.
nodetype: leaf (ro)
type: oc-opt-types:loopback-mode-type
description:
A textual description of the interface.
A server implementation MAY map this leaf to the ifAlias
MIB object. Such an implementation needs to use some
mechanism to handle the differences in size and characters
allowed between this leaf and ifAlias. The definition of
such a mechanism is outside the scope of this document.
Since ifAlias is defined to be stored in non-volatile
storage, the MIB implementation MUST map ifAlias to the
value of 'description' in the persistently stored
datastore.
Specifically, if the device supports ':startup', when
ifAlias is read the device MUST return the value of
'description' in the 'startup' datastore, and when it is
written, it MUST be written to the 'running' and 'startup'
datastores. Note that it is up to the implementation to
decide whether to modify this single leaf in 'startup' or
perform an implicit copy-config from 'running' to
'startup'.
If the device does not support ':startup', ifAlias MUST
be mapped to the 'description' leaf in the 'running'
datastore.
nodetype: leaf (ro)
type: string
description:
This leaf contains the configured, desired state of the
interface.
Systems that implement the IF-MIB use the value of this
leaf in the 'running' datastore to set
IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry
has been initialized, as described in RFC 2863.
Changes in this leaf in the 'running' datastore are
reflected in ifAdminStatus, but if ifAdminStatus is
changed over SNMP, this leaf is not affected.
nodetype: leaf (ro)
type: boolean
default: true
description:
System assigned number for each interface. Corresponds to
ifIndex object in SNMP Interface MIB
nodetype: leaf (ro)
type: uint32
description:
The desired state of the interface. In RFC 7223 this leaf
has the same read semantics as ifAdminStatus. Here, it
reflects the administrative state as set by enabling or
disabling the interface.
nodetype: leaf (ro)
type: enumeration
description:
The current operational state of the interface.
This leaf has the same semantics as ifOperStatus.
nodetype: leaf (ro)
type: enumeration
description:
This timestamp indicates the absolute time of the last
state change of the interface (e.g., up-to-down transition).
This is different than the SNMP ifLastChange object in the
standard interface MIB in that it is not relative to the
system boot time (i.e,. sysUpTime).
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
When set to true, the interface is a logical interface
which does not have an associated physical port or
channel on the system.
nodetype: leaf (ro)
type: boolean
description:
When set to true, the interface is a dedicated
management interface that is not connected to dataplane
interfaces. It may be used to connect the system to an
out-of-band management network, for example.
nodetype: leaf (ro)
type: boolean
description:
When set to true, the interface is for traffic
that is handled by the system CPU, sometimes also called the
control plane interface. On systems that represent the CPU
interface as an Ethernet interface, for example, this leaf
should be used to distinguish the CPU interface from dataplane
interfaces.
nodetype: leaf (ro)
type: boolean
description:
A collection of interface specific statistics entitites which are
not common to subinterfaces.
nodetype: container (ro)
description:
The total number of octets received on the interface,
including framing characters.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets received on the interface,
including all unicast, multicast, broadcast and bad packets
etc.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of packets, delivered by this sub-layer to a
higher (sub-)layer, that were not addressed to a
multicast or broadcast address at this sub-layer.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of packets, delivered by this sub-layer to a
higher (sub-)layer, that were addressed to a broadcast
address at this sub-layer.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of packets, delivered by this sub-layer to a
higher (sub-)layer, that were addressed to a multicast
address at this sub-layer. For a MAC-layer protocol,
this includes both Group and Functional addresses.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
For packet-oriented interfaces, the number of inbound
packets that contained errors preventing them from being
deliverable to a higher-layer protocol. For character-
oriented or fixed-length interfaces, the number of
inbound transmission units that contained errors
preventing them from being deliverable to a higher-layer
protocol.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of inbound packets that 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.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of octets transmitted out of the
interface, including framing characters.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets transmitted out of the
interface, including all unicast, multicast, broadcast,
and bad packets etc.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets that higher-level protocols
requested be transmitted, and that were not addressed
to a multicast or broadcast address at this sub-layer,
including those that were discarded or not sent.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets that higher-level protocols
requested be transmitted, and that were addressed to a
broadcast address at this sub-layer, including those
that were discarded or not sent.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets that higher-level protocols
requested be transmitted, and that were addressed to a
multicast address at this sub-layer, including those
that were discarded or not sent. For a MAC-layer
protocol, this includes both Group and Functional
addresses.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of outbound packets that 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.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
For packet-oriented interfaces, the number of outbound
packets that could not be transmitted because of errors.
For character-oriented or fixed-length interfaces, the
number of outbound transmission units that could not be
transmitted because of errors.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Timestamp of the last time the interface counters were
cleared.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
For packet-oriented interfaces, the number of packets
received via the interface that were discarded because
of an unknown or unsupported protocol. For
character-oriented or fixed-length interfaces that
support protocol multiplexing, the number of
transmission units received via the interface that were
discarded because of an unknown or unsupported protocol.
For any interface that does not support protocol
multiplexing, this counter is not present.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of received packets which had errors in the
frame check sequence (FCS), i.e., framing errors.
Discontinuities in the value of this counter can occur
when the device is re-initialization as indicated by the
value of 'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of times the interface state has transitioned
between up and down since the time the device restarted
or the last-clear time, whichever is most recent.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of times the interface hardware has been reset. The
triggers and effects of this event are hardware-specifc.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Optionally set the tag protocol identifier field (TPID) that
is accepted on the VLAN
nodetype: leaf (ro)
type: identityref
default: oc-vlan-types:TPID_0X8100
description:
Top-level container for hold-time settings to enable
dampening advertisements of interface transitions.
nodetype: container (rw)
description:
Configuration data for interface hold-time settings.
nodetype: container (rw)
description:
Dampens advertisement when the interface
transitions from down to up. A zero value means dampening
is turned off, i.e., immediate notification.
nodetype: leaf (rw)
type: uint32
default: 0
units: milliseconds
description:
Dampens advertisement when the interface transitions from
up to down. A zero value means dampening is turned off,
i.e., immediate notification.
nodetype: leaf (rw)
type: uint32
default: 0
units: milliseconds
description:
Operational state data for interface hold-time.
nodetype: container (ro)
description:
Dampens advertisement when the interface
transitions from down to up. A zero value means dampening
is turned off, i.e., immediate notification.
nodetype: leaf (ro)
type: uint32
default: 0
units: milliseconds
description:
Dampens advertisement when the interface transitions from
up to down. A zero value means dampening is turned off,
i.e., immediate notification.
nodetype: leaf (ro)
type: uint32
default: 0
units: milliseconds
description:
Top level container to suppress UP->DOWN link events using a penalty based additive-increase, exponential-decrease algorithm.
nodetype: container (rw)
description:
Configuration data for link damping settings.
nodetype: container (rw)
description:
Maximum time an interface can remain damped since the last link down event no matter how unstable it has been prior to this period of stability. In a damped state, the interface's state change will not be advertised.
nodetype: leaf (rw)
type: uint32
default: 0
units: milliseconds
description:
The amount of time after which an interface's penalty is decreased by half. Decay-half-time should not be more than max-suppress-time.
nodetype: leaf (rw)
type: uint32
default: 0
units: milliseconds
description:
The accumulated penalty that triggers the damping of an interface. A value of 0 indicates config is disabled.
nodetype: leaf (rw)
type: uint32
default: 0
description:
When the accumulated penalty decreases to this reuse threshold, the interface is not damped anymore. Interface state changes are advertised to applications. A value of 0 indicates config is disabled.
nodetype: leaf (rw)
type: uint32
default: 0
description:
A penalty that each down event costs. A value of 0 indicates the config is disabled.
nodetype: leaf (rw)
type: uint32
default: 0
description:
Operational state data for link damping settings.
nodetype: container (ro)
description:
Maximum time an interface can remain damped since the last link down event no matter how unstable it has been prior to this period of stability. In a damped state, the interface's state change will not be advertised.
nodetype: leaf (ro)
type: uint32
default: 0
units: milliseconds
description:
The amount of time after which an interface's penalty is decreased by half. Decay-half-time should not be more than max-suppress-time.
nodetype: leaf (ro)
type: uint32
default: 0
units: milliseconds
description:
The accumulated penalty that triggers the damping of an interface. A value of 0 indicates config is disabled.
nodetype: leaf (ro)
type: uint32
default: 0
description:
When the accumulated penalty decreases to this reuse threshold, the interface is not damped anymore. Interface state changes are advertised to applications. A value of 0 indicates config is disabled.
nodetype: leaf (ro)
type: uint32
default: 0
description:
A penalty that each down event costs. A value of 0 indicates the config is disabled.
nodetype: leaf (ro)
type: uint32
default: 0
description:
Enclosing container for the list of subinterfaces associated
with a physical interface
nodetype: container (rw)
description:
The list of subinterfaces (logical interfaces) associated
with a physical interface
nodetype: list (rw)
list keys: [index]
description:
The index number of the subinterface -- used to address
the logical interface
nodetype: leaf (list key) (rw)
type: leafref
description:
Configurable items at the subinterface level
nodetype: container (rw)
description:
The index of the subinterface, or logical interface number.
On systems with no support for subinterfaces, or not using
subinterfaces, this value should default to 0, i.e., the
default subinterface.
nodetype: leaf (rw)
type: uint32
default: 0
description:
A textual description of the interface.
A server implementation MAY map this leaf to the ifAlias
MIB object. Such an implementation needs to use some
mechanism to handle the differences in size and characters
allowed between this leaf and ifAlias. The definition of
such a mechanism is outside the scope of this document.
Since ifAlias is defined to be stored in non-volatile
storage, the MIB implementation MUST map ifAlias to the
value of 'description' in the persistently stored
datastore.
Specifically, if the device supports ':startup', when
ifAlias is read the device MUST return the value of
'description' in the 'startup' datastore, and when it is
written, it MUST be written to the 'running' and 'startup'
datastores. Note that it is up to the implementation to
decide whether to modify this single leaf in 'startup' or
perform an implicit copy-config from 'running' to
'startup'.
If the device does not support ':startup', ifAlias MUST
be mapped to the 'description' leaf in the 'running'
datastore.
nodetype: leaf (rw)
type: string
description:
This leaf contains the configured, desired state of the
interface.
Systems that implement the IF-MIB use the value of this
leaf in the 'running' datastore to set
IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry
has been initialized, as described in RFC 2863.
Changes in this leaf in the 'running' datastore are
reflected in ifAdminStatus, but if ifAdminStatus is
changed over SNMP, this leaf is not affected.
nodetype: leaf (rw)
type: boolean
default: true
description:
Operational state data for logical interfaces
nodetype: container (ro)
description:
The index of the subinterface, or logical interface number.
On systems with no support for subinterfaces, or not using
subinterfaces, this value should default to 0, i.e., the
default subinterface.
nodetype: leaf (ro)
type: uint32
default: 0
description:
A textual description of the interface.
A server implementation MAY map this leaf to the ifAlias
MIB object. Such an implementation needs to use some
mechanism to handle the differences in size and characters
allowed between this leaf and ifAlias. The definition of
such a mechanism is outside the scope of this document.
Since ifAlias is defined to be stored in non-volatile
storage, the MIB implementation MUST map ifAlias to the
value of 'description' in the persistently stored
datastore.
Specifically, if the device supports ':startup', when
ifAlias is read the device MUST return the value of
'description' in the 'startup' datastore, and when it is
written, it MUST be written to the 'running' and 'startup'
datastores. Note that it is up to the implementation to
decide whether to modify this single leaf in 'startup' or
perform an implicit copy-config from 'running' to
'startup'.
If the device does not support ':startup', ifAlias MUST
be mapped to the 'description' leaf in the 'running'
datastore.
nodetype: leaf (ro)
type: string
description:
This leaf contains the configured, desired state of the
interface.
Systems that implement the IF-MIB use the value of this
leaf in the 'running' datastore to set
IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry
has been initialized, as described in RFC 2863.
Changes in this leaf in the 'running' datastore are
reflected in ifAdminStatus, but if ifAdminStatus is
changed over SNMP, this leaf is not affected.
nodetype: leaf (ro)
type: boolean
default: true
description:
The system-assigned name for the sub-interface. This MAY
be a combination of the base interface name and the
subinterface index, or some other convention used by the
system.
nodetype: leaf (ro)
type: string
description:
System assigned number for each interface. Corresponds to
ifIndex object in SNMP Interface MIB
nodetype: leaf (ro)
type: uint32
description:
The desired state of the interface. In RFC 7223 this leaf
has the same read semantics as ifAdminStatus. Here, it
reflects the administrative state as set by enabling or
disabling the interface.
nodetype: leaf (ro)
type: enumeration
description:
The current operational state of the interface.
This leaf has the same semantics as ifOperStatus.
nodetype: leaf (ro)
type: enumeration
description:
This timestamp indicates the absolute time of the last
state change of the interface (e.g., up-to-down transition).
This is different than the SNMP ifLastChange object in the
standard interface MIB in that it is not relative to the
system boot time (i.e,. sysUpTime).
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
When set to true, the interface is a logical interface
which does not have an associated physical port or
channel on the system.
nodetype: leaf (ro)
type: boolean
description:
When set to true, the interface is a dedicated
management interface that is not connected to dataplane
interfaces. It may be used to connect the system to an
out-of-band management network, for example.
nodetype: leaf (ro)
type: boolean
description:
When set to true, the interface is for traffic
that is handled by the system CPU, sometimes also called the
control plane interface. On systems that represent the CPU
interface as an Ethernet interface, for example, this leaf
should be used to distinguish the CPU interface from dataplane
interfaces.
nodetype: leaf (ro)
type: boolean
description:
A collection of interface specific statistics entitites which are
not common to subinterfaces.
nodetype: container (ro)
description:
The total number of octets received on the interface,
including framing characters.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets received on the interface,
including all unicast, multicast, broadcast and bad packets
etc.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of packets, delivered by this sub-layer to a
higher (sub-)layer, that were not addressed to a
multicast or broadcast address at this sub-layer.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of packets, delivered by this sub-layer to a
higher (sub-)layer, that were addressed to a broadcast
address at this sub-layer.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of packets, delivered by this sub-layer to a
higher (sub-)layer, that were addressed to a multicast
address at this sub-layer. For a MAC-layer protocol,
this includes both Group and Functional addresses.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
For packet-oriented interfaces, the number of inbound
packets that contained errors preventing them from being
deliverable to a higher-layer protocol. For character-
oriented or fixed-length interfaces, the number of
inbound transmission units that contained errors
preventing them from being deliverable to a higher-layer
protocol.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of inbound packets that 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.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of octets transmitted out of the
interface, including framing characters.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets transmitted out of the
interface, including all unicast, multicast, broadcast,
and bad packets etc.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets that higher-level protocols
requested be transmitted, and that were not addressed
to a multicast or broadcast address at this sub-layer,
including those that were discarded or not sent.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets that higher-level protocols
requested be transmitted, and that were addressed to a
broadcast address at this sub-layer, including those
that were discarded or not sent.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of packets that higher-level protocols
requested be transmitted, and that were addressed to a
multicast address at this sub-layer, including those
that were discarded or not sent. For a MAC-layer
protocol, this includes both Group and Functional
addresses.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of outbound packets that 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.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
For packet-oriented interfaces, the number of outbound
packets that could not be transmitted because of errors.
For character-oriented or fixed-length interfaces, the
number of outbound transmission units that could not be
transmitted because of errors.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Timestamp of the last time the interface counters were
cleared.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
For packet-oriented interfaces, the number of packets
received via the interface that were discarded because
of an unknown or unsupported protocol. For
character-oriented or fixed-length interfaces that
support protocol multiplexing, the number of
transmission units received via the interface that were
discarded because of an unknown or unsupported protocol.
For any interface that does not support protocol
multiplexing, this counter is not present.
Discontinuities in the value of this counter can occur
at re-initialization of the management system, and at
other times as indicated by the value of
'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of received packets which had errors in the
frame check sequence (FCS), i.e., framing errors.
Discontinuities in the value of this counter can occur
when the device is re-initialization as indicated by the
value of 'last-clear'.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of times the interface state has transitioned
between up and down since the time the device restarted
or the last-clear time, whichever is most recent.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Enclosing container for VLAN interface-specific
data on subinterfaces
nodetype: container (rw)
description:
Configuration parameters for VLANs
nodetype: container (rw)
description:
VLAN id for the subinterface -- specified inline for the
case of a local VLAN. The id is scoped to the
subinterface, and could be repeated on different
subinterfaces.
Deprecation note: See adjacent elements in the 'vlan' container for
making more expressive VLAN matches.
nodetype: leaf (rw)
type: union
type: oc-vlan-types:vlan-id
type: oc-vlan-types:qinq-id
description:
State variables for VLANs
nodetype: container (ro)
description:
VLAN id for the subinterface -- specified inline for the
case of a local VLAN. The id is scoped to the
subinterface, and could be repeated on different
subinterfaces.
Deprecation note: See adjacent elements in the 'vlan' container for
making more expressive VLAN matches.
nodetype: leaf (ro)
type: union
type: oc-vlan-types:vlan-id
type: oc-vlan-types:qinq-id
description:
Configuration for various VLAN tag matching schemes,
including single-tagged 802.1q packets and double-tagged
802.1ad 'Q-in-Q' packets. Typically only one of the subordinate
containers should be specified.
Wildcards may be matched by specifying range values of 2-4094.
If implementations have a more efficient way to match Wildcards
then they should recognize this pattern and translate accordingly.
Implementations are expected to return errors for combinations
that they do not support, or provide deviations to the same effect.
For simple VLAN configurations without an 'egress-mapping' then
using the 'single-tagged' and 'double-tagged' VLAN matches that
resolve to specific values, these specify the VLAN identifiers
applied to packets on egress.
nodetype: container (rw)
description:
Match single-tagged packets with an exact VLAN identifier.
nodetype: container (rw)
description:
Configuration for matching single-tagged packets with an exact
VLAN identifier.
nodetype: container (rw)
description:
VLAN identifier for single-tagged packets.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
State for matching single-tagged packets with an exact VLAN
identifier.
nodetype: container (ro)
description:
VLAN identifier for single-tagged packets.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Match single-tagged packets with a list of VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching single-tagged packets with a list of
VLAN identifiers.
nodetype: container (rw)
description:
VLAN identifiers for single-tagged packets.
nodetype: leaf-list (rw)
type: oc-vlan-types:vlan-id
description:
State for matching single-tagged packets with a list of VLAN
identifiers.
nodetype: container (ro)
description:
VLAN identifiers for single-tagged packets.
nodetype: leaf-list (ro)
type: oc-vlan-types:vlan-id
description:
Match single-tagged packets with a range of VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching single-tagged packets with a range of
VLAN identifiers.
nodetype: container (rw)
description:
The low-value VLAN identifier in a range for single-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The high-value VLAN identifier in a range for single-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
State for matching single-tagged packets with a range of VLAN
identifiers.
nodetype: container (ro)
description:
The low-value VLAN identifier in a range for single-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The high-value VLAN identifier in a range for single-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Match double-tagged packets against inner exact and outer exact
VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching double-tagged packets against inner
exact and outer exact VLAN identifiers.
nodetype: container (rw)
description:
Inner VLAN identifier for double-tagged packets.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifier for double-tagged packets.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
State for matching double-tagged packets against inner exact
and outer exact VLAN identifiers.
nodetype: container (ro)
description:
Inner VLAN identifier for double-tagged packets.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifier for double-tagged packets.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Match double-tagged packets against an inner list and outer exact
VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching double-tagged packets against an
inner list and outer exact VLAN identifiers.
nodetype: container (rw)
description:
Inner VLAN identifiers for double-tagged packets.
nodetype: leaf-list (rw)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifier for double-tagged packets.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
State for matching double-tagged packets against an inner list
and outer exact VLAN identifiers.
nodetype: container (ro)
description:
Inner VLAN identifiers for double-tagged packets.
nodetype: leaf-list (ro)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifier for double-tagged packets.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Match double-tagged packets against an inner exact and outer list
of VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching double-tagged packets against an
inner exact and outer list of VLAN identifiers.
nodetype: container (rw)
description:
Inner VLAN identifier for double-tagged packets.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifiers for double-tagged packets.
nodetype: leaf-list (rw)
type: oc-vlan-types:vlan-id
description:
State for matching double-tagged packets against an inner
exact and outer list of VLAN identifiers.
nodetype: container (ro)
description:
Inner VLAN identifier for double-tagged packets.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifiers for double-tagged packets.
nodetype: leaf-list (ro)
type: oc-vlan-types:vlan-id
description:
Match double-tagged packets against an inner range and outer
exact VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching double-tagged packets against an
inner range and outer exact VLAN identifiers.
nodetype: container (rw)
description:
The low-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The high-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifier of double-tagged packets.
nodetype: leaf-list (rw)
type: oc-vlan-types:vlan-id
description:
State for matching double-tagged packets against an inner
range and outer exact VLAN identifiers.
nodetype: container (ro)
description:
The low-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The high-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Outer VLAN identifier of double-tagged packets.
nodetype: leaf-list (ro)
type: oc-vlan-types:vlan-id
description:
Match double-tagged packets against an inner exact and an outer
range of VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching double-tagged packets against an
inner exact and an outer range of VLAN identifiers.
nodetype: container (rw)
description:
Inner VLAN identifier for double-tagged packets.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The low-value outer VLAN identifier for double-tagged packets.
The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The high-value outer VLAN identifier for double-tagged packets.
The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
State for matching double-tagged packets against an inner
exact and an outer range of VLAN identifiers.
nodetype: container (ro)
description:
Inner VLAN identifier for double-tagged packets.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The low-value outer VLAN identifier for double-tagged packets.
The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The high-value outer VLAN identifier for double-tagged packets.
The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Match double-tagged packets against an inner range and an outer
range of VLAN identifiers.
nodetype: container (rw)
description:
Configuration for matching double-tagged packets against an
inner range and an outer range of VLAN identifiers.
nodetype: container (rw)
description:
The low-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The high-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The low-value outer VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
The high-value outer VLAN identifier for double-tagged packets.
The range is matched inclusively.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
State for matching double-tagged packets against an inner
range and an outer range of VLAN identifiers.
nodetype: container (ro)
description:
The low-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The high-value inner VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The low-value outer VLAN identifier in a range for double-tagged
packets. The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
The high-value outer VLAN identifier for double-tagged packets.
The range is matched inclusively.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Ingress VLAN stack behaviors for packets that arrive on
this subinterface after their VLAN idenitifer(s) have been
matched.
nodetype: container (rw)
description:
Configuration for ingress VLAN and label behaviors for
packets that arrive on this subinterface after their VLAN
identifier(s) have been matched.
nodetype: container (rw)
description:
The action to take on the VLAN stack of a packet. This is
optionally used in conjunction with adjacent leaves to override
the values of the action.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-stack-action
description:
Optionally specifies a fixed VLAN identifier that is used by the
action configured in 'vlan-stack-action'. For example, if the action
is 'PUSH' then this VLAN identifier is added to the the stack.
This value must be non-zero if the 'vlan-stack-action' is one of
'PUSH' or 'SWAP'.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Optionally override the tag protocol identifier field (TPID) that
is used by the action configured by 'vlan-stack-action' when
modifying the VLAN stack.
nodetype: leaf (rw)
type: identityref
description:
State for ingress VLAN and label behaviors for packets
that arrive on this subinterface.
nodetype: container (ro)
description:
The action to take on the VLAN stack of a packet. This is
optionally used in conjunction with adjacent leaves to override
the values of the action.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-stack-action
description:
Optionally specifies a fixed VLAN identifier that is used by the
action configured in 'vlan-stack-action'. For example, if the action
is 'PUSH' then this VLAN identifier is added to the the stack.
This value must be non-zero if the 'vlan-stack-action' is one of
'PUSH' or 'SWAP'.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Optionally override the tag protocol identifier field (TPID) that
is used by the action configured by 'vlan-stack-action' when
modifying the VLAN stack.
nodetype: leaf (ro)
type: identityref
description:
Egress VLAN and label behaviors for packets that are
destined for output via this subinterface.
nodetype: container (rw)
description:
Configuration for egress VLAN stack behaviors for
packets that are destined for output via this subinterface.
nodetype: container (rw)
description:
The action to take on the VLAN stack of a packet. This is
optionally used in conjunction with adjacent leaves to override
the values of the action.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-stack-action
description:
Optionally specifies a fixed VLAN identifier that is used by the
action configured in 'vlan-stack-action'. For example, if the action
is 'POP' then a VLAN identifier is removed from the stack but the
value of this leaf is used instead. This value must be non-zero if
the 'vlan-stack-action' is one of 'PUSH' or 'SWAP'.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Optionally override the tag protocol identifier field (TPID) that
is used by the action configured by 'vlan-stack-action' when
modifying the VLAN stack.
nodetype: leaf (rw)
type: identityref
description:
State for engress VLAN stack behaviors for packets
that are destined for output via this subinterface.
nodetype: container (ro)
description:
The action to take on the VLAN stack of a packet. This is
optionally used in conjunction with adjacent leaves to override
the values of the action.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-stack-action
description:
Optionally specifies a fixed VLAN identifier that is used by the
action configured in 'vlan-stack-action'. For example, if the action
is 'POP' then a VLAN identifier is removed from the stack but the
value of this leaf is used instead. This value must be non-zero if
the 'vlan-stack-action' is one of 'PUSH' or 'SWAP'.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Optionally override the tag protocol identifier field (TPID) that
is used by the action configured by 'vlan-stack-action' when
modifying the VLAN stack.
nodetype: leaf (ro)
type: identityref
description:
Top-level container for ethernet configuration
and state
nodetype: container (rw)
description:
Configuration data for ethernet interfaces
nodetype: container (rw)
description:
Assigns a MAC address to the Ethernet interface. If not
specified, the corresponding operational state leaf is
expected to show the system-assigned MAC address.
nodetype: leaf (rw)
type: oc-yang:mac-address
description:
Set to TRUE to request the interface to auto-negotiate
transmission parameters with its peer interface. When
set to FALSE, the transmission parameters are specified
manually.
nodetype: leaf (rw)
type: boolean
default: true
description:
Link training is automatic tuning of the SerDes transmit and
receive parameters to ensure an optimal connection over copper
links. It is normally run as part of the auto negotiation
sequence as specified in IEEE 802.3 Clause 73.
Standalone link training is used when full auto negotiation is
not desired on an Ethernet link but link training is needed.
It is configured by setting the standalone-link-training leaf
to TRUE and augo-negotiate leaf to FALSE.
Note: If auto-negotiate is true, then the value of standalone
link training leaf will be ignored.
nodetype: leaf (rw)
type: boolean
default: false
description:
When auto-negotiate is TRUE, this optionally sets the
duplex mode that will be advertised to the peer. If
unspecified, the interface should negotiate the duplex mode
directly (typically full-duplex). When auto-negotiate is
FALSE, this sets the duplex mode on the interface directly.
nodetype: leaf (rw)
type: enumeration
description:
When auto-negotiate is TRUE, this optionally sets the
port-speed mode that will be advertised to the peer for
negotiation. If unspecified, it is expected that the
interface will select the highest speed available based on
negotiation. When auto-negotiate is set to FALSE, sets the
link speed to a fixed value -- supported values are defined
by ETHERNET_SPEED identities
nodetype: leaf (rw)
type: identityref
description:
Enable or disable flow control for this interface.
Ethernet flow control is a mechanism by which a receiver
may send PAUSE frames to a sender to stop transmission for
a specified time.
This setting should override auto-negotiated flow control
settings. If left unspecified, and auto-negotiate is TRUE,
flow control mode is negotiated with the peer interface.
nodetype: leaf (rw)
type: boolean
default: false
description:
The FEC mode applied to the physical channels associated with
the interface.
nodetype: leaf (rw)
type: identityref
description:
Specify the logical aggregate interface to which
this interface belongs
nodetype: leaf (rw)
type: leafref
description:
State variables for Ethernet interfaces
nodetype: container (ro)
description:
Assigns a MAC address to the Ethernet interface. If not
specified, the corresponding operational state leaf is
expected to show the system-assigned MAC address.
nodetype: leaf (ro)
type: oc-yang:mac-address
description:
Set to TRUE to request the interface to auto-negotiate
transmission parameters with its peer interface. When
set to FALSE, the transmission parameters are specified
manually.
nodetype: leaf (ro)
type: boolean
default: true
description:
Link training is automatic tuning of the SerDes transmit and
receive parameters to ensure an optimal connection over copper
links. It is normally run as part of the auto negotiation
sequence as specified in IEEE 802.3 Clause 73.
Standalone link training is used when full auto negotiation is
not desired on an Ethernet link but link training is needed.
It is configured by setting the standalone-link-training leaf
to TRUE and augo-negotiate leaf to FALSE.
Note: If auto-negotiate is true, then the value of standalone
link training leaf will be ignored.
nodetype: leaf (ro)
type: boolean
default: false
description:
When auto-negotiate is TRUE, this optionally sets the
duplex mode that will be advertised to the peer. If
unspecified, the interface should negotiate the duplex mode
directly (typically full-duplex). When auto-negotiate is
FALSE, this sets the duplex mode on the interface directly.
nodetype: leaf (ro)
type: enumeration
description:
When auto-negotiate is TRUE, this optionally sets the
port-speed mode that will be advertised to the peer for
negotiation. If unspecified, it is expected that the
interface will select the highest speed available based on
negotiation. When auto-negotiate is set to FALSE, sets the
link speed to a fixed value -- supported values are defined
by ETHERNET_SPEED identities
nodetype: leaf (ro)
type: identityref
description:
Enable or disable flow control for this interface.
Ethernet flow control is a mechanism by which a receiver
may send PAUSE frames to a sender to stop transmission for
a specified time.
This setting should override auto-negotiated flow control
settings. If left unspecified, and auto-negotiate is TRUE,
flow control mode is negotiated with the peer interface.
nodetype: leaf (ro)
type: boolean
default: false
description:
The FEC mode applied to the physical channels associated with
the interface.
nodetype: leaf (ro)
type: identityref
description:
Represents the 'burned-in', or system-assigned, MAC
address for the Ethernet interface.
nodetype: leaf (ro)
type: oc-yang:mac-address
description:
When auto-negotiate is set to TRUE, and the interface has
completed auto-negotiation with the remote peer, this value
shows the duplex mode that has been negotiated.
nodetype: leaf (ro)
type: enumeration
description:
When auto-negotiate is set to TRUE, and the interface has
completed auto-negotiation with the remote peer, this value
shows the interface speed that has been negotiated.
nodetype: leaf (ro)
type: identityref
description:
Ethernet interface counters
nodetype: container (ro)
description:
MAC layer control frames received on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
MAC layer PAUSE frames received on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that were
longer than 1518 octets (excluding framing bits,
but including FCS octets) and were otherwise
well formed.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that were
less than 64 octets long (excluding framing bits,
but including FCS octets) and were otherwise well
formed.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of jabber frames received on the
interface. Jabber frames are typically defined as oversize
frames which also have a bad CRC. Implementations may use
slightly different definitions of what constitutes a jabber
frame. Often indicative of a NIC hardware problem.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that were less than
64 octets in length (excluding framing bits but including
FCS octets) and had either a bad Frame Check Sequence
(FCS) with an integral number of octets (FCS Error) or a
bad FCS with a non-integral number of octets (Alignment
Error).
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of 802.1q tagged frames received on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that
had a length (excluding framing bits, but
including FCS octets) of between 64 and 1518
octets, inclusive, but had either a bad
Frame Check Sequence (FCS) with an integral
number of octets (FCS Error) or a bad FCS with
a non-integral number of octets (Alignment Error)
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored blocks. Error detection codes
are capable of detecting whether one or more errors have
occurred in a given sequence of bits – the block. It is
normally not possible to determine the exact number of errored
bits within the block
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to a carrier issue.
The value refers to MIB counter for
dot3StatsCarrierSenseErrors
oid=1.3.6.1.2.1.10.7.2.1.11
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to interrupted
transmission issue. The value refers to MIB counter for
dot3StatsDeferredTransmissions
oid=1.3.6.1.2.1.10.7.2.1.7
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to late collision
issue. The value refers to MIB counter for
dot3StatsLateCollisions
oid=1.3.6.1.2.1.10.7.2.1.8
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to MAC errors
received. The value refers to MIB counter for
dot3StatsInternalMacReceiveErrors
oid=1.3.6.1.2.1.10.7.2.1.16
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to single collision
issue. The value refers to MIB counter for
dot3StatsSingleCollisionFrames
oid=1.3.6.1.2.1.10.7.2.1.4
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to symbol error.
The value refers to MIB counter for
in-symbol-error
oid=1.3.6.1.2.1.10.7.2.1.18
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number frames received that are well-formed but
dropped due to exceeding the maximum frame size on the interface
(e.g., MTU or MRU)
nodetype: leaf (ro)
type: oc-yang:counter64
description:
MAC layer control frames sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
MAC layer PAUSE frames sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of 802.1q tagged frames sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of sent errored frames due to MAC errors
transmitted. The value refers to MIB counter for
dot3StatsInternalMacTransmitErrors
oid=1.3.6.1.2.1.10.7.2.1.10
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Specify the logical aggregate interface to which
this interface belongs
nodetype: leaf (ro)
type: leafref
description:
Enclosing container for VLAN interface-specific
data on Ethernet interfaces. These are for standard
L2, switched-style VLANs.
nodetype: container (rw)
description:
Configuration parameters for VLANs
nodetype: container (rw)
description:
Set the interface to access or trunk mode for
VLANs
nodetype: leaf (rw)
type: oc-vlan-types:vlan-mode-type
description:
Set the native VLAN id for untagged frames arriving on
a trunk interface. Tagged frames sent on an interface
configured with a native VLAN should have their tags
stripped prior to transmission. This configuration is only
valid on a trunk interface.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Assign the access vlan to the access port.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Specify VLANs, or ranges thereof, that the interface may
carry when in trunk mode. If not specified, all VLANs are
allowed on the interface. Ranges are specified in the form
x..y, where x
nodetype: leaf-list (rw)
type: union
type: oc-vlan-types:vlan-id
type: oc-vlan-types:vlan-range
description:
State variables for VLANs
nodetype: container (ro)
description:
Set the interface to access or trunk mode for
VLANs
nodetype: leaf (ro)
type: oc-vlan-types:vlan-mode-type
description:
Set the native VLAN id for untagged frames arriving on
a trunk interface. Tagged frames sent on an interface
configured with a native VLAN should have their tags
stripped prior to transmission. This configuration is only
valid on a trunk interface.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Assign the access vlan to the access port.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Specify VLANs, or ranges thereof, that the interface may
carry when in trunk mode. If not specified, all VLANs are
allowed on the interface. Ranges are specified in the form
x..y, where x
nodetype: leaf-list (ro)
type: union
type: oc-vlan-types:vlan-id
type: oc-vlan-types:vlan-range
description:
Options for logical interfaces representing
aggregates
nodetype: container (rw)
description:
Configuration variables for logical aggregate /
LAG interfaces
nodetype: container (rw)
description:
Sets the type of LAG, i.e., how it is
configured / maintained
nodetype: leaf (rw)
type: aggregation-type
description:
Specifies the mininum number of member
interfaces that must be active for the aggregate interface
to be available
nodetype: leaf (rw)
type: uint16
description:
Operational state variables for logical
aggregate / LAG interfaces
nodetype: container (ro)
description:
Sets the type of LAG, i.e., how it is
configured / maintained
nodetype: leaf (ro)
type: aggregation-type
description:
Specifies the mininum number of member
interfaces that must be active for the aggregate interface
to be available
nodetype: leaf (ro)
type: uint16
description:
Reports effective speed of the aggregate interface,
based on speed of active member interfaces
nodetype: leaf (ro)
type: uint32
units: Mbps
description:
List of current member interfaces for the aggregate,
expressed as references to existing interfaces
nodetype: leaf-list (ro)
type: oc-if:base-interface-ref
description:
Enclosing container for VLAN interface-specific
data on Ethernet interfaces. These are for standard
L2, switched-style VLANs.
nodetype: container (rw)
description:
Configuration parameters for VLANs
nodetype: container (rw)
description:
Set the interface to access or trunk mode for
VLANs
nodetype: leaf (rw)
type: oc-vlan-types:vlan-mode-type
description:
Set the native VLAN id for untagged frames arriving on
a trunk interface. Tagged frames sent on an interface
configured with a native VLAN should have their tags
stripped prior to transmission. This configuration is only
valid on a trunk interface.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Assign the access vlan to the access port.
nodetype: leaf (rw)
type: oc-vlan-types:vlan-id
description:
Specify VLANs, or ranges thereof, that the interface may
carry when in trunk mode. If not specified, all VLANs are
allowed on the interface. Ranges are specified in the form
x..y, where x
nodetype: leaf-list (rw)
type: union
type: oc-vlan-types:vlan-id
type: oc-vlan-types:vlan-range
description:
State variables for VLANs
nodetype: container (ro)
description:
Set the interface to access or trunk mode for
VLANs
nodetype: leaf (ro)
type: oc-vlan-types:vlan-mode-type
description:
Set the native VLAN id for untagged frames arriving on
a trunk interface. Tagged frames sent on an interface
configured with a native VLAN should have their tags
stripped prior to transmission. This configuration is only
valid on a trunk interface.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Assign the access vlan to the access port.
nodetype: leaf (ro)
type: oc-vlan-types:vlan-id
description:
Specify VLANs, or ranges thereof, that the interface may
carry when in trunk mode. If not specified, all VLANs are
allowed on the interface. Ranges are specified in the form
x..y, where x
nodetype: leaf-list (ro)
type: union
type: oc-vlan-types:vlan-id
type: oc-vlan-types:vlan-range
description:
Top-level container for routed vlan interfaces. These
logical interfaces are also known as SVI (switched virtual
interface), IRB (integrated routing and bridging), RVI
(routed VLAN interface)
nodetype: container (rw)
description:
Configuration data for routed vlan interfaces
nodetype: container (rw)
description:
References the VLAN for which this IP interface
provides routing services -- similar to a switch virtual
interface (SVI), or integrated routing and bridging interface
(IRB) in some implementations.
nodetype: leaf (rw)
type: union
type: uint16
type: string
description:
Operational state data
nodetype: container (ro)
description:
References the VLAN for which this IP interface
provides routing services -- similar to a switch virtual
interface (SVI), or integrated routing and bridging interface
(IRB) in some implementations.
nodetype: leaf (ro)
type: union
type: uint16
type: string
Model for managing aggregated (aka bundle, LAG) interfaces.
openconfig-interfaces
openconfig-if-ethernet
iana-if-type
openconfig-extensions
description:
Type to define the lag-type, i.e., how the LAG is
defined and managed
type: enumeration
Model for managing Ethernet interfaces -- augments the OpenConfig model for interface configuration and state.
openconfig-interfaces
iana-if-type
openconfig-yang-types
openconfig-extensions
description:
Base type to specify FEC modes that can be configured on the interface.
These are FEC modes defined for applying to logical interfaces and their
underlying electrical channels.
description:
Firecode is used for channels with NRZ modulation and speeds less than 100G.
This FEC is designed to comply with the IEEE 802.3, Clause 74.
base identity: INTERFACE_FEC
description:
RS528 is used for channels with NRZ modulation. This FEC is designed to
comply with IEEE 802.3, Clause 91.
base identity: INTERFACE_FEC
description:
RS544 is used for channels with PAM4 modulation.
base identity: INTERFACE_FEC
description:
RS544-2x-interleave is used for channels with PAM4 modulation.
base identity: INTERFACE_FEC
description:
FEC is administratively disabled.
base identity: INTERFACE_FEC
description:
base type to specify available Ethernet link
speeds
description:
10 Mbps Ethernet
base identity: ETHERNET_SPEED
description:
100 Mbps Ethernet
base identity: ETHERNET_SPEED
description:
1 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
2.5 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
5 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
10 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
25 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
40 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
50 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
100 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
200 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
400 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
600 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
800 Gbps Ethernet
base identity: ETHERNET_SPEED
description:
Interface speed is unknown. Systems may report
speed UNKNOWN when an interface is down or unpopuplated (e.g.,
pluggable not present).
base identity: ETHERNET_SPEED