openconfig-p4rt

openconfig-version: 0.4.0

Description

This module defines a set of extensions that provide P4Runtime (P4RT) specific extensions to the OpenConfig data models. Specifically, these parameters for configuration and state provide extensions that control the P4RT service, or allow it to be used alongside other OpenConfig data models.

The P4RT protocol specification is linked from https://p4.org/specs/ under the P4Runtime heading.

Imports

openconfig-extensions
openconfig-interfaces
openconfig-platform
openconfig-system-grpc

Identities

Data elements

openconfig-interfaces

openconfig-version: 2.5.0

Description

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).

Imports

ietf-interfaces
openconfig-yang-types
openconfig-types
openconfig-extensions

Defined types

base-interface-ref

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

  • path reference: /interfaces/interface/name

interface-id

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

Data elements

/
interfaces

description:
Top level container for interfaces, including configuration and state data.

nodetype: container (rw)

/interfaces/
interface

description:
The list of named interfaces on the device.

nodetype: list (rw)

list keys: [name]

/interfaces/interface/
name

description:
References the name of the interface

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/interfaces/interface/
config

description:
Configurable items at the global, physical interface level

nodetype: container (rw)

/interfaces/interface/config/
name

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

/interfaces/interface/config/
type

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

  • base: ietf-if:interface-type

/interfaces/interface/config/
mtu

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

/interfaces/interface/config/
loopback-mode

description:
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.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/config/
description

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

/interfaces/interface/config/
enabled

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

/interfaces/interface/config/
tpid

description:
Optionally set the tag protocol identifier field (TPID) that is accepted on the VLAN

nodetype: leaf (rw)

type: identityref

  • base: oc-vlan-types:TPID_TYPES

default: oc-vlan-types:TPID_0X8100

/interfaces/interface/config/
id

description:
The numeric identifier (SDN Port) used by the controller to address the interface. This ID is assigned by an external-to-the-device entity (e.g., an SDN management system) to establish an externally deterministic numeric reference for the interface. The programming entity must ensure that the ID is unique within the required context. Note that this identifier is used only when a numeric reference to the interface is required, it does not replace the unique name assigned to the interface. Ranges: 0x00000000: Unspecified/Invalid 0x00000001: Minimum Port Value 0xFFFFFEFF: Maximum Port Value Reserved: 0xFFFFFFF0 - 0xFFFFFFFF 0xFFFFFFFA: Recirculate 0xFFFFFFFD: CPU

nodetype: leaf (rw)

type: uint32

  • range: 1..4294967039

/interfaces/interface/
state

description:
Operational state data at the global interface level

nodetype: container (ro)

/interfaces/interface/state/
name

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

/interfaces/interface/state/
type

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

  • base: ietf-if:interface-type

/interfaces/interface/state/
mtu

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

/interfaces/interface/state/
loopback-mode

description:
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.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/state/
description

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

/interfaces/interface/state/
enabled

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

/interfaces/interface/state/
ifindex

description:
System assigned number for each interface. Corresponds to ifIndex object in SNMP Interface MIB

nodetype: leaf (ro)

type: uint32

/interfaces/interface/state/
admin-status

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

  • UP
    Ready to pass packets.
  • DOWN
    Not ready to pass packets and not in some test mode.
  • TESTING
    In some test mode.

/interfaces/interface/state/
oper-status

description:
The current operational state of the interface. This leaf has the same semantics as ifOperStatus.

nodetype: leaf (ro)

type: enumeration

  • UP
    Ready to pass packets.
  • DOWN
    The interface does not pass any packets.
  • TESTING
    In some test mode. No operational packets can be passed.
  • UNKNOWN
    Status cannot be determined for some reason.
  • DORMANT
    Waiting for some external event.
  • NOT_PRESENT
    Some component (typically hardware) is missing.
  • LOWER_LAYER_DOWN
    Down due to state of lower-layer interface(s).

/interfaces/interface/state/
last-change

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

/interfaces/interface/state/
logical

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

/interfaces/interface/state/
management

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

/interfaces/interface/state/
cpu

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

/interfaces/interface/state/
counters

description:
A collection of interface-related statistics objects.

nodetype: container (ro)

/interfaces/interface/state/counters/
in-octets

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

/interfaces/interface/state/counters/
in-pkts

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

/interfaces/interface/state/counters/
in-unicast-pkts

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

/interfaces/interface/state/counters/
in-broadcast-pkts

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

/interfaces/interface/state/counters/
in-multicast-pkts

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

/interfaces/interface/state/counters/
in-discards

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

/interfaces/interface/state/counters/
in-errors

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

/interfaces/interface/state/counters/
in-unknown-protos

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

/interfaces/interface/state/counters/
in-fcs-errors

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

/interfaces/interface/state/counters/
out-octets

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

/interfaces/interface/state/counters/
out-pkts

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

/interfaces/interface/state/counters/
out-unicast-pkts

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

/interfaces/interface/state/counters/
out-broadcast-pkts

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

/interfaces/interface/state/counters/
out-multicast-pkts

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

/interfaces/interface/state/counters/
out-discards

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

/interfaces/interface/state/counters/
out-errors

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

/interfaces/interface/state/counters/
carrier-transitions

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

/interfaces/interface/state/counters/
last-clear

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

/interfaces/interface/state/
tpid

description:
Optionally set the tag protocol identifier field (TPID) that is accepted on the VLAN

nodetype: leaf (ro)

type: identityref

  • base: oc-vlan-types:TPID_TYPES

default: oc-vlan-types:TPID_0X8100

/interfaces/interface/state/
id

description:
The numeric identifier (SDN Port) used by the controller to address the interface. This ID is assigned by an external-to-the-device entity (e.g., an SDN management system) to establish an externally deterministic numeric reference for the interface. The programming entity must ensure that the ID is unique within the required context. Note that this identifier is used only when a numeric reference to the interface is required, it does not replace the unique name assigned to the interface. Ranges: 0x00000000: Unspecified/Invalid 0x00000001: Minimum Port Value 0xFFFFFEFF: Maximum Port Value Reserved: 0xFFFFFFF0 - 0xFFFFFFFF 0xFFFFFFFA: Recirculate 0xFFFFFFFD: CPU

