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/
forwarding-viable

description:
This value indicates whether the interface may be used to route traffic or not. If set to false, the interface is not used for forwarding traffic, but as long as it is up, the interface still maintains its layer-2 adjacencies and runs its configured layer-2 functions (e.g., LLDP, etc.). This is used by an external programming entity to disable an interface (usually part of an aggregate) for the purposes of forwarding traffic. This allows a logical aggregate to continue to be used with partial capacity, for example. Note that setting `forwarding-viable = false` is not equivalent to administratively disabling the interface -- in particular, the interface is expected to participate in L2 protocols such as LLDP or LACP even if it blocked from forwarding traffic.

nodetype: leaf (rw)

type: boolean

default: true

/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/
hardware-port

description:
For non-channelized interfaces, references the hardware port corresponding to the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/interfaces/interface/state/
transceiver

description:
Provides a reference to the transceiver subcomponent that corresponds to the physical port component for this interface. The device must only populate this leaf with a reference to a component of type TRANSCEIVER.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/name=current()/../hardware-port]/subcomponents/subcomponent/name

/interfaces/interface/state/
physical-channel

description:
For a channelized interface, list of references to the physical channels (lanes) corresponding to the interface. The physical channels are elements of a transceiver component in the platform model.

nodetype: leaf-list (ro)

type: leafref

  • path reference: /components/name=current()/../transceiver]/transceiver/physical-channels/channel/index

/interfaces/interface/state/
forwarding-viable

description:
This value indicates whether the interface may be used to route traffic or not. If set to false, the interface is not used for forwarding traffic, but as long as it is up, the interface still maintains its layer-2 adjacencies and runs its configured layer-2 functions (e.g., LLDP, etc.). This is used by an external programming entity to disable an interface (usually part of an aggregate) for the purposes of forwarding traffic. This allows a logical aggregate to continue to be used with partial capacity, for example. Note that setting `forwarding-viable = false` is not equivalent to administratively disabling the interface -- in particular, the interface is expected to participate in L2 protocols such as LLDP or LACP even if it blocked from forwarding traffic.

nodetype: leaf (ro)

type: boolean

default: true

/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/state/
out-rate

description:
The calculated transmitted rate of the interface, measured in bits per second.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

units: bps

/interfaces/interface/state/
in-rate

description:
The calculate received rate of the interface, measured in bits per second.

nodetype: leaf (ro)

type: oc-types:ieeefloat32

units: bps

/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/subinterfaces/subinterface/
ipv4

description:
Parameters for the IPv4 address family.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/
addresses

description:
Enclosing container for address list

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/
address

description:
The list of configured IPv4 addresses on the interface.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/
config

description:
Configuration data for each configured IPv4 address on the interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/config/
ip

description:
The IPv4 address on the interface.

nodetype: leaf (rw)

type: oc-inet:ipv4-address

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/config/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (rw)

type: uint8

  • range: 0..32

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/
state

description:
Operational state data for each IPv4 address configured on the interface

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/state/
ip

description:
The IPv4 address on the interface.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/state/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (ro)

type: uint8

  • range: 0..32

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/state/
origin

description:
The origin of this address, e.g., statically configured, assigned by DHCP, etc..

nodetype: leaf (ro)

type: ip-address-origin

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/
vrrp

description:
Enclosing container for VRRP groups handled by this IP interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/
vrrp-group

description:
List of VRRP groups, keyed by virtual router id

nodetype: list (rw)

list keys: [virtual-router-id]

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/
virtual-router-id

description:
References the configured virtual router id for this VRRP group

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/virtual-router-id

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/
config

description:
Configuration data for the VRRP group

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (rw)

type: uint8

  • range: 1..255

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (rw)

type: oc-inet:ip-address

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (rw)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (rw)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/config/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (rw)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/
state

description:
Operational state data for the VRRP group

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (ro)

type: uint8

  • range: 1..255

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (ro)

type: oc-inet:ip-address

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (ro)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (ro)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (ro)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/state/
current-priority

description:
Operational value of the priority for the interface in the VRRP group

nodetype: leaf (ro)

type: uint8

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/
interface-tracking

description:
Top-level container for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/
config

description:
Configuration data for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/config/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/config/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (rw)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/
state

description:
Operational state data for VRRP interface tracking

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/state/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/state/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (ro)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv4/
proxy-arp

description:
Configuration and operational state parameters relating to proxy ARP. This functionality allows a system to respond to ARP requests that are not explicitly destined to the local system.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/proxy-arp/
config

description:
Configuration parameters for proxy ARP

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/proxy-arp/config/
mode

description:
When set to a value other than DISABLE, the local system should respond to ARP requests that are for target addresses other than those that are configured on the local subinterface using its own MAC address as the target hardware address. If the REMOTE_ONLY value is specified, replies are only sent when the target address falls outside the locally configured subnets on the interface, whereas with the ALL value, all requests, regardless of their target address are replied to.

nodetype: leaf (rw)

type: enumeration

  • DISABLE
    The system should not respond to ARP requests that do not specify an IP address configured on the local subinterface as the target address.
  • REMOTE_ONLY
    The system responds to ARP requests only when the sender and target IP addresses are in different subnets.
  • ALL
    The system responds to ARP requests where the sender and target IP addresses are in different subnets, as well as those where they are in the same subnet.

default: DISABLE

/interfaces/interface/subinterfaces/subinterface/ipv4/proxy-arp/
state

description:
Operational state parameters for proxy ARP

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/proxy-arp/state/
mode

description:
When set to a value other than DISABLE, the local system should respond to ARP requests that are for target addresses other than those that are configured on the local subinterface using its own MAC address as the target hardware address. If the REMOTE_ONLY value is specified, replies are only sent when the target address falls outside the locally configured subnets on the interface, whereas with the ALL value, all requests, regardless of their target address are replied to.

nodetype: leaf (ro)

type: enumeration

  • DISABLE
    The system should not respond to ARP requests that do not specify an IP address configured on the local subinterface as the target address.
  • REMOTE_ONLY
    The system responds to ARP requests only when the sender and target IP addresses are in different subnets.
  • ALL
    The system responds to ARP requests where the sender and target IP addresses are in different subnets, as well as those where they are in the same subnet.

default: DISABLE

/interfaces/interface/subinterfaces/subinterface/ipv4/
neighbors

description:
Enclosing container for neighbor list

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/
neighbor

description:
A list of mappings from IPv4 addresses to link-layer addresses. Entries in this list are used as static entries in the ARP Cache.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/neighbor/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/neighbor/
config

description:
Configuration data for each configured IPv4 address on the interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/neighbor/config/
ip

description:
The IPv4 address of the neighbor node.

nodetype: leaf (rw)

type: oc-inet:ipv4-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (rw)

type: oc-yang:phys-address

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/neighbor/
state

description:
Operational state data for each IPv4 address configured on the interface

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/neighbor/state/
ip

description:
The IPv4 address of the neighbor node.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (ro)

type: oc-yang:phys-address

/interfaces/interface/subinterfaces/subinterface/ipv4/neighbors/neighbor/state/
origin

description:
The origin of this neighbor entry, static or dynamic.

nodetype: leaf (ro)

type: neighbor-origin

/interfaces/interface/subinterfaces/subinterface/ipv4/
unnumbered

description:
Top-level container for setting unnumbered interfaces. Includes reference the interface that provides the address information

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/
config

description:
Configuration data for unnumbered interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/config/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/
state

description:
Operational state data for unnumbered interfaces

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/state/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv4/unnumbered/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/subinterfaces/subinterface/ipv4/
config

description:
Top-level IPv4 configuration data for the interface

nodetype: container (rw)

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

description:
Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv4/config/
mtu

description:
The size, in octets, of the largest IPv4 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (rw)

type: uint16

  • range: 68..max

units: octets

/interfaces/interface/subinterfaces/subinterface/ipv4/config/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv4/
state

description:
Top level IPv4 operational state data

nodetype: container (ro)

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

description:
Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv4/state/
mtu

description:
The size, in octets, of the largest IPv4 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (ro)

type: uint16

  • range: 68..max

units: octets

/interfaces/interface/subinterfaces/subinterface/ipv4/state/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (ro)

type: boolean

default: false

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

description:
Packet and byte counters for IP transmission and reception for the address family.

nodetype: container (ro)

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

description:
The total number of IP packets received for the specified address family, including those received in error

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets received in input IP packets for the specified address family, including those received in error.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
Number of IP packets discarded due to errors for the specified address family, including errors in the IP header, no route found to the IP destination, invalid address, unknown protocol, etc.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of input packets for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of octets received in input IP packets for the specified address family for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of input IP packets for the specified address family, for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets in IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
Number of IP packets for the specified address family locally generated and discarded due to errors, including no route found to the IP destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of octets in packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of output IP packets for the specified address family for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/subinterfaces/subinterface/
ipv6

description:
Parameters for the IPv6 address family.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/
addresses

description:
Enclosing container for address list

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/
address

description:
The list of configured IPv6 addresses on the interface.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/
config

description:
Configuration data for each IPv6 address on the interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/config/
ip

description:
The IPv6 address on the interface.

nodetype: leaf (rw)

type: oc-inet:ipv6-address

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/config/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (rw)

type: uint8

  • range: 0..128

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/
state

description:
State data for each IPv6 address on the interface

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/state/
ip

description:
The IPv6 address on the interface.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/state/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (ro)

type: uint8

  • range: 0..128

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/state/
origin

description:
The origin of this address, e.g., static, dhcp, etc.

nodetype: leaf (ro)

type: ip-address-origin

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/state/
status

description:
The status of an address. Most of the states correspond to states from the IPv6 Stateless Address Autoconfiguration protocol.

nodetype: leaf (ro)

type: enumeration

  • PREFERRED
    This is a valid address that can appear as the destination or source address of a packet.
  • DEPRECATED
    This is a valid but deprecated address that should no longer be used as a source address in new communications, but packets addressed to such an address are processed as expected.
  • INVALID
    This isn't a valid address, and it shouldn't appear as the destination or source address of a packet.
  • INACCESSIBLE
    The address is not accessible because the interface to which this address is assigned is not operational.
  • UNKNOWN
    The status cannot be determined for some reason.
  • TENTATIVE
    The uniqueness of the address on the link is being verified. Addresses in this state should not be used for general communication and should only be used to determine the uniqueness of the address.
  • DUPLICATE
    The address has been determined to be non-unique on the link and so must not be used.
  • OPTIMISTIC
    The address is available for use, subject to restrictions, while its uniqueness on a link is being verified.

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/
vrrp

description:
Enclosing container for VRRP groups handled by this IP interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/
vrrp-group

description:
List of VRRP groups, keyed by virtual router id

nodetype: list (rw)

list keys: [virtual-router-id]

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/
virtual-router-id

description:
References the configured virtual router id for this VRRP group

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/virtual-router-id

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/
config

description:
Configuration data for the VRRP group

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (rw)

type: uint8

  • range: 1..255

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (rw)

type: oc-inet:ip-address

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (rw)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (rw)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/config/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (rw)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

description:
For VRRP on IPv6 interfaces, sets the virtual link local address

nodetype: leaf (rw)

type: oc-inet:ip-address

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/
state

description:
Operational state data for the VRRP group

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (ro)

type: uint8

  • range: 1..255

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (ro)

type: oc-inet:ip-address

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (ro)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (ro)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (ro)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/state/
current-priority

description:
Operational value of the priority for the interface in the VRRP group

nodetype: leaf (ro)

type: uint8

description:
For VRRP on IPv6 interfaces, sets the virtual link local address

nodetype: leaf (ro)

type: oc-inet:ip-address

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/
interface-tracking

description:
Top-level container for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/
config

description:
Configuration data for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/config/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/config/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (rw)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/
state

description:
Operational state data for VRRP interface tracking

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/state/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/state/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (ro)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/subinterfaces/subinterface/ipv6/
router-advertisement

description:
Configuration and operational state parameters relating to router advertisements.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/
config

description:
Configuration parameters relating to router advertisements for IPv6.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/config/
interval

description:
The interval between periodic router advertisement neighbor discovery messages sent on this interface expressed in seconds.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/config/
lifetime

description:
The lifetime advertised in the router advertisement neighbor discovery message on this interface.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/config/
suppress

description:
When set to true, router advertisement neighbor discovery messages are not transmitted on this interface.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/config/
managed

description:
When set to true, the managed address configuration (M) flag is set in the advertised router advertisement. The M flag indicates that there are addresses available via DHCPv6.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/config/
other-config

description:
When set to true, the other configuration (O) flag is set in the advertised router advertisement. The O flag indicates that there is other configuration available via DHCPv6 (e.g., DNS servers).

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/
state

description:
Operational state parameters relating to router advertisements for IPv6.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/state/
interval

description:
The interval between periodic router advertisement neighbor discovery messages sent on this interface expressed in seconds.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/state/
lifetime

description:
The lifetime advertised in the router advertisement neighbor discovery message on this interface.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/state/
suppress

description:
When set to true, router advertisement neighbor discovery messages are not transmitted on this interface.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/state/
managed

description:
When set to true, the managed address configuration (M) flag is set in the advertised router advertisement. The M flag indicates that there are addresses available via DHCPv6.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/state/
other-config

description:
When set to true, the other configuration (O) flag is set in the advertised router advertisement. The O flag indicates that there is other configuration available via DHCPv6 (e.g., DNS servers).

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/
prefixes

description:
Container for a list of prefixes that are included in the router advertisement message.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/
prefix

description:
List of prefixes that are to be included in the IPv6 router-advertisement messages for the interface. The list is keyed by the IPv6 prefix in CIDR representation. Prefixes that are listed are those that are to be advertised in router advertisement messages. Where there are IPv6 global addresses configured on an interface and the prefix is not listed in the prefix list, it MUST NOT be advertised in the router advertisement message.

nodetype: list (rw)

list keys: [prefix]

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/
prefix

description:
Reference to the IPv6 prefix key for the prefix list.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/prefix

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/
config

description:
Configuration parameters corresponding to an IPv6 prefix within the router advertisement.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/config/
prefix

description:
IPv6 prefix to be advertised within the router advertisement message.

nodetype: leaf (rw)

type: oc-inet:ipv6-prefix

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/config/
valid-lifetime

description:
The length of time that the prefix is valid relative to the time the packet was sent.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/config/
preferred-lifetime

description:
The length of time that the address within the prefix remains in the preferred state, i.e., unrestricted use is allowed by upper-layer protocols. See RFC4862 for a complete definition of preferred behaviours.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/config/
disable-advertisement

description:
When set to true, the prefix is not advertised within router advertisement messages that are sent as a result of router soliciation messages.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/config/
disable-autoconfiguration

description:
When set to true, the prefix is marked as not to be used for stateless address configuration. This is achieved by setting the autonomous address configuration bit for the prefix.

nodetype: leaf (rw)

type: boolean

description:
When set to true, the prefix is marked as being on link by setting the L-bit for the prefix within a router advertisement.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/
state

description:
Operational state parameters corresponding to an IPv6 prefix within the router advertisement.

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/state/
prefix

description:
IPv6 prefix to be advertised within the router advertisement message.

nodetype: leaf (ro)

type: oc-inet:ipv6-prefix

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/state/
valid-lifetime

description:
The length of time that the prefix is valid relative to the time the packet was sent.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/state/
preferred-lifetime

description:
The length of time that the address within the prefix remains in the preferred state, i.e., unrestricted use is allowed by upper-layer protocols. See RFC4862 for a complete definition of preferred behaviours.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/state/
disable-advertisement

description:
When set to true, the prefix is not advertised within router advertisement messages that are sent as a result of router soliciation messages.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/subinterfaces/subinterface/ipv6/router-advertisement/prefixes/prefix/state/
disable-autoconfiguration

description:
When set to true, the prefix is marked as not to be used for stateless address configuration. This is achieved by setting the autonomous address configuration bit for the prefix.

nodetype: leaf (ro)

type: boolean

description:
When set to true, the prefix is marked as being on link by setting the L-bit for the prefix within a router advertisement.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/subinterfaces/subinterface/ipv6/
neighbors

description:
Enclosing container for list of IPv6 neighbors

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/
neighbor

description:
List of IPv6 neighbors

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/
ip

description:
References the configured IP neighbor address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/
config

description:
Configuration data for each IPv6 address on the interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/config/
ip

description:
The IPv6 address of the neighbor node.

nodetype: leaf (rw)

type: oc-inet:ipv6-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (rw)

type: oc-yang:phys-address

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/
state

description:
State data for each IPv6 address on the interface

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/state/
ip

description:
The IPv6 address of the neighbor node.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (ro)

type: oc-yang:phys-address

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/state/
origin

description:
The origin of this neighbor entry.

nodetype: leaf (ro)

type: neighbor-origin

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/state/
is-router

description:
Indicates that the neighbor node acts as a router.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/subinterfaces/subinterface/ipv6/neighbors/neighbor/state/
neighbor-state

description:
The Neighbor Unreachability Detection state of this entry.

nodetype: leaf (ro)

type: enumeration

  • INCOMPLETE
    Address resolution is in progress, and the link-layer address of the neighbor has not yet been determined.
  • REACHABLE
    Roughly speaking, the neighbor is known to have been reachable recently (within tens of seconds ago).
  • STALE
    The neighbor is no longer known to be reachable, but until traffic is sent to the neighbor no attempt should be made to verify its reachability.
  • DELAY
    The neighbor is no longer known to be reachable, and traffic has recently been sent to the neighbor. Rather than probe the neighbor immediately, however, delay sending probes for a short while in order to give upper-layer protocols a chance to provide reachability confirmation.
  • PROBE
    The neighbor is no longer known to be reachable, and unicast Neighbor Solicitation probes are being sent to verify reachability.

/interfaces/interface/subinterfaces/subinterface/ipv6/
unnumbered

description:
Top-level container for setting unnumbered interfaces. Includes reference the interface that provides the address information

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/
config

description:
Configuration data for unnumbered interface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/config/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/
state

description:
Operational state data for unnumbered interfaces

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/state/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/subinterfaces/subinterface/ipv6/unnumbered/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/subinterfaces/subinterface/ipv6/
config

description:
Top-level config data for the IPv6 interface

nodetype: container (rw)

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

description:
Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv6/config/
mtu

description:
The size, in octets, of the largest IPv6 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (rw)

type: uint32

  • range: 1280..max

units: octets

/interfaces/interface/subinterfaces/subinterface/ipv6/config/
dup-addr-detect-transmits

description:
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions.

nodetype: leaf (rw)

type: uint32

default: 1

/interfaces/interface/subinterfaces/subinterface/ipv6/config/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/
state

description:
Top-level operational state data for the IPv6 interface

nodetype: container (ro)

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

description:
Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv6/state/
mtu

description:
The size, in octets, of the largest IPv6 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (ro)

type: uint32

  • range: 1280..max

units: octets

/interfaces/interface/subinterfaces/subinterface/ipv6/state/
dup-addr-detect-transmits

description:
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions.

nodetype: leaf (ro)

type: uint32

default: 1

/interfaces/interface/subinterfaces/subinterface/ipv6/state/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (ro)

type: boolean

default: false

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

description:
Packet and byte counters for IP transmission and reception for the address family.

nodetype: container (ro)

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

description:
The total number of IP packets received for the specified address family, including those received in error

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets received in input IP packets for the specified address family, including those received in error.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
Number of IP packets discarded due to errors for the specified address family, including errors in the IP header, no route found to the IP destination, invalid address, unknown protocol, etc.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of input packets for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of octets received in input IP packets for the specified address family for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of input IP packets for the specified address family, for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets in IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
Number of IP packets for the specified address family locally generated and discarded due to errors, including no route found to the IP destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of octets in packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The number of output IP packets for the specified address family for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/subinterfaces/subinterface/ipv6/
autoconf

description:
Top-level container for IPv6 autoconf

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/
config

description:
[adapted from IETF IP model RFC 7277] Parameters to control the autoconfiguration of IPv6 addresses, as described in RFC 4862.

nodetype: container (rw)

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/config/
create-global-addresses

description:
[adapted from IETF IP model RFC 7277] If enabled, the host creates global addresses as described in RFC 4862.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/config/
create-temporary-addresses

description:
[adapted from IETF IP model RFC 7277] If enabled, the host creates temporary addresses as described in RFC 4941.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/config/
temporary-valid-lifetime

description:
[adapted from IETF IP model RFC 7277] The time period during which the temporary address is valid.

nodetype: leaf (rw)

type: uint32

default: 604800

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/config/
temporary-preferred-lifetime

description:
[adapted from IETF IP model RFC 7277] The time period during which the temporary address is preferred.

nodetype: leaf (rw)

type: uint32

default: 86400

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/
state

description:
Operational state data

nodetype: container (ro)

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/state/
create-global-addresses

description:
[adapted from IETF IP model RFC 7277] If enabled, the host creates global addresses as described in RFC 4862.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/state/
create-temporary-addresses

description:
[adapted from IETF IP model RFC 7277] If enabled, the host creates temporary addresses as described in RFC 4941.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/state/
temporary-valid-lifetime

description:
[adapted from IETF IP model RFC 7277] The time period during which the temporary address is valid.

nodetype: leaf (ro)

type: uint32

default: 604800

units: seconds

/interfaces/interface/subinterfaces/subinterface/ipv6/autoconf/state/
temporary-preferred-lifetime

description:
[adapted from IETF IP model RFC 7277] The time period during which the temporary address is preferred.

nodetype: leaf (ro)

type: uint32

default: 86400

units: seconds

/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/counters/
in-distribution