nodetype: leaf (ro)

type: uint32

  • range: 1..4294967039

/interfaces/interface/
hold-time

description:
Top-level container for hold-time settings to enable dampening advertisements of interface transitions.

nodetype: container (rw)

/interfaces/interface/hold-time/
config

description:
Configuration data for interface hold-time settings.

nodetype: container (rw)

/interfaces/interface/hold-time/config/
up

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

/interfaces/interface/hold-time/config/
down

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

/interfaces/interface/hold-time/
state

description:
Operational state data for interface hold-time.

nodetype: container (ro)

/interfaces/interface/hold-time/state/
up

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

/interfaces/interface/hold-time/state/
down

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

/interfaces/interface/
subinterfaces

description:
Enclosing container for the list of subinterfaces associated with a physical interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/
subinterface

description:
The list of subinterfaces (logical interfaces) associated with a physical interface

nodetype: list (rw)

list keys: [index]

/interfaces/interface/subinterfaces/subinterface/
index

description:
The index number of the subinterface -- used to address the logical interface

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/index

/interfaces/interface/subinterfaces/subinterface/
config

description:
Configurable items at the subinterface level

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/config/
index

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

/interfaces/interface/subinterfaces/subinterface/config/
description

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

/interfaces/interface/subinterfaces/subinterface/config/
enabled

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

/interfaces/interface/subinterfaces/subinterface/
state

description:
Operational state data for logical interfaces

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/state/
index

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

/interfaces/interface/subinterfaces/subinterface/state/
description

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

/interfaces/interface/subinterfaces/subinterface/state/
enabled

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

/interfaces/interface/subinterfaces/subinterface/state/
name

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

/interfaces/interface/subinterfaces/subinterface/state/
ifindex

description:
System assigned number for each interface. Corresponds to ifIndex object in SNMP Interface MIB

nodetype: leaf (ro)

type: uint32

/interfaces/interface/subinterfaces/subinterface/state/
admin-status

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

  • UP
    Ready to pass packets.
  • DOWN
    Not ready to pass packets and not in some test mode.
  • TESTING
    In some test mode.

/interfaces/interface/subinterfaces/subinterface/state/
oper-status

description:
The current operational state of the interface. This leaf has the same semantics as ifOperStatus.

nodetype: leaf (ro)

type: enumeration

  • UP
    Ready to pass packets.
  • DOWN
    The interface does not pass any packets.
  • TESTING
    In some test mode. No operational packets can be passed.
  • UNKNOWN
    Status cannot be determined for some reason.
  • DORMANT
    Waiting for some external event.
  • NOT_PRESENT
    Some component (typically hardware) is missing.
  • LOWER_LAYER_DOWN
    Down due to state of lower-layer interface(s).

/interfaces/interface/subinterfaces/subinterface/state/
last-change

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

/interfaces/interface/subinterfaces/subinterface/state/
logical

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

/interfaces/interface/subinterfaces/subinterface/state/
management

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

/interfaces/interface/subinterfaces/subinterface/state/
cpu

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

/interfaces/interface/subinterfaces/subinterface/state/
counters

description:
A collection of interface-related statistics objects.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-octets

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-unicast-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-broadcast-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-multicast-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-discards

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-errors

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-unknown-protos

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
in-fcs-errors

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-octets

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-unicast-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-broadcast-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-multicast-pkts

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-discards

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
out-errors

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
carrier-transitions

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

/interfaces/interface/subinterfaces/subinterface/state/counters/
last-clear

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

/interfaces/interface/subinterfaces/subinterface/
vlan

description:
Enclosing container for VLAN interface-specific data on subinterfaces

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/
config

description:
Configuration parameters for VLANs

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/config/
vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/
state

description:
State variables for VLANs

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/state/
vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/
match

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)

/interfaces/interface/subinterfaces/subinterface/vlan/match/
single-tagged

description:
Match single-tagged packets with an exact VLAN identifier.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged/
config

description:
Configuration for matching single-tagged packets with an exact VLAN identifier.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged/config/
vlan-id

description:
VLAN identifier for single-tagged packets.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged/
state

description:
State for matching single-tagged packets with an exact VLAN identifier.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged/state/
vlan-id

description:
VLAN identifier for single-tagged packets.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/
single-tagged-list

description:
Match single-tagged packets with a list of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-list/
config

description:
Configuration for matching single-tagged packets with a list of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-list/config/
vlan-ids

description:
VLAN identifiers for single-tagged packets.