description:
The size distribution of the received frames.

nodetype: container (ro)

/interfaces/interface/ethernet/state/counters/in-distribution/
in-frames-64-octets

description:
Number of packets (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/in-distribution/
in-frames-65-127-octets

description:
Number of good and bad packets received that were between 65 and 127 bytes in length (excluding framing bits but including FCS bytes).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/in-distribution/
in-frames-128-255-octets

description:
Number of good and bad packets received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/in-distribution/
in-frames-256-511-octets

description:
Number of good and bad packets received that were between 256 and 511 bytes in length inclusive (excluding framing bits but including FCS bytes).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/in-distribution/
in-frames-512-1023-octets

description:
Number of good and bad packets received that were between 512 and 1023 bytes in length inclusive (excluding framing bits but including FCS bytes).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/ethernet/state/counters/in-distribution/
in-frames-1024-1518-octets

description:
Number of good and bad packets received that were between 1024 and 1518 bytes in length inclusive (excluding framing bits but including FCS bytes).

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/ethernet/switched-vlan/
dot1x-vlan-map

description:
Enclosing container for mapping a VLAN name to VLAN id

nodetype: container (rw)

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/
vlan-name

description:
A list of mappings from VLAN name to VLAN id. Entries in this list are utilized for DVA using a VLAN name; eg when RADIUS returns a VLAN name as the tunnel-private-group-id.

nodetype: list (rw)

list keys: [vlan-name]

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/
vlan-name

description:
References the configured VLAN name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/vlan-name

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/
config

description:
Configuration data for each configured VLAN name in the VLAN ID to VLAN name mapping

nodetype: container (rw)

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/config/
vlan-name

description:
The VLAN name to be mapped to the VLAN id.

nodetype: leaf (rw)

type: string

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/config/
id

description:
The VLAN id to be mapped to the VLAN name.

nodetype: leaf (rw)

type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/
state

description:
Operational state data for each VLAN id to VLAN name mapping.

nodetype: container (ro)

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/state/
vlan-name

description:
The VLAN name to be mapped to the VLAN id.

nodetype: leaf (ro)

type: string

/interfaces/interface/ethernet/switched-vlan/dot1x-vlan-map/vlan-name/state/
id

description:
The VLAN id to be mapped to the VLAN name.

nodetype: leaf (ro)

type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/
poe

description:
Top-level container for PoE configuration and state data

nodetype: container (rw)

/interfaces/interface/ethernet/poe/
config

description:
Configuration data for PoE

nodetype: container (rw)

/interfaces/interface/ethernet/poe/config/
enabled

description:
Enable or disable PoE in the ethernet interface.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/ethernet/poe/
state

description:
Operational state data for PoE

nodetype: container (ro)

/interfaces/interface/ethernet/poe/state/
enabled

description:
Enable or disable PoE in the ethernet interface.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/ethernet/poe/state/
power-used

description:
Power used by the ethernet interface in Watts.

nodetype: leaf (ro)

type: decimal64

units: Watts

/interfaces/interface/ethernet/poe/state/
power-class

description:
IEEE 802.3af Power class detected for this ethernet interface.

nodetype: leaf (ro)

type: uint8

/interfaces/interface/ethernet/
dot1x

description:
Top level container for 802.1X configuration and state data.

nodetype: container (rw)

/interfaces/interface/ethernet/dot1x/
config

description:
Top level configuration container for 802.1X.

nodetype: container (rw)

/interfaces/interface/ethernet/dot1x/config/
authenticate-port

description:
Enable 802.1X port control on an interface.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/ethernet/dot1x/config/
host-mode

description:
Allow for single or multiple hosts to communicate through an 802.1X controlled port.

nodetype: leaf (rw)

type: enumeration

  • SINGLE_HOST
    Only single supplicant can communicate through the port. If the supplicant logs off or the port state is changed, the port becomes unauthenticated.
  • MULTI_HOST
    Multiple hosts can communicate over a single port. Only the first supplicant is authenticated while subsequent hosts have network access without having to authenticate.
  • MULTI_DOMAIN
    Allows for authentication of multiple clients individually on one authenticator port.

/interfaces/interface/ethernet/dot1x/config/
reauthenticate-interval

description:
Enable periodic re-authentication of the device connected to this port. Setting a value of 0 disabled reauthentication on this port.

nodetype: leaf (rw)

type: uint16

units: seconds

/interfaces/interface/ethernet/dot1x/config/
retransmit-interval

description:
How long the interface waits for a response from an EAPoL Start before restarting 802.1X authentication on the port.

nodetype: leaf (rw)

type: uint16

units: seconds

/interfaces/interface/ethernet/dot1x/config/
supplicant-timeout

description:
Time to wait for a response from the supplicant before restarting the 802.1X authentication process.

nodetype: leaf (rw)

type: uint16

units: seconds

/interfaces/interface/ethernet/dot1x/config/
max-requests

description:
Maximum number of times an EAPoL request packet is retransmitted to the supplicant before the authentication session fails.

nodetype: leaf (rw)

type: uint16

/interfaces/interface/ethernet/dot1x/config/
server-fail-vlan

description:
If RADIUS is unresponsive, the supplicant shall be placed in this VLAN. If this VLAN is configured as a VLAN name, the vlan-map must be populated for the Authenticator to map this VLAN name to a VLAN id.

nodetype: leaf (rw)

type: union

    type: string

    type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/dot1x/config/
auth-fail-vlan

description:
Upon failure to authenticate, the port is set to this VLAN. If this VLAN is a configured as a VLAN name, the vlan-map must be populated for the Authenticator to map this VLAN name to a VLAN id.

nodetype: leaf (rw)

type: union

    type: string

    type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/dot1x/
state

description:
Top level state container for 802.1X.

nodetype: container (ro)

/interfaces/interface/ethernet/dot1x/state/
authenticate-port

description:
Enable 802.1X port control on an interface.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/ethernet/dot1x/state/
host-mode

description:
Allow for single or multiple hosts to communicate through an 802.1X controlled port.

nodetype: leaf (ro)

type: enumeration

  • SINGLE_HOST
    Only single supplicant can communicate through the port. If the supplicant logs off or the port state is changed, the port becomes unauthenticated.
  • MULTI_HOST
    Multiple hosts can communicate over a single port. Only the first supplicant is authenticated while subsequent hosts have network access without having to authenticate.
  • MULTI_DOMAIN
    Allows for authentication of multiple clients individually on one authenticator port.

/interfaces/interface/ethernet/dot1x/state/
reauthenticate-interval

description:
Enable periodic re-authentication of the device connected to this port. Setting a value of 0 disabled reauthentication on this port.

nodetype: leaf (ro)

type: uint16

units: seconds

/interfaces/interface/ethernet/dot1x/state/
retransmit-interval

description:
How long the interface waits for a response from an EAPoL Start before restarting 802.1X authentication on the port.

nodetype: leaf (ro)

type: uint16

units: seconds

/interfaces/interface/ethernet/dot1x/state/
supplicant-timeout

description:
Time to wait for a response from the supplicant before restarting the 802.1X authentication process.

nodetype: leaf (ro)

type: uint16

units: seconds

/interfaces/interface/ethernet/dot1x/state/
max-requests

description:
Maximum number of times an EAPoL request packet is retransmitted to the supplicant before the authentication session fails.

nodetype: leaf (ro)

type: uint16

/interfaces/interface/ethernet/dot1x/state/
server-fail-vlan

description:
If RADIUS is unresponsive, the supplicant shall be placed in this VLAN. If this VLAN is configured as a VLAN name, the vlan-map must be populated for the Authenticator to map this VLAN name to a VLAN id.

nodetype: leaf (ro)

type: union

    type: string

    type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/dot1x/state/
auth-fail-vlan

description:
Upon failure to authenticate, the port is set to this VLAN. If this VLAN is a configured as a VLAN name, the vlan-map must be populated for the Authenticator to map this VLAN name to a VLAN id.

nodetype: leaf (ro)

type: union

    type: string

    type: oc-vlan-types:vlan-id

/interfaces/interface/ethernet/
authenticated-sessions

description:
Top level container for authenticated sessions state data.

nodetype: container (rw)

/interfaces/interface/ethernet/authenticated-sessions/
authenticated-session

description:
The list of authenticated sessions on this device.

nodetype: list (ro)

list keys: [mac]

/interfaces/interface/ethernet/authenticated-sessions/authenticated-session/
mac

description:
Device MAC address.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/mac

/interfaces/interface/ethernet/authenticated-sessions/authenticated-session/
state

description:
Top level state container for 802.1X.

nodetype: container (ro)

/interfaces/interface/ethernet/authenticated-sessions/authenticated-session/state/
mac

description:
Device MAC address.

nodetype: leaf (ro)

type: oc-yang:mac-address

/interfaces/interface/ethernet/authenticated-sessions/authenticated-session/state/
session-id

description:
The locally-significant session id which this authenticated session applies to. Typically used for RADIUS accounting or other system level telemetry.

nodetype: leaf (ro)

type: string

/interfaces/interface/ethernet/authenticated-sessions/authenticated-session/state/
status

description:
The status of the 802.1X session for a device.

nodetype: leaf (ro)

type: enumeration

  • AUTHENTICATED
    The session has succesfully completed one of the authentication methods allowed on the port.
  • AUTHENTICATING
    The session is in the process of authenticating.
  • FAILED_AUTHENTICATION
    An authentication has been attempted for this session, and has failed.
  • SUPPLICANT_TIMEOUT
    An authentication has been attempted for this session, however the supplicant has not responded. This is likely due to the attached devices lack of 802.1X support.

/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

/interfaces/interface/routed-vlan/
ipv4

description:
Parameters for the IPv4 address family.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/
addresses

description:
Enclosing container for address list

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/addresses/
address

description:
The list of configured IPv4 addresses on the interface.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/routed-vlan/ipv4/addresses/address/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/routed-vlan/ipv4/addresses/address/
config

description:
Configuration data for each configured IPv4 address on the interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/addresses/address/config/
ip

description:
The IPv4 address on the interface.

nodetype: leaf (rw)

type: oc-inet:ipv4-address

/interfaces/interface/routed-vlan/ipv4/addresses/address/config/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (rw)

type: uint8

  • range: 0..32

/interfaces/interface/routed-vlan/ipv4/addresses/address/
state

description:
Operational state data for each IPv4 address configured on the interface

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/addresses/address/state/
ip

description:
The IPv4 address on the interface.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/interfaces/interface/routed-vlan/ipv4/addresses/address/state/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (ro)

type: uint8

  • range: 0..32

/interfaces/interface/routed-vlan/ipv4/addresses/address/state/
origin

description:
The origin of this address, e.g., statically configured, assigned by DHCP, etc..

nodetype: leaf (ro)

type: ip-address-origin

/interfaces/interface/routed-vlan/ipv4/addresses/address/
vrrp

description:
Enclosing container for VRRP groups handled by this IP interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/
vrrp-group

description:
List of VRRP groups, keyed by virtual router id

nodetype: list (rw)

list keys: [virtual-router-id]

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/
virtual-router-id

description:
References the configured virtual router id for this VRRP group

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/virtual-router-id

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/
config

description:
Configuration data for the VRRP group

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (rw)

type: uint8

  • range: 1..255

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (rw)

type: oc-inet:ip-address

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (rw)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (rw)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/config/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (rw)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/
state

description:
Operational state data for the VRRP group

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (ro)

type: uint8

  • range: 1..255

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (ro)

type: oc-inet:ip-address

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (ro)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (ro)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (ro)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/state/
current-priority

description:
Operational value of the priority for the interface in the VRRP group

nodetype: leaf (ro)

type: uint8

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/
interface-tracking

description:
Top-level container for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/
config

description:
Configuration data for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/config/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/config/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (rw)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/
state

description:
Operational state data for VRRP interface tracking

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/state/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv4/addresses/address/vrrp/vrrp-group/interface-tracking/state/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (ro)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/routed-vlan/ipv4/
proxy-arp

description:
Configuration and operational state parameters relating to proxy ARP. This functionality allows a system to respond to ARP requests that are not explicitly destined to the local system.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/proxy-arp/
config

description:
Configuration parameters for proxy ARP

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/proxy-arp/config/
mode

description:
When set to a value other than DISABLE, the local system should respond to ARP requests that are for target addresses other than those that are configured on the local subinterface using its own MAC address as the target hardware address. If the REMOTE_ONLY value is specified, replies are only sent when the target address falls outside the locally configured subnets on the interface, whereas with the ALL value, all requests, regardless of their target address are replied to.

nodetype: leaf (rw)

type: enumeration

  • DISABLE
    The system should not respond to ARP requests that do not specify an IP address configured on the local subinterface as the target address.
  • REMOTE_ONLY
    The system responds to ARP requests only when the sender and target IP addresses are in different subnets.
  • ALL
    The system responds to ARP requests where the sender and target IP addresses are in different subnets, as well as those where they are in the same subnet.

default: DISABLE

/interfaces/interface/routed-vlan/ipv4/proxy-arp/
state

description:
Operational state parameters for proxy ARP

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/proxy-arp/state/
mode

description:
When set to a value other than DISABLE, the local system should respond to ARP requests that are for target addresses other than those that are configured on the local subinterface using its own MAC address as the target hardware address. If the REMOTE_ONLY value is specified, replies are only sent when the target address falls outside the locally configured subnets on the interface, whereas with the ALL value, all requests, regardless of their target address are replied to.

nodetype: leaf (ro)

type: enumeration

  • DISABLE
    The system should not respond to ARP requests that do not specify an IP address configured on the local subinterface as the target address.
  • REMOTE_ONLY
    The system responds to ARP requests only when the sender and target IP addresses are in different subnets.
  • ALL
    The system responds to ARP requests where the sender and target IP addresses are in different subnets, as well as those where they are in the same subnet.

default: DISABLE

/interfaces/interface/routed-vlan/ipv4/
neighbors

description:
Enclosing container for neighbor list

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/neighbors/
neighbor

description:
A list of mappings from IPv4 addresses to link-layer addresses. Entries in this list are used as static entries in the ARP Cache.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/routed-vlan/ipv4/neighbors/neighbor/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/routed-vlan/ipv4/neighbors/neighbor/
config

description:
Configuration data for each configured IPv4 address on the interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/neighbors/neighbor/config/
ip

description:
The IPv4 address of the neighbor node.

nodetype: leaf (rw)

type: oc-inet:ipv4-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (rw)

type: oc-yang:phys-address

/interfaces/interface/routed-vlan/ipv4/neighbors/neighbor/
state

description:
Operational state data for each IPv4 address configured on the interface

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/neighbors/neighbor/state/
ip

description:
The IPv4 address of the neighbor node.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (ro)

type: oc-yang:phys-address

/interfaces/interface/routed-vlan/ipv4/neighbors/neighbor/state/
origin

description:
The origin of this neighbor entry, static or dynamic.

nodetype: leaf (ro)

type: neighbor-origin

/interfaces/interface/routed-vlan/ipv4/
unnumbered

description:
Top-level container for setting unnumbered interfaces. Includes reference the interface that provides the address information

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/unnumbered/
config

description:
Configuration data for unnumbered interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/unnumbered/config/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv4/unnumbered/
state

description:
Operational state data for unnumbered interfaces

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/unnumbered/state/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv4/unnumbered/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/unnumbered/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/unnumbered/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv4/unnumbered/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/routed-vlan/ipv4/unnumbered/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/unnumbered/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv4/unnumbered/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

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

description:
Top-level IPv4 configuration data for the interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv4/config/
enabled

description:
Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv4/config/
mtu

description:
The size, in octets, of the largest IPv4 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (rw)

type: uint16

  • range: 68..max

units: octets

/interfaces/interface/routed-vlan/ipv4/config/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (rw)

type: boolean

default: false

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

description:
Top level IPv4 operational state data

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/state/
enabled

description:
Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv4/state/
mtu

description:
The size, in octets, of the largest IPv4 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (ro)

type: uint16

  • range: 68..max

units: octets

/interfaces/interface/routed-vlan/ipv4/state/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv4/state/
counters

description:
Packet and byte counters for IP transmission and reception for the address family.

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv4/state/counters/
in-pkts

description:
The total number of IP packets received for the specified address family, including those received in error

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
in-octets

description:
The total number of octets received in input IP packets for the specified address family, including those received in error.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
in-error-pkts

description:
Number of IP packets discarded due to errors for the specified address family, including errors in the IP header, no route found to the IP destination, invalid address, unknown protocol, etc.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
in-forwarded-pkts

description:
The number of input packets for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
in-forwarded-octets

description:
The number of octets received in input IP packets for the specified address family for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
in-discarded-pkts

description:
The number of input IP packets for the specified address family, for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
out-pkts

description:
The total number of IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
out-octets

description:
The total number of octets in IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
out-error-pkts

description:
Number of IP packets for the specified address family locally generated and discarded due to errors, including no route found to the IP destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
out-forwarded-pkts

description:
The number of packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
out-forwarded-octets

description:
The number of octets in packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv4/state/counters/
out-discarded-pkts

description:
The number of output IP packets for the specified address family for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/
ipv6

description:
Parameters for the IPv6 address family.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/
addresses

description:
Enclosing container for address list

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/addresses/
address

description:
The list of configured IPv6 addresses on the interface.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/routed-vlan/ipv6/addresses/address/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/routed-vlan/ipv6/addresses/address/
config

description:
Configuration data for each IPv6 address on the interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/addresses/address/config/
ip

description:
The IPv6 address on the interface.

nodetype: leaf (rw)

type: oc-inet:ipv6-address

/interfaces/interface/routed-vlan/ipv6/addresses/address/config/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (rw)

type: uint8

  • range: 0..128

/interfaces/interface/routed-vlan/ipv6/addresses/address/
state

description:
State data for each IPv6 address on the interface

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/addresses/address/state/
ip

description:
The IPv6 address on the interface.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/interfaces/interface/routed-vlan/ipv6/addresses/address/state/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (ro)

type: uint8

  • range: 0..128

/interfaces/interface/routed-vlan/ipv6/addresses/address/state/
origin

description:
The origin of this address, e.g., static, dhcp, etc.

nodetype: leaf (ro)

type: ip-address-origin

/interfaces/interface/routed-vlan/ipv6/addresses/address/state/
status

description:
The status of an address. Most of the states correspond to states from the IPv6 Stateless Address Autoconfiguration protocol.

nodetype: leaf (ro)

type: enumeration

  • PREFERRED
    This is a valid address that can appear as the destination or source address of a packet.
  • DEPRECATED
    This is a valid but deprecated address that should no longer be used as a source address in new communications, but packets addressed to such an address are processed as expected.
  • INVALID
    This isn't a valid address, and it shouldn't appear as the destination or source address of a packet.
  • INACCESSIBLE
    The address is not accessible because the interface to which this address is assigned is not operational.
  • UNKNOWN
    The status cannot be determined for some reason.
  • TENTATIVE
    The uniqueness of the address on the link is being verified. Addresses in this state should not be used for general communication and should only be used to determine the uniqueness of the address.
  • DUPLICATE
    The address has been determined to be non-unique on the link and so must not be used.
  • OPTIMISTIC
    The address is available for use, subject to restrictions, while its uniqueness on a link is being verified.

/interfaces/interface/routed-vlan/ipv6/addresses/address/
vrrp

description:
Enclosing container for VRRP groups handled by this IP interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/
vrrp-group

description:
List of VRRP groups, keyed by virtual router id

nodetype: list (rw)

list keys: [virtual-router-id]

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/
virtual-router-id

description:
References the configured virtual router id for this VRRP group

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/virtual-router-id

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/
config

description:
Configuration data for the VRRP group

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (rw)

type: uint8

  • range: 1..255

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (rw)

type: oc-inet:ip-address

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (rw)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (rw)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/config/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (rw)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

description:
For VRRP on IPv6 interfaces, sets the virtual link local address

nodetype: leaf (rw)

type: oc-inet:ip-address

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/
state

description:
Operational state data for the VRRP group

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
virtual-router-id

description:
Set the virtual router id for use by the VRRP group. This usually also determines the virtual MAC address that is generated for the VRRP group

nodetype: leaf (ro)

type: uint8

  • range: 1..255

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
virtual-address

description:
Configure one or more virtual addresses for the VRRP group

nodetype: leaf-list (ro)

type: oc-inet:ip-address

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
priority

description:
Specifies the sending VRRP interface's priority for the virtual router. Higher values equal higher priority

nodetype: leaf (ro)

type: uint8

  • range: 1..254

default: 100

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
preempt

description:
When set to true, enables preemption by a higher priority backup router of a lower priority master router

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
preempt-delay

description:
Set the delay the higher priority router waits before preempting

nodetype: leaf (ro)

type: uint16

  • range: 0..3600

default: 0

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
accept-mode

description:
Configure whether packets destined for virtual addresses are accepted even when the virtual address is not owned by the router interface

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
advertisement-interval

description:
Sets the interval between successive VRRP advertisements -- RFC 5798 defines this as a 12-bit value expressed as 0.1 seconds, with default 100, i.e., 1 second. Several implementation express this in units of seconds

nodetype: leaf (ro)

type: uint16

  • range: 1..4095

default: 100

units: centiseconds

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/state/
current-priority

description:
Operational value of the priority for the interface in the VRRP group

nodetype: leaf (ro)

type: uint8

description:
For VRRP on IPv6 interfaces, sets the virtual link local address

nodetype: leaf (ro)

type: oc-inet:ip-address

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/
interface-tracking

description:
Top-level container for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/
config

description:
Configuration data for VRRP interface tracking

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/config/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/config/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (rw)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/
state

description:
Operational state data for VRRP interface tracking

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/state/
track-interface

description:
Sets a list of one or more interfaces that should be tracked for up/down events to dynamically change the priority state of the VRRP group, and potentially change the mastership if the tracked interface going down lowers the priority sufficiently. Any of the tracked interfaces going down will cause the priority to be lowered. Some implementations may only support a single tracked interface.

nodetype: leaf-list (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv6/addresses/address/vrrp/vrrp-group/interface-tracking/state/
priority-decrement

description:
Set the value to subtract from priority when the tracked interface goes down

nodetype: leaf (ro)

type: uint8

  • range: 0..254

default: 0

/interfaces/interface/routed-vlan/ipv6/
router-advertisement

description:
Configuration and operational state parameters relating to router advertisements.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/router-advertisement/
config

description:
Configuration parameters relating to router advertisements for IPv6.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/router-advertisement/config/
interval

description:
The interval between periodic router advertisement neighbor discovery messages sent on this interface expressed in seconds.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/config/
lifetime

description:
The lifetime advertised in the router advertisement neighbor discovery message on this interface.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/config/
suppress

description:
When set to true, router advertisement neighbor discovery messages are not transmitted on this interface.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/router-advertisement/config/
managed

description:
When set to true, the managed address configuration (M) flag is set in the advertised router advertisement. The M flag indicates that there are addresses available via DHCPv6.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/router-advertisement/config/
other-config

description:
When set to true, the other configuration (O) flag is set in the advertised router advertisement. The O flag indicates that there is other configuration available via DHCPv6 (e.g., DNS servers).

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/router-advertisement/
state

description:
Operational state parameters relating to router advertisements for IPv6.

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/router-advertisement/state/
interval

description:
The interval between periodic router advertisement neighbor discovery messages sent on this interface expressed in seconds.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/state/
lifetime

description:
The lifetime advertised in the router advertisement neighbor discovery message on this interface.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/state/
suppress

description:
When set to true, router advertisement neighbor discovery messages are not transmitted on this interface.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/router-advertisement/state/
managed

description:
When set to true, the managed address configuration (M) flag is set in the advertised router advertisement. The M flag indicates that there are addresses available via DHCPv6.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/router-advertisement/state/
other-config

description:
When set to true, the other configuration (O) flag is set in the advertised router advertisement. The O flag indicates that there is other configuration available via DHCPv6 (e.g., DNS servers).

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/router-advertisement/
prefixes

description:
Container for a list of prefixes that are included in the router advertisement message.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/
prefix

description:
List of prefixes that are to be included in the IPv6 router-advertisement messages for the interface. The list is keyed by the IPv6 prefix in CIDR representation. Prefixes that are listed are those that are to be advertised in router advertisement messages. Where there are IPv6 global addresses configured on an interface and the prefix is not listed in the prefix list, it MUST NOT be advertised in the router advertisement message.

nodetype: list (rw)

list keys: [prefix]

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/
prefix

description:
Reference to the IPv6 prefix key for the prefix list.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/prefix

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/
config

description:
Configuration parameters corresponding to an IPv6 prefix within the router advertisement.

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/config/
prefix

description:
IPv6 prefix to be advertised within the router advertisement message.

nodetype: leaf (rw)

type: oc-inet:ipv6-prefix

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/config/
valid-lifetime

description:
The length of time that the prefix is valid relative to the time the packet was sent.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/config/
preferred-lifetime

description:
The length of time that the address within the prefix remains in the preferred state, i.e., unrestricted use is allowed by upper-layer protocols. See RFC4862 for a complete definition of preferred behaviours.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/config/
disable-advertisement

description:
When set to true, the prefix is not advertised within router advertisement messages that are sent as a result of router soliciation messages.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/config/
disable-autoconfiguration

description:
When set to true, the prefix is marked as not to be used for stateless address configuration. This is achieved by setting the autonomous address configuration bit for the prefix.

nodetype: leaf (rw)

type: boolean

description:
When set to true, the prefix is marked as being on link by setting the L-bit for the prefix within a router advertisement.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/
state

description:
Operational state parameters corresponding to an IPv6 prefix within the router advertisement.

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/state/
prefix

description:
IPv6 prefix to be advertised within the router advertisement message.

nodetype: leaf (ro)

type: oc-inet:ipv6-prefix

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/state/
valid-lifetime

description:
The length of time that the prefix is valid relative to the time the packet was sent.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/state/
preferred-lifetime

description:
The length of time that the address within the prefix remains in the preferred state, i.e., unrestricted use is allowed by upper-layer protocols. See RFC4862 for a complete definition of preferred behaviours.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/state/
disable-advertisement

description:
When set to true, the prefix is not advertised within router advertisement messages that are sent as a result of router soliciation messages.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/routed-vlan/ipv6/router-advertisement/prefixes/prefix/state/
disable-autoconfiguration

description:
When set to true, the prefix is marked as not to be used for stateless address configuration. This is achieved by setting the autonomous address configuration bit for the prefix.

nodetype: leaf (ro)

type: boolean

description:
When set to true, the prefix is marked as being on link by setting the L-bit for the prefix within a router advertisement.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/routed-vlan/ipv6/
neighbors

description:
Enclosing container for list of IPv6 neighbors

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/neighbors/
neighbor

description:
List of IPv6 neighbors

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/
ip

description:
References the configured IP neighbor address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/
config

description:
Configuration data for each IPv6 address on the interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/config/
ip

description:
The IPv6 address of the neighbor node.

nodetype: leaf (rw)

type: oc-inet:ipv6-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (rw)

type: oc-yang:phys-address

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/
state

description:
State data for each IPv6 address on the interface

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/state/
ip

description:
The IPv6 address of the neighbor node.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (ro)

type: oc-yang:phys-address

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/state/
origin

description:
The origin of this neighbor entry.

nodetype: leaf (ro)

type: neighbor-origin

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/state/
is-router

description:
Indicates that the neighbor node acts as a router.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/routed-vlan/ipv6/neighbors/neighbor/state/
neighbor-state

description:
The Neighbor Unreachability Detection state of this entry.

nodetype: leaf (ro)

type: enumeration

  • INCOMPLETE
    Address resolution is in progress, and the link-layer address of the neighbor has not yet been determined.
  • REACHABLE
    Roughly speaking, the neighbor is known to have been reachable recently (within tens of seconds ago).
  • STALE
    The neighbor is no longer known to be reachable, but until traffic is sent to the neighbor no attempt should be made to verify its reachability.
  • DELAY
    The neighbor is no longer known to be reachable, and traffic has recently been sent to the neighbor. Rather than probe the neighbor immediately, however, delay sending probes for a short while in order to give upper-layer protocols a chance to provide reachability confirmation.
  • PROBE
    The neighbor is no longer known to be reachable, and unicast Neighbor Solicitation probes are being sent to verify reachability.

/interfaces/interface/routed-vlan/ipv6/
unnumbered

description:
Top-level container for setting unnumbered interfaces. Includes reference the interface that provides the address information

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/unnumbered/
config

description:
Configuration data for unnumbered interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/unnumbered/config/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/unnumbered/
state

description:
Operational state data for unnumbered interfaces

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/unnumbered/state/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/unnumbered/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/unnumbered/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/unnumbered/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv6/unnumbered/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/routed-vlan/ipv6/unnumbered/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/unnumbered/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/routed-vlan/ipv6/unnumbered/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

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

description:
Top-level config data for the IPv6 interface

nodetype: container (rw)

/interfaces/interface/routed-vlan/ipv6/config/
enabled

description:
Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv6/config/
mtu

description:
The size, in octets, of the largest IPv6 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (rw)

type: uint32

  • range: 1280..max

units: octets

/interfaces/interface/routed-vlan/ipv6/config/
dup-addr-detect-transmits

description:
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions.

nodetype: leaf (rw)

type: uint32

default: 1

/interfaces/interface/routed-vlan/ipv6/config/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (rw)

type: boolean

default: false

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

description:
Top-level operational state data for the IPv6 interface

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/state/
enabled

description:
Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/routed-vlan/ipv6/state/
mtu

description:
The size, in octets, of the largest IPv6 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (ro)

type: uint32

  • range: 1280..max

units: octets

/interfaces/interface/routed-vlan/ipv6/state/
dup-addr-detect-transmits

description:
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions.

nodetype: leaf (ro)

type: uint32

default: 1

/interfaces/interface/routed-vlan/ipv6/state/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/routed-vlan/ipv6/state/
counters

description:
Packet and byte counters for IP transmission and reception for the address family.

nodetype: container (ro)

/interfaces/interface/routed-vlan/ipv6/state/counters/
in-pkts

description:
The total number of IP packets received for the specified address family, including those received in error

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
in-octets

description:
The total number of octets received in input IP packets for the specified address family, including those received in error.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
in-error-pkts

description:
Number of IP packets discarded due to errors for the specified address family, including errors in the IP header, no route found to the IP destination, invalid address, unknown protocol, etc.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
in-forwarded-pkts

description:
The number of input packets for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
in-forwarded-octets

description:
The number of octets received in input IP packets for the specified address family for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
in-discarded-pkts

description:
The number of input IP packets for the specified address family, for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
out-pkts

description:
The total number of IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
out-octets

description:
The total number of octets in IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
out-error-pkts

description:
Number of IP packets for the specified address family locally generated and discarded due to errors, including no route found to the IP destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
out-forwarded-pkts

description:
The number of packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
out-forwarded-octets

description:
The number of octets in packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/routed-vlan/ipv6/state/counters/
out-discarded-pkts

description:
The number of output IP packets for the specified address family for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/
tunnel

description:
In the case that the interface is logical tunnel interface, the parameters for the tunnel are specified within this subtree. Tunnel interfaces have only a single logical subinterface associated with them.

nodetype: container (rw)

/interfaces/interface/tunnel/
config

description:
Configuration parameters associated with the tunnel interface

nodetype: container (rw)

/interfaces/interface/tunnel/config/
src

description:
The source address that should be used for the tunnel.

nodetype: leaf (rw)

type: oc-inet:ip-address

/interfaces/interface/tunnel/config/
dst

description:
The destination address for the tunnel.

nodetype: leaf (rw)

type: oc-inet:ip-address

/interfaces/interface/tunnel/config/
ttl

description:
The time-to-live (or hop limit) that should be utilised for the IP packets used for the tunnel transport.

nodetype: leaf (rw)

type: uint8

  • range: 1..255

/interfaces/interface/tunnel/config/
gre-key

description:
The GRE key to be specified for the tunnel. The key is used to identify a traffic flow within a tunnel.

nodetype: leaf (rw)

type: uint32

/interfaces/interface/tunnel/
state

description:
Operational state parameters associated with the tunnel interface.

nodetype: container (ro)

/interfaces/interface/tunnel/state/
src

description:
The source address that should be used for the tunnel.

nodetype: leaf (ro)

type: oc-inet:ip-address

/interfaces/interface/tunnel/state/
dst

description:
The destination address for the tunnel.

nodetype: leaf (ro)

type: oc-inet:ip-address

/interfaces/interface/tunnel/state/
ttl

description:
The time-to-live (or hop limit) that should be utilised for the IP packets used for the tunnel transport.

nodetype: leaf (ro)

type: uint8

  • range: 1..255

/interfaces/interface/tunnel/state/
gre-key

description:
The GRE key to be specified for the tunnel. The key is used to identify a traffic flow within a tunnel.

nodetype: leaf (ro)

type: uint32

/interfaces/interface/tunnel/
ipv4

description:
Parameters for the IPv4 address family.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/
addresses

description:
Enclosing container for address list

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/addresses/
address

description:
The list of configured IPv4 addresses on the interface.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/tunnel/ipv4/addresses/address/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/tunnel/ipv4/addresses/address/
config

description:
Configuration data for each configured IPv4 address on the interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/addresses/address/config/
ip

description:
The IPv4 address on the interface.

nodetype: leaf (rw)

type: oc-inet:ipv4-address

/interfaces/interface/tunnel/ipv4/addresses/address/config/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (rw)

type: uint8

  • range: 0..32

/interfaces/interface/tunnel/ipv4/addresses/address/
state

description:
Operational state data for each IPv4 address configured on the interface

nodetype: container (ro)

/interfaces/interface/tunnel/ipv4/addresses/address/state/
ip

description:
The IPv4 address on the interface.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

/interfaces/interface/tunnel/ipv4/addresses/address/state/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (ro)

type: uint8

  • range: 0..32

/interfaces/interface/tunnel/ipv4/addresses/address/state/
origin

description:
The origin of this address, e.g., statically configured, assigned by DHCP, etc..

nodetype: leaf (ro)

type: ip-address-origin

/interfaces/interface/tunnel/ipv4/
proxy-arp

description:
Configuration and operational state parameters relating to proxy ARP. This functionality allows a system to respond to ARP requests that are not explicitly destined to the local system.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/proxy-arp/
config

description:
Configuration parameters for proxy ARP

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/proxy-arp/config/
mode

description:
When set to a value other than DISABLE, the local system should respond to ARP requests that are for target addresses other than those that are configured on the local subinterface using its own MAC address as the target hardware address. If the REMOTE_ONLY value is specified, replies are only sent when the target address falls outside the locally configured subnets on the interface, whereas with the ALL value, all requests, regardless of their target address are replied to.

nodetype: leaf (rw)

type: enumeration

  • DISABLE
    The system should not respond to ARP requests that do not specify an IP address configured on the local subinterface as the target address.
  • REMOTE_ONLY
    The system responds to ARP requests only when the sender and target IP addresses are in different subnets.
  • ALL
    The system responds to ARP requests where the sender and target IP addresses are in different subnets, as well as those where they are in the same subnet.

default: DISABLE

/interfaces/interface/tunnel/ipv4/proxy-arp/
state

description:
Operational state parameters for proxy ARP

nodetype: container (ro)

/interfaces/interface/tunnel/ipv4/proxy-arp/state/
mode

description:
When set to a value other than DISABLE, the local system should respond to ARP requests that are for target addresses other than those that are configured on the local subinterface using its own MAC address as the target hardware address. If the REMOTE_ONLY value is specified, replies are only sent when the target address falls outside the locally configured subnets on the interface, whereas with the ALL value, all requests, regardless of their target address are replied to.

nodetype: leaf (ro)

type: enumeration

  • DISABLE
    The system should not respond to ARP requests that do not specify an IP address configured on the local subinterface as the target address.
  • REMOTE_ONLY
    The system responds to ARP requests only when the sender and target IP addresses are in different subnets.
  • ALL
    The system responds to ARP requests where the sender and target IP addresses are in different subnets, as well as those where they are in the same subnet.

default: DISABLE

/interfaces/interface/tunnel/ipv4/
neighbors

description:
Enclosing container for neighbor list

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/neighbors/
neighbor

description:
A list of mappings from IPv4 addresses to link-layer addresses. Entries in this list are used as static entries in the ARP Cache.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/tunnel/ipv4/neighbors/neighbor/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/tunnel/ipv4/neighbors/neighbor/
config

description:
Configuration data for each configured IPv4 address on the interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/neighbors/neighbor/config/
ip

description:
The IPv4 address of the neighbor node.

nodetype: leaf (rw)

type: oc-inet:ipv4-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (rw)

type: oc-yang:phys-address

/interfaces/interface/tunnel/ipv4/neighbors/neighbor/
state

description:
Operational state data for each IPv4 address configured on the interface

nodetype: container (ro)

/interfaces/interface/tunnel/ipv4/neighbors/neighbor/state/
ip

description:
The IPv4 address of the neighbor node.

nodetype: leaf (ro)

type: oc-inet:ipv4-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (ro)

type: oc-yang:phys-address

/interfaces/interface/tunnel/ipv4/neighbors/neighbor/state/
origin

description:
The origin of this neighbor entry, static or dynamic.

nodetype: leaf (ro)

type: neighbor-origin

/interfaces/interface/tunnel/ipv4/
unnumbered

description:
Top-level container for setting unnumbered interfaces. Includes reference the interface that provides the address information

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/unnumbered/
config

description:
Configuration data for unnumbered interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/unnumbered/config/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv4/unnumbered/
state

description:
Operational state data for unnumbered interfaces

nodetype: container (ro)

/interfaces/interface/tunnel/ipv4/unnumbered/state/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv4/unnumbered/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/unnumbered/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/unnumbered/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/tunnel/ipv4/unnumbered/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/tunnel/ipv4/unnumbered/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/interfaces/interface/tunnel/ipv4/unnumbered/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/tunnel/ipv4/unnumbered/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/tunnel/ipv4/
config

description:
Top-level IPv4 configuration data for the interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv4/config/
enabled

description:
Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/tunnel/ipv4/config/
mtu

description:
The size, in octets, of the largest IPv4 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (rw)

type: uint16

  • range: 68..max

units: octets

/interfaces/interface/tunnel/ipv4/config/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv4/
state

description:
Top level IPv4 operational state data

nodetype: container (ro)

/interfaces/interface/tunnel/ipv4/state/
enabled

description:
Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/tunnel/ipv4/state/
mtu

description:
The size, in octets, of the largest IPv4 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (ro)

type: uint16

  • range: 68..max

units: octets

/interfaces/interface/tunnel/ipv4/state/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv4/state/
counters

description:
Packet and byte counters for IP transmission and reception for the address family.

nodetype: container (ro)

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

description:
The total number of IP packets received for the specified address family, including those received in error

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets received in input IP packets for the specified address family, including those received in error.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
in-error-pkts

description:
Number of IP packets discarded due to errors for the specified address family, including errors in the IP header, no route found to the IP destination, invalid address, unknown protocol, etc.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
in-forwarded-pkts

description:
The number of input packets for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
in-forwarded-octets

description:
The number of octets received in input IP packets for the specified address family for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
in-discarded-pkts

description:
The number of input IP packets for the specified address family, for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets in IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
out-error-pkts

description:
Number of IP packets for the specified address family locally generated and discarded due to errors, including no route found to the IP destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
out-forwarded-pkts

description:
The number of packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
out-forwarded-octets

description:
The number of octets in packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv4/state/counters/
out-discarded-pkts

description:
The number of output IP packets for the specified address family for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/
ipv6

description:
Parameters for the IPv6 address family.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/
addresses

description:
Enclosing container for address list

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/addresses/
address

description:
The list of configured IPv6 addresses on the interface.

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/tunnel/ipv6/addresses/address/
ip

description:
References the configured IP address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/tunnel/ipv6/addresses/address/
config

description:
Configuration data for each IPv6 address on the interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/addresses/address/config/
ip

description:
The IPv6 address on the interface.

nodetype: leaf (rw)

type: oc-inet:ipv6-address

/interfaces/interface/tunnel/ipv6/addresses/address/config/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (rw)

type: uint8

  • range: 0..128

/interfaces/interface/tunnel/ipv6/addresses/address/
state

description:
State data for each IPv6 address on the interface

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/addresses/address/state/
ip

description:
The IPv6 address on the interface.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

/interfaces/interface/tunnel/ipv6/addresses/address/state/
prefix-length

description:
The length of the subnet prefix.

nodetype: leaf (ro)

type: uint8

  • range: 0..128

/interfaces/interface/tunnel/ipv6/addresses/address/state/
origin

description:
The origin of this address, e.g., static, dhcp, etc.

nodetype: leaf (ro)

type: ip-address-origin

/interfaces/interface/tunnel/ipv6/addresses/address/state/
status

description:
The status of an address. Most of the states correspond to states from the IPv6 Stateless Address Autoconfiguration protocol.

nodetype: leaf (ro)

type: enumeration

  • PREFERRED
    This is a valid address that can appear as the destination or source address of a packet.
  • DEPRECATED
    This is a valid but deprecated address that should no longer be used as a source address in new communications, but packets addressed to such an address are processed as expected.
  • INVALID
    This isn't a valid address, and it shouldn't appear as the destination or source address of a packet.
  • INACCESSIBLE
    The address is not accessible because the interface to which this address is assigned is not operational.
  • UNKNOWN
    The status cannot be determined for some reason.
  • TENTATIVE
    The uniqueness of the address on the link is being verified. Addresses in this state should not be used for general communication and should only be used to determine the uniqueness of the address.
  • DUPLICATE
    The address has been determined to be non-unique on the link and so must not be used.
  • OPTIMISTIC
    The address is available for use, subject to restrictions, while its uniqueness on a link is being verified.

/interfaces/interface/tunnel/ipv6/
router-advertisement

description:
Configuration and operational state parameters relating to router advertisements.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/router-advertisement/
config

description:
Configuration parameters relating to router advertisements for IPv6.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/router-advertisement/config/
interval

description:
The interval between periodic router advertisement neighbor discovery messages sent on this interface expressed in seconds.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/config/
lifetime

description:
The lifetime advertised in the router advertisement neighbor discovery message on this interface.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/config/
suppress

description:
When set to true, router advertisement neighbor discovery messages are not transmitted on this interface.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/router-advertisement/config/
managed

description:
When set to true, the managed address configuration (M) flag is set in the advertised router advertisement. The M flag indicates that there are addresses available via DHCPv6.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/router-advertisement/config/
other-config

description:
When set to true, the other configuration (O) flag is set in the advertised router advertisement. The O flag indicates that there is other configuration available via DHCPv6 (e.g., DNS servers).

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/router-advertisement/
state

description:
Operational state parameters relating to router advertisements for IPv6.

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/router-advertisement/state/
interval

description:
The interval between periodic router advertisement neighbor discovery messages sent on this interface expressed in seconds.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/state/
lifetime

description:
The lifetime advertised in the router advertisement neighbor discovery message on this interface.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/state/
suppress

description:
When set to true, router advertisement neighbor discovery messages are not transmitted on this interface.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/router-advertisement/state/
managed

description:
When set to true, the managed address configuration (M) flag is set in the advertised router advertisement. The M flag indicates that there are addresses available via DHCPv6.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/router-advertisement/state/
other-config

description:
When set to true, the other configuration (O) flag is set in the advertised router advertisement. The O flag indicates that there is other configuration available via DHCPv6 (e.g., DNS servers).

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/router-advertisement/
prefixes

description:
Container for a list of prefixes that are included in the router advertisement message.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/
prefix

description:
List of prefixes that are to be included in the IPv6 router-advertisement messages for the interface. The list is keyed by the IPv6 prefix in CIDR representation. Prefixes that are listed are those that are to be advertised in router advertisement messages. Where there are IPv6 global addresses configured on an interface and the prefix is not listed in the prefix list, it MUST NOT be advertised in the router advertisement message.

nodetype: list (rw)

list keys: [prefix]

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/
prefix

description:
Reference to the IPv6 prefix key for the prefix list.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/prefix

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/
config

description:
Configuration parameters corresponding to an IPv6 prefix within the router advertisement.

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/config/
prefix

description:
IPv6 prefix to be advertised within the router advertisement message.

nodetype: leaf (rw)

type: oc-inet:ipv6-prefix

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/config/
valid-lifetime

description:
The length of time that the prefix is valid relative to the time the packet was sent.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/config/
preferred-lifetime

description:
The length of time that the address within the prefix remains in the preferred state, i.e., unrestricted use is allowed by upper-layer protocols. See RFC4862 for a complete definition of preferred behaviours.

nodetype: leaf (rw)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/config/
disable-advertisement

description:
When set to true, the prefix is not advertised within router advertisement messages that are sent as a result of router soliciation messages.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/config/
disable-autoconfiguration

description:
When set to true, the prefix is marked as not to be used for stateless address configuration. This is achieved by setting the autonomous address configuration bit for the prefix.

nodetype: leaf (rw)

type: boolean

description:
When set to true, the prefix is marked as being on link by setting the L-bit for the prefix within a router advertisement.

nodetype: leaf (rw)

type: boolean

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/
state

description:
Operational state parameters corresponding to an IPv6 prefix within the router advertisement.

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/state/
prefix

description:
IPv6 prefix to be advertised within the router advertisement message.

nodetype: leaf (ro)

type: oc-inet:ipv6-prefix

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/state/
valid-lifetime

description:
The length of time that the prefix is valid relative to the time the packet was sent.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/state/
preferred-lifetime

description:
The length of time that the address within the prefix remains in the preferred state, i.e., unrestricted use is allowed by upper-layer protocols. See RFC4862 for a complete definition of preferred behaviours.

nodetype: leaf (ro)

type: uint32

units: seconds

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/state/
disable-advertisement

description:
When set to true, the prefix is not advertised within router advertisement messages that are sent as a result of router soliciation messages.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/tunnel/ipv6/router-advertisement/prefixes/prefix/state/
disable-autoconfiguration

description:
When set to true, the prefix is marked as not to be used for stateless address configuration. This is achieved by setting the autonomous address configuration bit for the prefix.

nodetype: leaf (ro)

type: boolean

description:
When set to true, the prefix is marked as being on link by setting the L-bit for the prefix within a router advertisement.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/tunnel/ipv6/
neighbors

description:
Enclosing container for list of IPv6 neighbors

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/neighbors/
neighbor

description:
List of IPv6 neighbors

nodetype: list (rw)

list keys: [ip]

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/
ip

description:
References the configured IP neighbor address

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/ip

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/
config

description:
Configuration data for each IPv6 address on the interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/config/
ip

description:
The IPv6 address of the neighbor node.

nodetype: leaf (rw)

type: oc-inet:ipv6-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (rw)

type: oc-yang:phys-address

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/
state

description:
State data for each IPv6 address on the interface

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/state/
ip

description:
The IPv6 address of the neighbor node.

nodetype: leaf (ro)

type: oc-inet:ipv6-address

description:
The link-layer address of the neighbor node.

nodetype: leaf (ro)

type: oc-yang:phys-address

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/state/
origin

description:
The origin of this neighbor entry.

nodetype: leaf (ro)

type: neighbor-origin

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/state/
is-router

description:
Indicates that the neighbor node acts as a router.

nodetype: leaf (ro)

type: boolean

/interfaces/interface/tunnel/ipv6/neighbors/neighbor/state/
neighbor-state

description:
The Neighbor Unreachability Detection state of this entry.

nodetype: leaf (ro)

type: enumeration

  • INCOMPLETE
    Address resolution is in progress, and the link-layer address of the neighbor has not yet been determined.
  • REACHABLE
    Roughly speaking, the neighbor is known to have been reachable recently (within tens of seconds ago).
  • STALE
    The neighbor is no longer known to be reachable, but until traffic is sent to the neighbor no attempt should be made to verify its reachability.
  • DELAY
    The neighbor is no longer known to be reachable, and traffic has recently been sent to the neighbor. Rather than probe the neighbor immediately, however, delay sending probes for a short while in order to give upper-layer protocols a chance to provide reachability confirmation.
  • PROBE
    The neighbor is no longer known to be reachable, and unicast Neighbor Solicitation probes are being sent to verify reachability.

/interfaces/interface/tunnel/ipv6/
unnumbered

description:
Top-level container for setting unnumbered interfaces. Includes reference the interface that provides the address information

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/unnumbered/
config

description:
Configuration data for unnumbered interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/unnumbered/config/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/unnumbered/
state

description:
Operational state data for unnumbered interfaces

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/unnumbered/state/
enabled

description:
Indicates that the subinterface is unnumbered. By default the subinterface is numbered, i.e., expected to have an IP address configuration.

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/unnumbered/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/unnumbered/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/unnumbered/interface-ref/config/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/tunnel/ipv6/unnumbered/interface-ref/config/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/tunnel/ipv6/unnumbered/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/unnumbered/interface-ref/state/
interface

description:
Reference to a base interface. If a reference to a subinterface is required, this leaf must be specified to indicate the base interface.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/name

/interfaces/interface/tunnel/ipv6/unnumbered/interface-ref/state/
subinterface

description:
Reference to a subinterface -- this requires the base interface to be specified using the interface leaf in this container. If only a reference to a base interface is requuired, this leaf should not be set.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/name=current()/../interface]/subinterfaces/subinterface/index

/interfaces/interface/tunnel/ipv6/
config

description:
Top-level config data for the IPv6 interface

nodetype: container (rw)

/interfaces/interface/tunnel/ipv6/config/
enabled

description:
Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

nodetype: leaf (rw)

type: boolean

default: true

/interfaces/interface/tunnel/ipv6/config/
mtu

description:
The size, in octets, of the largest IPv6 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (rw)

type: uint32

  • range: 1280..max

units: octets

/interfaces/interface/tunnel/ipv6/config/
dup-addr-detect-transmits

description:
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions.

nodetype: leaf (rw)

type: uint32

default: 1

/interfaces/interface/tunnel/ipv6/config/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (rw)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/
state

description:
Top-level operational state data for the IPv6 interface

nodetype: container (ro)

/interfaces/interface/tunnel/ipv6/state/
enabled

description:
Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

nodetype: leaf (ro)

type: boolean

default: true

/interfaces/interface/tunnel/ipv6/state/
mtu

description:
The size, in octets, of the largest IPv6 packet that the interface will send and receive. The server may restrict the allowed values for this leaf, depending on the interface's type. If this leaf is not configured, the operationally used MTU depends on the interface's type.

nodetype: leaf (ro)

type: uint32

  • range: 1280..max

units: octets

/interfaces/interface/tunnel/ipv6/state/
dup-addr-detect-transmits

description:
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address. A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions.

nodetype: leaf (ro)

type: uint32

default: 1

/interfaces/interface/tunnel/ipv6/state/
dhcp-client

description:
Enables a DHCP client on the interface in order to request an address

nodetype: leaf (ro)

type: boolean

default: false

/interfaces/interface/tunnel/ipv6/state/
counters

description:
Packet and byte counters for IP transmission and reception for the address family.

nodetype: container (ro)

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

description:
The total number of IP packets received for the specified address family, including those received in error

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets received in input IP packets for the specified address family, including those received in error.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
in-error-pkts

description:
Number of IP packets discarded due to errors for the specified address family, including errors in the IP header, no route found to the IP destination, invalid address, unknown protocol, etc.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
in-forwarded-pkts

description:
The number of input packets for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
in-forwarded-octets

description:
The number of octets received in input IP packets for the specified address family for which the device was not their final IP destination and for which the device attempted to find a route to forward them to that final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
in-discarded-pkts

description:
The number of input IP packets for the specified address family, for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

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

description:
The total number of octets in IP packets for the specified address family that the device supplied to the lower layers for transmission. This includes packets generated locally and those forwarded by the device.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
out-error-pkts

description:
Number of IP packets for the specified address family locally generated and discarded due to errors, including no route found to the IP destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
out-forwarded-pkts

description:
The number of packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
out-forwarded-octets

description:
The number of octets in packets for which this entity was not their final IP destination and for which it was successful in finding a path to their final destination.

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/tunnel/ipv6/state/counters/
out-discarded-pkts

description:
The number of output IP packets for the specified address family for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space).

nodetype: leaf (ro)

type: oc-yang:counter64

/interfaces/interface/
sonet

description:
Data related to SONET/SDH interfaces

nodetype: container (rw)

openconfig-if-ip

openconfig-version: 3.1.0

Description

This model defines data for managing configuration and operational state on IP (IPv4 and IPv6) interfaces.

This model reuses data items defined in the IETF YANG model for interfaces described by RFC 7277 with an alternate structure (particularly for operational state data) and with additional configuration items.

Portions of this code were derived from IETF RFC 7277. 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

openconfig-inet-types
openconfig-interfaces
openconfig-vlan
openconfig-yang-types
openconfig-extensions

Defined types

ip-address-origin

description:
The origin of an address.

type: enumeration

  • OTHER
    None of the following.
  • STATIC
    Indicates that the address has been statically configured - for example, using NETCONF or a Command Line Interface.
  • DHCP
    Indicates an address that has been assigned to this system by a DHCP server.
  • LINK_LAYER
    Indicates an address created by IPv6 stateless autoconfiguration that embeds a link-layer address in its interface identifier.
  • RANDOM
    Indicates an address chosen by the system at random, e.g., an IPv4 address within 169.254/16, an RFC 4941 temporary address, or an RFC 7217 semantically opaque address.

neighbor-origin