nodetype: leaf-list (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-list/
state

description:
State for matching single-tagged packets with a list of VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-list/state/
vlan-ids

description:
VLAN identifiers for single-tagged packets.

nodetype: leaf-list (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/
single-tagged-range

description:
Match single-tagged packets with a range of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-range/
config

description:
Configuration for matching single-tagged packets with a range of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-range/config/
low-vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-range/config/
high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-range/
state

description:
State for matching single-tagged packets with a range of VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-range/state/
low-vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/match/single-tagged-range/state/
high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/
double-tagged

description:
Match double-tagged packets against inner exact and outer exact VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged/
config

description:
Configuration for matching double-tagged packets against inner exact and outer exact VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged/config/
inner-vlan-id

description:
Inner VLAN identifier for double-tagged packets.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged/config/
outer-vlan-id

description:
Outer VLAN identifier for double-tagged packets.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged/
state

description:
State for matching double-tagged packets against inner exact and outer exact VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged/state/
inner-vlan-id

description:
Inner VLAN identifier for double-tagged packets.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged/state/
outer-vlan-id

description:
Outer VLAN identifier for double-tagged packets.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/
double-tagged-inner-list

description:
Match double-tagged packets against an inner list and outer exact VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-list/
config

description:
Configuration for matching double-tagged packets against an inner list and outer exact VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-list/config/
inner-vlan-ids

description:
Inner VLAN identifiers for double-tagged packets.

nodetype: leaf-list (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-list/config/
outer-vlan-id

description:
Outer VLAN identifier for double-tagged packets.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-list/
state

description:
State for matching double-tagged packets against an inner list and outer exact VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-list/state/
inner-vlan-ids

description:
Inner VLAN identifiers for double-tagged packets.

nodetype: leaf-list (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-list/state/
outer-vlan-id

description:
Outer VLAN identifier for double-tagged packets.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/
double-tagged-outer-list

description:
Match double-tagged packets against an inner exact and outer list of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-list/
config

description:
Configuration for matching double-tagged packets against an inner exact and outer list of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-list/config/
inner-vlan-id

description:
Inner VLAN identifier for double-tagged packets.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-list/config/
outer-vlan-ids

description:
Outer VLAN identifiers for double-tagged packets.

nodetype: leaf-list (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-list/
state

description:
State for matching double-tagged packets against an inner exact and outer list of VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-list/state/
inner-vlan-id

description:
Inner VLAN identifier for double-tagged packets.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-list/state/
outer-vlan-ids

description:
Outer VLAN identifiers for double-tagged packets.

nodetype: leaf-list (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/
double-tagged-inner-range

description:
Match double-tagged packets against an inner range and outer exact VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/
config

description:
Configuration for matching double-tagged packets against an inner range and outer exact VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/config/
inner-low-vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/config/
inner-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/config/
outer-vlan-id

description:
Outer VLAN identifier of double-tagged packets.

nodetype: leaf-list (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/
state

description:
State for matching double-tagged packets against an inner range and outer exact VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/state/
inner-low-vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/state/
inner-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-range/state/
outer-vlan-id

description:
Outer VLAN identifier of double-tagged packets.

nodetype: leaf-list (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/
double-tagged-outer-range

description:
Match double-tagged packets against an inner exact and an outer range of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/
config

description:
Configuration for matching double-tagged packets against an inner exact and an outer range of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/config/
inner-vlan-id

description:
Inner VLAN identifier for double-tagged packets.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/config/
outer-low-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/config/
outer-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/
state

description:
State for matching double-tagged packets against an inner exact and an outer range of VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/state/
inner-vlan-id

description:
Inner VLAN identifier for double-tagged packets.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/state/
outer-low-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-outer-range/state/
outer-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/
double-tagged-inner-outer-range

description:
Match double-tagged packets against an inner range and an outer range of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/
config

description:
Configuration for matching double-tagged packets against an inner range and an outer range of VLAN identifiers.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/config/
inner-low-vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/config/
inner-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/config/
outer-low-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/config/
outer-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/
state

description:
State for matching double-tagged packets against an inner range and an outer range of VLAN identifiers.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/state/
inner-low-vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/state/
inner-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/state/
outer-low-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

/interfaces/interface/subinterfaces/subinterface/vlan/match/double-tagged-inner-outer-range/state/
outer-high-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

/interfaces/interface/subinterfaces/subinterface/vlan/
ingress-mapping

description:
Ingress VLAN stack behaviors for packets that arrive on this subinterface after their VLAN idenitifer(s) have been matched.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/
config

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)

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/config/
vlan-stack-action

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

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/config/
vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/config/
tpid

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

  • base: oc-vlan-types:TPID_TYPES

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/
state

description:
State for ingress VLAN and label behaviors for packets that arrive on this subinterface.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/state/
vlan-stack-action

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

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/state/
vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/ingress-mapping/state/
tpid

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

  • base: oc-vlan-types:TPID_TYPES

/interfaces/interface/subinterfaces/subinterface/vlan/
egress-mapping

description:
Egress VLAN and label behaviors for packets that are destined for output via this subinterface.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/
config

description:
Configuration for egress VLAN stack behaviors for packets that are destined for output via this subinterface.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/config/
vlan-stack-action

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

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/config/
vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/config/
tpid

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

  • base: oc-vlan-types:TPID_TYPES

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/
state

description:
State for engress VLAN stack behaviors for packets that are destined for output via this subinterface.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/state/
vlan-stack-action

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

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/state/
vlan-id

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

/interfaces/interface/subinterfaces/subinterface/vlan/egress-mapping/state/
tpid

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

  • base: oc-vlan-types:TPID_TYPES

/interfaces/interface/
ethernet

description:
Top-level container for ethernet configuration and state

nodetype: container (rw)

/interfaces/interface/ethernet/
config

description:
Configuration data for ethernet interfaces

nodetype: container (rw)

/interfaces/interface/ethernet/config/
mac-address

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

/interfaces/interface/ethernet/config/
auto-negotiate

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

/interfaces/interface/ethernet/config/
duplex-mode

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

  • FULL
    Full duplex mode
  • HALF
    Half duplex mode

/interfaces/interface/ethernet/config/
port-speed

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

  • base: ETHERNET_SPEED

/interfaces/interface/ethernet/config/
enable-flow-control

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

/interfaces/interface/ethernet/config/
fec-mode

description:
The FEC mode applied to the physical channels associated with the interface.

nodetype: leaf (rw)

type: identityref

  • base: INTERFACE_FEC

/interfaces/interface/ethernet/config/
aggregate-id

description:
Specify the logical aggregate interface to which this interface belongs

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/ethernet/
state

description:
State variables for Ethernet interfaces

nodetype: container (ro)

/interfaces/interface/ethernet/state/
mac-address

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

/interfaces/interface/ethernet/state/
auto-negotiate

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

/interfaces/interface/ethernet/state/
duplex-mode

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

  • FULL
    Full duplex mode
  • HALF
    Half duplex mode

/interfaces/interface/ethernet/state/
port-speed

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

  • base: ETHERNET_SPEED

/interfaces/interface/ethernet/state/
enable-flow-control

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

/interfaces/interface/ethernet/state/
fec-mode

description:
The FEC mode applied to the physical channels associated with the interface.

nodetype: leaf (ro)

type: identityref

  • base: INTERFACE_FEC

/interfaces/interface/ethernet/state/
hw-mac-address

description:
Represents the 'burned-in', or system-assigned, MAC address for the Ethernet interface.

nodetype: leaf (ro)

type: oc-yang:mac-address

/interfaces/interface/ethernet/state/
negotiated-duplex-mode

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

  • FULL
    Full duplex mode
  • HALF
    Half duplex mode

/interfaces/interface/ethernet/state/
negotiated-port-speed

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

  • base: ETHERNET_SPEED

/interfaces/interface/ethernet/state/
counters

description:
Ethernet interface counters

nodetype: container (ro)

/interfaces/interface/ethernet/state/counters/
in-mac-control-frames

description:
MAC layer control frames received on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/
in-mac-pause-frames

description:
MAC layer PAUSE frames received on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/
in-oversize-frames

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

/interfaces/interface/ethernet/state/counters/
in-undersize-frames

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

/interfaces/interface/ethernet/state/counters/
in-jabber-frames

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

/interfaces/interface/ethernet/state/counters/
in-fragment-frames

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

/interfaces/interface/ethernet/state/counters/
in-8021q-frames

description:
Number of 802.1q tagged frames received on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/
in-crc-errors

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

/interfaces/interface/ethernet/state/counters/
in-block-errors

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

/interfaces/interface/ethernet/state/counters/
in-carrier-errors

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

/interfaces/interface/ethernet/state/counters/
in-interrupted-tx

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

/interfaces/interface/ethernet/state/counters/
in-late-collision

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

/interfaces/interface/ethernet/state/counters/
in-mac-errors-rx

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

/interfaces/interface/ethernet/state/counters/
in-single-collision

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

/interfaces/interface/ethernet/state/counters/
in-symbol-error

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

/interfaces/interface/ethernet/state/counters/
in-maxsize-exceeded

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

/interfaces/interface/ethernet/state/counters/
out-mac-control-frames

description:
MAC layer control frames sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/
out-mac-pause-frames

description:
MAC layer PAUSE frames sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/
out-8021q-frames

description:
Number of 802.1q tagged frames sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/
out-mac-errors-tx

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

/interfaces/interface/ethernet/state/
aggregate-id

description:
Specify the logical aggregate interface to which this interface belongs

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/ethernet/
switched-vlan

description:
Enclosing container for VLAN interface-specific data on Ethernet interfaces. These are for standard L2, switched-style VLANs.

nodetype: container (rw)

/interfaces/interface/ethernet/switched-vlan/
config

description:
Configuration parameters for VLANs

nodetype: container (rw)

/interfaces/interface/ethernet/switched-vlan/config/
interface-mode

description:
Set the interface to access or trunk mode for VLANs

nodetype: leaf (rw)

type: oc-vlan-types:vlan-mode-type

/interfaces/interface/ethernet/switched-vlan/config/
native-vlan

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

/interfaces/interface/ethernet/switched-vlan/config/
access-vlan

description:
Assign the access vlan to the access port.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/switched-vlan/config/
trunk-vlans

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

/interfaces/interface/ethernet/switched-vlan/
state

description:
State variables for VLANs

nodetype: container (ro)

/interfaces/interface/ethernet/switched-vlan/state/
interface-mode

description:
Set the interface to access or trunk mode for VLANs

nodetype: leaf (ro)

type: oc-vlan-types:vlan-mode-type

/interfaces/interface/ethernet/switched-vlan/state/
native-vlan

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

/interfaces/interface/ethernet/switched-vlan/state/
access-vlan

description:
Assign the access vlan to the access port.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/switched-vlan/state/
trunk-vlans

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

/interfaces/interface/
aggregation

description:
Options for logical interfaces representing aggregates

nodetype: container (rw)

/interfaces/interface/aggregation/
config

description:
Configuration variables for logical aggregate / LAG interfaces

nodetype: container (rw)

/interfaces/interface/aggregation/config/
lag-type

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

/interfaces/interface/aggregation/
state

description:
Operational state variables for logical aggregate / LAG interfaces

nodetype: container (ro)

/interfaces/interface/aggregation/state/
lag-type

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

/interfaces/interface/aggregation/state/
lag-speed

description:
Reports effective speed of the aggregate interface, based on speed of active member interfaces

nodetype: leaf (ro)

type: uint32

units: Mbps

/interfaces/interface/aggregation/state/
member

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

/interfaces/interface/aggregation/
switched-vlan

description:
Enclosing container for VLAN interface-specific data on Ethernet interfaces. These are for standard L2, switched-style VLANs.

nodetype: container (rw)

/interfaces/interface/aggregation/switched-vlan/
config

description:
Configuration parameters for VLANs

nodetype: container (rw)

/interfaces/interface/aggregation/switched-vlan/config/
interface-mode

description:
Set the interface to access or trunk mode for VLANs

nodetype: leaf (rw)

type: oc-vlan-types:vlan-mode-type

/interfaces/interface/aggregation/switched-vlan/config/
native-vlan

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

/interfaces/interface/aggregation/switched-vlan/config/
access-vlan

description:
Assign the access vlan to the access port.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/aggregation/switched-vlan/config/
trunk-vlans

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

/interfaces/interface/aggregation/switched-vlan/
state

description:
State variables for VLANs

nodetype: container (ro)

/interfaces/interface/aggregation/switched-vlan/state/
interface-mode

description:
Set the interface to access or trunk mode for VLANs

nodetype: leaf (ro)

type: oc-vlan-types:vlan-mode-type

/interfaces/interface/aggregation/switched-vlan/state/
native-vlan

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

/interfaces/interface/aggregation/switched-vlan/state/
access-vlan

description:
Assign the access vlan to the access port.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/aggregation/switched-vlan/state/
trunk-vlans

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

/interfaces/interface/
routed-vlan

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)

/interfaces/interface/routed-vlan/
config

description:
Configuration data for routed vlan interfaces

nodetype: container (rw)

/interfaces/interface/routed-vlan/config/
vlan

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

/interfaces/interface/routed-vlan/
state

description:
Operational state data

nodetype: container (ro)

/interfaces/interface/routed-vlan/state/
vlan

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

openconfig-platform

openconfig-version: 0.22.0

Description

This module defines a data model for representing a system component inventory, which can include hardware or software elements arranged in an arbitrary structure. The primary relationship supported by the model is containment, e.g., components containing subcomponents.

It is expected that this model reflects every field replacable unit on the device at a minimum (i.e., additional information may be supplied about non-replacable components).

Every element in the inventory is termed a 'component' with each component expected to have a unique name and type, and optionally a unique system-assigned identifier and FRU number. The uniqueness is guaranteed by the system within the device.

Components may have properties defined by the system that are modeled as a list of key-value pairs. These may or may not be user-configurable. The model provides a flag for the system to optionally indicate which properties are user configurable.

Each component also has a list of 'subcomponents' which are references to other components. Appearance in a list of subcomponents indicates a containment relationship as described above. For example, a linecard component may have a list of references to port components that reside on the linecard.

This schema is generic to allow devices to express their own platform-specific structure. It may be augmented by additional component type-specific schemas that provide a common structure for well-known component types. In these cases, the system is expected to populate the common component schema, and may optionally also represent the component and its properties in the generic structure.

The properties for each component may include dynamic values, e.g., in the 'state' part of the schema. For example, a CPU component may report its utilization, temperature, or other physical properties. The intent is to capture all platform- specific physical data in one location, including inventory (presence or absence of a component) and state (physical attributes or status).

Imports

openconfig-platform-types
openconfig-extensions
openconfig-alarm-types
openconfig-yang-types
openconfig-types

Data elements

/
components

description:
Enclosing container for the components in the system.

nodetype: container (rw)

/components/
component

description:
List of components, keyed by component name.

nodetype: list (rw)

list keys: [name]

/components/component/
name

description:
References the component name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/
config

description:
Configuration data for each component

nodetype: container (rw)

/components/component/config/
name

description:
Device name for the component -- this may not be a configurable parameter on many implementations. Where component preconfiguration is supported, for example, the component name may be configurable.

nodetype: leaf (rw)

type: string

/components/component/
state

description:
Operational state data for each component

nodetype: container (ro)

/components/component/state/
name

description:
Device name for the component -- this may not be a configurable parameter on many implementations. Where component preconfiguration is supported, for example, the component name may be configurable.

nodetype: leaf (ro)

type: string

/components/component/state/
type

description:
Type of component as identified by the system

nodetype: leaf (ro)

type: union

    type: identityref

    • base: oc-platform-types:OPENCONFIG_HARDWARE_COMPONENT

    type: identityref

    • base: oc-platform-types:OPENCONFIG_SOFTWARE_COMPONENT

/components/component/state/
id

description:
Unique identifier assigned by the system for the component

nodetype: leaf (ro)

type: string

/components/component/state/
location

description:
System-supplied description of the location of the component within the system. This could be a bay position, slot number, socket location, etc. For component types that have an explicit slot-id attribute, such as linecards, the system should populate the more specific slot-id.

nodetype: leaf (ro)

type: string

/components/component/state/
description

description:
System-supplied description of the component

nodetype: leaf (ro)

type: string

/components/component/state/
mfg-name

description:
System-supplied identifier for the manufacturer of the component. This data is particularly useful when a component manufacturer is different than the overall device vendor.

nodetype: leaf (ro)

type: string

/components/component/state/
mfg-date

description:
System-supplied representation of the component's manufacturing date.

nodetype: leaf (ro)

type: oc-yang:date

/components/component/state/
hardware-version

description:
For hardware components, this is the hardware revision of the component.

nodetype: leaf (ro)

type: string

/components/component/state/
firmware-version

description:
For hardware components, this is the version of associated firmware that is running on the component, if applicable.

nodetype: leaf (ro)

type: string

/components/component/state/
software-version

description:
For software components such as operating system or other software module, this is the version of the currently running software.

nodetype: leaf (ro)

type: string

/components/component/state/
serial-no

description:
System-assigned serial number of the component.

nodetype: leaf (ro)

type: string

/components/component/state/
part-no

description:
System-assigned part number for the component. This should be present in particular if the component is also an FRU (field replaceable unit)

nodetype: leaf (ro)

type: string

/components/component/state/
clei-code

description:
Common Language Equipment Identifier (CLEI) code of the component. This should be present in particular if the component is also an FRU (field replaceable unit)

nodetype: leaf (ro)

type: string

/components/component/state/
removable

description:
If true, this component is removable or is a field replaceable unit

nodetype: leaf (ro)

type: boolean

/components/component/state/
oper-status

description:
If applicable, this reports the current operational status of the component.

nodetype: leaf (ro)

type: identityref

  • base: oc-platform-types:COMPONENT_OPER_STATUS

/components/component/state/
empty

description:
The empty leaf may be used by the device to indicate that a component position exists but is not populated. Using this flag, it is possible for the management system to learn how many positions are available (e.g., occupied vs. empty linecard slots in a chassis).

nodetype: leaf (ro)

type: boolean

default: false

/components/component/state/
parent

description:
Reference to the name of the parent component. Note that this reference must be kept synchronized with the corresponding subcomponent reference from the parent component.

nodetype: leaf (ro)

type: leafref

  • path reference: ../../../component/config/name

/components/component/state/
redundant-role

description:
For components that have redundant roles (e.g. two supervisors in a device, one as primary the other as secondary), this reports the role of the component.

nodetype: leaf (ro)

type: oc-platform-types:component-redundant-role

/components/component/state/
last-switchover-reason

description:
For components that have redundant roles (e.g. two supervisors in a device, one as primary the other as secondary), this reports the reason of the last change of the component's role.

nodetype: container (ro)

/components/component/state/last-switchover-reason/
trigger

description:
Records the generic triggers, e.g. user or system initiated the switchover.

nodetype: leaf (ro)

type: component-redundant-role-switchover-reason-trigger

/components/component/state/last-switchover-reason/
details

description:
Records detailed description of why the switchover happens. For example, when system initiated the switchover, this leaf can be used to record the specific reason, e.g. due to critical errors of the routing daemon in the primary role.

nodetype: leaf (ro)

type: string

/components/component/state/
last-switchover-time

description:
For components that have redundant roles (e.g. two supervisors in a device, one as primary the other as secondary), this reports the time of the last change of the component's role. 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

units: nanoseconds

/components/component/state/
last-reboot-reason

description:
This reports the reason of the last reboot of the component.

nodetype: leaf (ro)

type: identityref

  • base: oc-platform-types:COMPONENT_REBOOT_REASON

/components/component/state/
last-reboot-time

description:
This reports the time of the last reboot of the component. 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

units: nanoseconds

/components/component/state/
switchover-ready

description:
For components that have redundant roles, this reports a value that indicates if the component is ready to support failover. The components with a redundant-role should reflect the overall system's switchover status. For example, two supervisors in a device, one as primary and the other as secondary, should both report the same value.

nodetype: leaf (ro)

type: boolean

/components/component/state/
base-mac-address

description:
This is a MAC address representing the root or primary MAC address for a component. Components such as CHASSIS and CONTROLLER_CARD are expected to provide a base-mac-address. The base mac-address for CHASSIS and a PRIMARY CONTROLLER_CARD may contain the same value.

nodetype: leaf (ro)

type: oc-yang:mac-address

/components/component/state/
temperature

description:
Temperature in degrees Celsius of the component. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/components/component/state/temperature/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
avg

description:
The arithmetic mean value of the statistic over the sampling period.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
min

description:
The minimum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
max

description:
The maximum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/components/component/state/temperature/
min-time

description:
The absolute time at which the minimum value occurred. 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

/components/component/state/temperature/
max-time

description:
The absolute time at which the maximum value occurred. 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

/components/component/state/temperature/
alarm-status

description:
A value of true indicates the alarm has been raised or asserted. The value should be false when the alarm is cleared.

nodetype: leaf (ro)

type: boolean

/components/component/state/temperature/
alarm-threshold

description:
The threshold value that was crossed for this alarm.

nodetype: leaf (ro)

type: uint32

/components/component/state/temperature/
alarm-severity

description:
The severity of the current alarm.

nodetype: leaf (ro)

type: identityref

  • base: oc-alarm-types:OPENCONFIG_ALARM_SEVERITY

/components/component/state/
memory

description:
For components that have associated memory, these values report information about available and utilized memory.

nodetype: container (ro)

/components/component/state/memory/
available

description:
The available memory physically installed, or logically allocated to the component.

nodetype: leaf (ro)

type: uint64

units: bytes

/components/component/state/memory/
utilized

description:
The memory currently in use by processes running on the component, not considering reserved memory that is not available for use.

nodetype: leaf (ro)

type: uint64

units: bytes

/components/component/state/
allocated-power

description:
Power allocated by the system for the component.

nodetype: leaf (ro)

type: uint32

units: watts

/components/component/state/
used-power

description:
Actual power used by the component.

nodetype: leaf (ro)

type: uint32

units: watts

/components/component/state/
pcie

description:
Components that are connected to the system over the Peripheral Component Interconnect Express (PCIe), report the fatal, non-fatal and correctable PCIe error counts.

nodetype: container (ro)

/components/component/state/pcie/
fatal-errors

description:
The count of the fatal PCIe errors.

nodetype: container (ro)

/components/component/state/pcie/fatal-errors/
total-errors

description:
Total number of uncorrectable errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
undefined-errors

description:
Number of undefined errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

description:
Number of data-link errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
surprise-down-errors

description:
Number of unexpected link down errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
poisoned-tlp-errors

description:
Number of poisoned TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
flow-control-protocol-errors

description:
Number of flow control protocol errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
completion-timeout-errors

description:
Number of completion timeout errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
completion-abort-errors

description:
Number of completion abort errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
unexpected-completion-errors

description:
Number of unexpected completion errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
receiver-overflow-errors

description:
Number of receiver overflow errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
malformed-tlp-errors

description:
Number of malformed TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
ecrc-errors

description:
Number of ECRC errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
unsupported-request-errors

description:
Number of unsupported request errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
acs-violation-errors

description:
Number of access control errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
internal-errors

description:
Number of internal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
blocked-tlp-errors

description:
Number of blocked TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
atomic-op-blocked-errors

description:
Number of atomic operation blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
tlp-prefix-blocked-errors

description:
Number of TLP prefix blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/
non-fatal-errors

description:
The count of the non-fatal PCIe errors.

nodetype: container (ro)

/components/component/state/pcie/non-fatal-errors/
total-errors

description:
Total number of uncorrectable errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
undefined-errors

description:
Number of undefined errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

description:
Number of data-link errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
surprise-down-errors

description:
Number of unexpected link down errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
poisoned-tlp-errors

description:
Number of poisoned TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
flow-control-protocol-errors

description:
Number of flow control protocol errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
completion-timeout-errors

description:
Number of completion timeout errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
completion-abort-errors

description:
Number of completion abort errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
unexpected-completion-errors

description:
Number of unexpected completion errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
receiver-overflow-errors

description:
Number of receiver overflow errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
malformed-tlp-errors

description:
Number of malformed TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
ecrc-errors

description:
Number of ECRC errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
unsupported-request-errors

description:
Number of unsupported request errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
acs-violation-errors

description:
Number of access control errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
internal-errors

description:
Number of internal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
blocked-tlp-errors

description:
Number of blocked TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
atomic-op-blocked-errors

description:
Number of atomic operation blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
tlp-prefix-blocked-errors

description:
Number of TLP prefix blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/
correctable-errors

description:
The count of the correctable PCIe errors.

nodetype: container (ro)

/components/component/state/pcie/correctable-errors/
total-errors

description:
Total number of correctable errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
receiver-errors

description:
Number of receiver errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
bad-tlp-errors

description:
Number of TLPs with bad LCRC detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
bad-dllp-errors

description:
Number of DLLPs with bad LCRC detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
relay-rollover-errors

description:
Number of relay rollover errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
replay-timeout-errors

description:
Number of replay timeout errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
advisory-non-fatal-errors

description:
Number of advisory non fatal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
internal-errors

description:
Number of internal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
hdr-log-overflow-errors

description:
Number of header log overflow errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/
equipment-failure

description:
If true, the hardware indicates that the component's physical equipment has failed

nodetype: leaf (ro)

type: boolean

default: false

/components/component/state/
equipment-mismatch

description:
If true, the hardware indicates that the component inserted into the affected component's physical location is of a different type than what is configured

nodetype: leaf (ro)

type: boolean

default: false

/components/component/
properties

description:
Enclosing container

nodetype: container (rw)

/components/component/properties/
property

description:
List of system properties for the component

nodetype: list (rw)

list keys: [name]

/components/component/properties/property/
name

description:
Reference to the property name.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/properties/property/
config

description:
Configuration data for each property

nodetype: container (rw)

/components/component/properties/property/config/
name

description:
System-supplied name of the property -- this is typically non-configurable

nodetype: leaf (rw)

type: string

/components/component/properties/property/config/
value

description:
Property values can take on a variety of types. Signed and unsigned integer types may be provided in smaller sizes, e.g., int8, uint16, etc.

nodetype: leaf (rw)

type: union

    type: string

    type: boolean

    type: int64

    type: uint64

    type: decimal64

/components/component/properties/property/
state

description:
Operational state data for each property

nodetype: container (ro)

/components/component/properties/property/state/
name

description:
System-supplied name of the property -- this is typically non-configurable

nodetype: leaf (ro)

type: string

/components/component/properties/property/state/
value

description:
Property values can take on a variety of types. Signed and unsigned integer types may be provided in smaller sizes, e.g., int8, uint16, etc.

nodetype: leaf (ro)

type: union

    type: string

    type: boolean

    type: int64

    type: uint64

    type: decimal64

/components/component/properties/property/state/
configurable

description:
Indication whether the property is user-configurable

nodetype: leaf (ro)

type: boolean

/components/component/
subcomponents

description:
Enclosing container for subcomponent references

nodetype: container (rw)

/components/component/subcomponents/
subcomponent

description:
List of subcomponent references

nodetype: list (rw)

list keys: [name]

/components/component/subcomponents/subcomponent/
name

description:
Reference to the name list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/subcomponents/subcomponent/
config

description:
Configuration data for the subcomponent

nodetype: container (rw)

/components/component/subcomponents/subcomponent/config/
name

description:
Reference to the name of the subcomponent

nodetype: leaf (rw)

type: leafref

  • path reference: ../../../../../component/config/name

/components/component/subcomponents/subcomponent/
state

description:
Operational state data for the subcomponent

nodetype: container (ro)

/components/component/subcomponents/subcomponent/state/
name

description:
Reference to the name of the subcomponent

nodetype: leaf (ro)

type: leafref

  • path reference: ../../../../../component/config/name

/components/component/
chassis

description:
Data for chassis components

nodetype: container (rw)

/components/component/chassis/
config

description:
Configuration data for chassis components

nodetype: container (rw)

/components/component/chassis/config/
id

description:
An identifier used for the root of oc-p4rt:node-id. It is used to indicate which oc-p4rt:node-id's belong to the same device

nodetype: leaf (rw)

type: uint32

/components/component/chassis/
state

description:
Operational state data for chassis components

nodetype: container (ro)

/components/component/chassis/state/
id

description:
An identifier used for the root of oc-p4rt:node-id. It is used to indicate which oc-p4rt:node-id's belong to the same device

nodetype: leaf (ro)

type: uint32

/components/component/chassis/
utilization

description:
Utilization of the component.

nodetype: container (rw)

/components/component/chassis/utilization/
resources

description:
Enclosing container for the resources in this component.

nodetype: container (rw)

/components/component/chassis/utilization/resources/
resource

description:
List of resources, keyed by resource name.

nodetype: list (rw)

list keys: [name]

/components/component/chassis/utilization/resources/resource/
name

description:
References the resource name.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/chassis/utilization/resources/resource/
config

description:
Configuration data for each resource.

nodetype: container (rw)

/components/component/chassis/utilization/resources/resource/config/
name

description:
Resource name within the component.

nodetype: leaf (rw)

type: string

/components/component/chassis/utilization/resources/resource/config/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/config/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/
state

description:
Operational state data for each resource.

nodetype: container (ro)

/components/component/chassis/utilization/resources/resource/state/
name

description:
Resource name within the component.

nodetype: leaf (ro)

type: string

/components/component/chassis/utilization/resources/resource/state/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/state/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/state/
used

description:
Number of entries currently in use for the resource.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
committed

description:
Number of entries currently reserved for this resource. This is only relevant to tables which allocate a block of resource for a given feature.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
free

description:
Number of entries available to use.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
max-limit

description:
Maximum number of entries available for the resource. The value is the theoretical maximum resource utilization possible.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
high-watermark

description:
A watermark of highest number of entries used for this resource.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
last-high-watermark

description:
The timestamp when the high-watermark was last updated. 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

/components/component/chassis/utilization/resources/resource/state/
used-threshold-upper-exceeded

description:
This value is set to true when the used percentage value (used / (used + free) * 100) has crossed the used-threshold-upper for this resource and false when the used percentage value has crossed the configured used-threshold-upper-clear value for this resource.

nodetype: leaf (ro)

type: boolean

/components/component/
port

description:
Data for physical port components

nodetype: container (rw)

/components/component/port/
config

description:
Configuration data for physical port components

nodetype: container (rw)

/components/component/port/
state

description:
Operational state data for physical port components

nodetype: container (ro)

/components/component/
power-supply

description:
Data for power supply components

nodetype: container (rw)

/components/component/power-supply/
config

description:
Configuration data for power supply components

nodetype: container (rw)

/components/component/power-supply/
state

description:
Operational state data for power supply components

nodetype: container (ro)

/components/component/
fan

description:
Data for fan components

nodetype: container (rw)

/components/component/fan/
config

description:
Configuration data for fan components

nodetype: container (rw)

/components/component/fan/
state

description:
Operational state data for fan components

nodetype: container (ro)

/components/component/
fabric

description:
Data for fabric components

nodetype: container (rw)

/components/component/fabric/
config

description:
Configuration data for fabric components

nodetype: container (rw)

/components/component/fabric/
state

description:
Operational state data for fabric components

nodetype: container (ro)

/components/component/
storage

description:
Data for storage components

nodetype: container (rw)

/components/component/storage/
config

description:
Configuration data for storage components

nodetype: container (rw)

/components/component/storage/
state

description:
Operational state data for storage components

nodetype: container (ro)

/components/component/
cpu

description:
Data for cpu components

nodetype: container (rw)

/components/component/cpu/
config

description:
Configuration data for cpu components

nodetype: container (rw)

/components/component/cpu/
state

description:
Operational state data for cpu components

nodetype: container (ro)

/components/component/
integrated-circuit

description:
Data for chip components, such as ASIC, NPUs, etc.

nodetype: container (rw)

/components/component/integrated-circuit/
config

description:
Configuration data for chip components

nodetype: container (rw)

/components/component/integrated-circuit/config/
node-id

description:
The numeric ID (device_id) used by the controller to address the integrated circuit, which may be referred to as a 'device', 'node' or 'target' by the P4RT specification. Each switching ASIC (i.e., node) is addressed by the external entity based on its numeric identifier. The node ID is specified in addition to the string identifier assigned to the integrated circuit within the /components/component list.

nodetype: leaf (rw)

type: uint64

/components/component/integrated-circuit/
state

description:
Operational state data for chip components

nodetype: container (ro)

/components/component/integrated-circuit/state/
node-id

description:
The numeric ID (device_id) used by the controller to address the integrated circuit, which may be referred to as a 'device', 'node' or 'target' by the P4RT specification. Each switching ASIC (i.e., node) is addressed by the external entity based on its numeric identifier. The node ID is specified in addition to the string identifier assigned to the integrated circuit within the /components/component list.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/
utilization

description:
Utilization of the component.

nodetype: container (rw)

/components/component/integrated-circuit/utilization/
resources

description:
Enclosing container for the resources in this component.

nodetype: container (rw)

/components/component/integrated-circuit/utilization/resources/
resource

description:
List of resources, keyed by resource name.

nodetype: list (rw)

list keys: [name]

/components/component/integrated-circuit/utilization/resources/resource/
name

description:
References the resource name.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/integrated-circuit/utilization/resources/resource/
config

description:
Configuration data for each resource.

nodetype: container (rw)

/components/component/integrated-circuit/utilization/resources/resource/config/
name

description:
Resource name within the component.

nodetype: leaf (rw)

type: string

/components/component/integrated-circuit/utilization/resources/resource/config/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/config/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/
state

description:
Operational state data for each resource.

nodetype: container (ro)

/components/component/integrated-circuit/utilization/resources/resource/state/
name

description:
Resource name within the component.

nodetype: leaf (ro)

type: string

/components/component/integrated-circuit/utilization/resources/resource/state/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/state/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/state/
used

description:
Number of entries currently in use for the resource.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
committed

description:
Number of entries currently reserved for this resource. This is only relevant to tables which allocate a block of resource for a given feature.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
free

description:
Number of entries available to use.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
max-limit

description:
Maximum number of entries available for the resource. The value is the theoretical maximum resource utilization possible.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
high-watermark

description:
A watermark of highest number of entries used for this resource.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
last-high-watermark

description:
The timestamp when the high-watermark was last updated. 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

/components/component/integrated-circuit/utilization/resources/resource/state/
used-threshold-upper-exceeded

description:
This value is set to true when the used percentage value (used / (used + free) * 100) has crossed the used-threshold-upper for this resource and false when the used percentage value has crossed the configured used-threshold-upper-clear value for this resource.

nodetype: leaf (ro)

type: boolean

/components/component/
backplane

description:
Data for backplane components

nodetype: container (rw)

/components/component/backplane/
config

description:
Configuration data for backplane components

nodetype: container (rw)

/components/component/backplane/
state

description:
Operational state data for backplane components

nodetype: container (ro)

/components/component/
software-module

description:
Data for software module components, i.e., for components with type=SOFTWARE_MODULE

nodetype: container (rw)

/components/component/software-module/
config

description:
Configuration data for software module components

nodetype: container (rw)

/components/component/software-module/
state

description:
Operational state data for software module components

nodetype: container (ro)

/components/component/
controller-card

description:
Data for controller card components, i.e., for components with type=CONTROLLER_CARD

nodetype: container (rw)

/components/component/controller-card/
config

description:
Configuration data for controller card components. Note that disabling power to the primary supervisor should be rejected, and the operator is required to perform a switchover first.

nodetype: container (rw)

/components/component/controller-card/
state

description:
Operational state data for controller card components

nodetype: container (ro)