description:
The origin of a neighbor entry.

type: enumeration

  • OTHER
    None of the following.
  • STATIC
    Indicates that the mapping has been statically configured - for example, using NETCONF or a Command Line Interface.
  • DYNAMIC
    Indicates that the mapping has been dynamically resolved using, e.g., IPv4 ARP or the IPv6 Neighbor Discovery protocol.

Data elements

openconfig-if-aggregate

openconfig-version: 2.4.4

Description

Model for managing aggregated (aka bundle, LAG) interfaces.

Imports

openconfig-interfaces
openconfig-if-ethernet
iana-if-type
openconfig-extensions

Defined types

aggregation-type

description:
Type to define the lag-type, i.e., how the LAG is defined and managed

type: enumeration

  • LACP
    LAG managed by LACP
  • STATIC
    Statically configured bundle / LAG

Data elements

openconfig-if-ethernet

openconfig-version: 2.12.2

Description

Model for managing Ethernet interfaces -- augments the OpenConfig model for interface configuration and state.

Imports

openconfig-interfaces
iana-if-type
openconfig-yang-types
openconfig-extensions

Identities

base: INTERFACE_FEC

description:
Base type to specify FEC modes that can be configured on the interface. These are FEC modes defined for applying to logical interfaces and their underlying electrical channels.

FEC_FC

description:
Firecode is used for channels with NRZ modulation and speeds less than 100G. This FEC is designed to comply with the IEEE 802.3, Clause 74.

base identity: INTERFACE_FEC

FEC_RS528

description:
RS528 is used for channels with NRZ modulation. This FEC is designed to comply with IEEE 802.3, Clause 91.

base identity: INTERFACE_FEC

FEC_RS544

description:
RS544 is used for channels with PAM4 modulation.

base identity: INTERFACE_FEC

FEC_RS544_2X_INTERLEAVE

description:
RS544-2x-interleave is used for channels with PAM4 modulation.

base identity: INTERFACE_FEC

FEC_DISABLED

description:
FEC is administratively disabled.

base identity: INTERFACE_FEC

base: ETHERNET_SPEED

description:
base type to specify available Ethernet link speeds

SPEED_10MB

description:
10 Mbps Ethernet

base identity: ETHERNET_SPEED

SPEED_100MB

description:
100 Mbps Ethernet

base identity: ETHERNET_SPEED

SPEED_1GB

description:
1 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_2500MB

description:
2.5 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_5GB

description:
5 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_10GB

description:
10 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_25GB

description:
25 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_40GB

description:
40 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_50GB

description:
50 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_100GB

description:
100 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_200GB

description:
200 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_400GB

description:
400 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_600GB

description:
600 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_800GB

description:
800 Gbps Ethernet

base identity: ETHERNET_SPEED

SPEED_UNKNOWN

description:
Interface speed is unknown. Systems may report speed UNKNOWN when an interface is down or unpopuplated (e.g., pluggable not present).

base identity: ETHERNET_SPEED

Data elements

openconfig-if-ethernet-ext

openconfig-version: 0.1.1

Description

This module adds extensions to the base ethernet configuration and operational state model to support additional use cases.

Imports

openconfig-interfaces
openconfig-if-ethernet
openconfig-yang-types
openconfig-extensions

Data elements

openconfig-if-poe

openconfig-version: 0.1.1

Description

This module defines configuration and state data for Power over Ethernet (PoE) based on the IEEE 802.3af standard.

Imports

openconfig-if-ethernet
openconfig-interfaces
openconfig-extensions

Data elements

openconfig-if-ip-ext

openconfig-version: 2.3.1

Description

This module adds extensions to the base IP configuration and operational state model to support additional use cases.

Imports

openconfig-interfaces
openconfig-if-ip
openconfig-extensions

Data elements

openconfig-if-8021x

openconfig-version: 0.0.1

Description

Model for managing 8021X. Augments the OpenConfig models for wired interfaces and wireless SSIDs for configuration and state.

Imports

openconfig-yang-types
openconfig-extensions
openconfig-interfaces
openconfig-if-ethernet
openconfig-vlan
openconfig-vlan-types

Data elements

openconfig-vlan

openconfig-version: 3.2.1

Description

This module defines configuration and state variables for VLANs, in addition to VLAN parameters associated with interfaces

Imports

openconfig-vlan-types
openconfig-interfaces
openconfig-if-ethernet
openconfig-if-aggregate
iana-if-type
openconfig-extensions

Data elements

openconfig-if-tunnel

openconfig-version: 0.1.1

Description

This model adds extensions to the OpenConfig interfaces model to configure tunnel interfaces on a network device.

Imports

openconfig-interfaces
openconfig-extensions
openconfig-inet-types
openconfig-if-ip

Data elements

openconfig-platform-port

openconfig-version: 0.4.2

Description

This module defines data related to PORT components in the openconfig-platform model

Imports

openconfig-platform
openconfig-interfaces
openconfig-if-ethernet
openconfig-extensions

Data elements

openconfig-platform-transceiver

openconfig-version: 0.10.0

Description

This module defines configuration and operational state data for transceivers (i.e., pluggable optics). The module should be used in conjunction with the platform model where other physical entity data are represented.

In the platform model, a component of type=TRANSCEIVER is expected to be a subcomponent of a PORT component. This module defines a concrete schema for the associated data for components with type=TRANSCEIVER.

A transceiver will always contain physical-channel(s), however when a line side optical-channel is present (i.e. ZR+ optics) the physical-channel will reference its optical-channel. In this case, the optical-channels components must be subcomponents of the transceiver. The relationship between the physical-channel and the optical-channel allows for multiple optical-channels to be associated with a transceiver in addition to ensuring certain leaves (i.e. output-power) are not duplicated in multiple components.

If a transceiver contains a digital signal processor (DSP), such as with ZR+ optics, the modeling will utilize hierarchical components as follows: PORT --> TRANSCEIVER --> OPTICAL_CHANNEL(s) The signal will then traverse through a series of terminal-device/logical-channels as required. The first logical-channel connected to the OPTICAL_CHANNEL will utilize the assignment/optical-channel leaf to create the relationship. At the conclusion of the series of logical-channels, the logical-channel will be associated to its host / client side based on: * If the TRANSCEIVER is directly within a router or switch, then it will use the logical-channel ingress leaf to specify the interface it is associated with. * If the TRANSCEIVER is within a dedicated terminal (Layer 1) device, then it will use the logical-channel ingress leaf to specify a physical-channel within a TRANSCEIVER component (i.e. gray optic) that it is associated with.

Imports

ietf-yang-types
openconfig-platform
openconfig-platform-types
openconfig-platform-port
openconfig-interfaces
openconfig-transport-types
openconfig-types
openconfig-extensions
openconfig-yang-types
openconfig-alarm-types

Data elements

openconfig-if-sdn-ext

openconfig-version: 0.1.0

Description

This module provides extensions to the OpenConfig interfaces module for network elements that support external 'SDN' control of their interfaces.

Imports

openconfig-extensions
openconfig-interfaces

Data elements

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-transport-line-common

openconfig-version: 0.6.0

Description

This module defines common data elements for OpenConfig data models for optical transport line system elements, such as amplifiers and ROADMs (wavelength routers).

Imports

iana-if-type
openconfig-extensions
openconfig-interfaces
openconfig-platform
openconfig-types
openconfig-transport-types
openconfig-platform-transceiver

Data elements

openconfig-ate-intf

openconfig-version: 0.1.0

Description

This module defines augments to the OpenConfig tree specifically for automated test equipment (ATE) devices. These parameters are not widely supported by non-ATE devices.

Imports

openconfig-extensions
openconfig-types
openconfig-interfaces

Data elements

openconfig-vlan-types

openconfig-version: 3.2.0

Description

This module defines configuration and state variables for VLANs, in addition to VLAN parameters associated with interfaces

Imports

openconfig-extensions

Defined types

vlan-id

description:
Type definition representing a single-tagged VLAN

type: uint16

  • range: 1..4094

vlan-range

description:
Type definition representing a range of single-tagged VLANs. A range is specified as x..y where x and y are valid VLAN IDs (1 <= vlan-id <= 4094). The range is assumed to be inclusive, such that any VLAN-ID matching x <= VLAN-ID <= y falls within the range.

type: string

  • pattern:
    (409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\.\.(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])

qinq-id

description:
Type definition representing a single double-tagged/QinQ VLAN identifier. The format of a QinQ VLAN-ID is x.y where X is the 'outer' VLAN identifier, and y is the 'inner' VLAN identifier. Both x and y must be valid VLAN IDs (1 <= vlan-id <= 4094) with the exception that y may be equal to a wildcard (*). In cases where y is set to the wildcard, this represents all inner VLAN identifiers where the outer VLAN identifier is equal to x.

type: string

  • pattern:
    (409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\.((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])|\*)

qinq-id-range

description:
A type definition representing a range of double-tagged/QinQ VLAN identifiers. The format of a QinQ VLAN-ID range can be specified in two formats. Where the range is outer VLAN IDs the range is specified as x..y.z. In this case outer VLAN identifiers meeting the criteria x <= outer-vlan-id <= y are accepted if and only if the inner VLAN-ID is equal to y - or any inner-tag if the wildcard is specified. Alternatively the ange can be specified as x.y..z. In this case only VLANs with an outer-vlan-id qual to x are accepted (x may again be the wildcard). Inner VLANs are accepted if they meet the inequality y <= inner-vlan-id <= z.

type: union

    type: string

    • pattern:
      (409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\.\.(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\.((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])|\*)

    type: string

    • pattern:
      (\*|(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))\.(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\.\.(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])

vlan-mode-type

description:
VLAN interface mode (trunk or access)

type: enumeration

  • ACCESS
    Access mode VLAN interface (No 802.1q header)
  • TRUNK
    Trunk mode VLAN interface

vlan-ref

description:
Reference to a VLAN by name or id

type: union

    type: vlan-id

    type: string

vlan-stack-action

description:
Operations that can be performed on a VLAN stack.

type: enumeration

  • PUSH
    Push a VLAN onto the VLAN stack.
  • POP
    Pop a VLAN from the VLAN stack.
  • SWAP
    Swap the VLAN at the top of the VLAN stack.

Identities

base: TPID_TYPES

description:
Base identity for TPID values that can be matched or that override the VLAN ethertype value

TPID_0X8100

description:
Default TPID value for 802.1q single-tagged VLANs.

base identity: TPID_TYPES

TPID_0X88A8

description:
TPID value for 802.1ad provider bridging, QinQ or stacked VLANs.

base identity: TPID_TYPES

TPID_0X9100

description:
Alternate TPID value.

base identity: TPID_TYPES

TPID_0X9200

description:
Alternate TPID value.

base identity: TPID_TYPES

TPID_ANY

description:
A wildcard that matches any of the generally used TPID values for singly- or multiply-tagged VLANs. Equivalent to matching any of TPID_0X8100, TPID_0X88A8, TPID_0X9100 and TPID_0x9200. This value is only applicable where the TPID of a packet is being matched.

base identity: TPID_TYPES

Data elements