openconfig-ethernet-segments

openconfig-version: 0.2.0

Description

This module contains definitions of ethernet segements. The ethernet segments are used in EVPN services are defined for the whole device

Imports

openconfig-extensions
openconfig-interfaces
openconfig-yang-types
openconfig-evpn-types

Data elements

/
ethernet-segments

description:
Top-level container for ethernet segments. An Ethernet Segment is referenced by a name and an ESI

nodetype: container (rw)

/ethernet-segments/
ethernet-segment

description:
List of Ethernet Segments.

nodetype: list (rw)

list keys: [name]

/ethernet-segments/ethernet-segment/
name

description:
Ethernet Segment Name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/ethernet-segments/ethernet-segment/
config

description:
Configuration data for the Ethernet Segments.

nodetype: container (rw)

/ethernet-segments/ethernet-segment/config/
name

description:
Ethernet Segment name

nodetype: leaf (rw)

type: string

/ethernet-segments/ethernet-segment/config/
esi-type

description:
ESI Type is a 1-octet field (most significant octet) that specifies the format of the remaining 9 octets (ESI Value).

nodetype: leaf (rw)

type: oc-evpn-types:esi-type

default: TYPE_0_OPERATOR_CONFIGURED

/ethernet-segments/ethernet-segment/config/
esi

description:
Ethernet Segment Identifier (ESI) value. For ESI Type 0: The esi leaf value is directly configured by the operator. For ESI Type 1: The AUTO enum must be used. For ESI Type 2: The AUTO enum must be used. For ESI Type 3: The directly configured or AUTO enum must be used. For ESI Type 4: The directly configured or AUTO enum must be used. For ESI Type 5: The directly configured or AUTO enum must be used.

nodetype: leaf (rw)

type: union

    type: oc-evpn-types:esi

    type: enumeration

    • AUTO
      This ESI type indicates an auto-generated ESI value.

/ethernet-segments/ethernet-segment/config/
redundancy-mode

description:
Multihoming options for load balancing of traffic in the Ethernet Segment.

nodetype: leaf (rw)

type: identityref

  • base: oc-evpn-types:EVPN_REDUNDANCY_MODE

/ethernet-segments/ethernet-segment/config/
es-import-route-target

description:
Received ES routes with an ES-Import extended community set to this value are imported into this ethernet segment. When configured by a user, the es-import-route-target will be used, otherwise the system automatically derives the value used by following the procedures in RFC 7432 Section 7.6.

nodetype: leaf (rw)

type: oc-yang-types:mac-address

/ethernet-segments/ethernet-segment/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

/ethernet-segments/ethernet-segment/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

/ethernet-segments/ethernet-segment/
state

description:
Operational state data for the Ethernet Segments.

nodetype: container (ro)

/ethernet-segments/ethernet-segment/state/
name

description:
Ethernet Segment name

nodetype: leaf (ro)

type: string

/ethernet-segments/ethernet-segment/state/
esi-type

description:
ESI Type is a 1-octet field (most significant octet) that specifies the format of the remaining 9 octets (ESI Value).

nodetype: leaf (ro)

type: oc-evpn-types:esi-type

default: TYPE_0_OPERATOR_CONFIGURED

/ethernet-segments/ethernet-segment/state/
esi

description:
Ethernet Segment Identifier (ESI) value. For ESI Type 0: The esi leaf value is directly configured by the operator. For ESI Type 1: The AUTO enum must be used. For ESI Type 2: The AUTO enum must be used. For ESI Type 3: The directly configured or AUTO enum must be used. For ESI Type 4: The directly configured or AUTO enum must be used. For ESI Type 5: The directly configured or AUTO enum must be used.

nodetype: leaf (ro)

type: union

    type: oc-evpn-types:esi

    type: enumeration

    • AUTO
      This ESI type indicates an auto-generated ESI value.

/ethernet-segments/ethernet-segment/state/
redundancy-mode

description:
Multihoming options for load balancing of traffic in the Ethernet Segment.

nodetype: leaf (ro)

type: identityref

  • base: oc-evpn-types:EVPN_REDUNDANCY_MODE

/ethernet-segments/ethernet-segment/state/
es-import-route-target

description:
Received ES routes with an ES-Import extended community set to this value are imported into this ethernet segment. When configured by a user, the es-import-route-target will be used, otherwise the system automatically derives the value used by following the procedures in RFC 7432 Section 7.6.

nodetype: leaf (ro)

type: oc-yang-types:mac-address

/ethernet-segments/ethernet-segment/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

/ethernet-segments/ethernet-segment/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

/ethernet-segments/ethernet-segment/
df-election

description:
Top container for the configuration and state parameters for the Designated forwarding Election

nodetype: container (rw)

/ethernet-segments/ethernet-segment/df-election/
config

description:
Configuration parameters for the Designated forwarding Election

nodetype: container (rw)

/ethernet-segments/ethernet-segment/df-election/config/
df-election-method

description:
Select the Designated Forwarder Election (DF) election method

nodetype: leaf (rw)

type: enumeration

  • DEFAULT
    The default Designated Forwarder Election election method
  • HIGHEST_RANDOM_WEIGHT
    The highest random weight (HRW) method
  • PREFERENCE
    The preference based method

/ethernet-segments/ethernet-segment/df-election/config/
preference

description:
Defines a 2-octet value that indicates the PE preference to become the DF in the Ethernet-Segment.

nodetype: leaf (rw)

type: uint16

/ethernet-segments/ethernet-segment/df-election/config/
revertive

description:
The 'preempt' or 'revertive' behavior. This option will allow a non-revertive behavior in the DF election.

nodetype: leaf (rw)

type: boolean

default: true

/ethernet-segments/ethernet-segment/df-election/config/
election-wait-time

description:
Designated Forwarder Election wait-time. When the DF timer expires, the PE device selects the DF based on the highest preference value

nodetype: leaf (rw)

type: uint32

/ethernet-segments/ethernet-segment/df-election/
state

description:
Configuration parameters for the Designated forwarding Election

nodetype: container (ro)

/ethernet-segments/ethernet-segment/df-election/state/
df-election-method

description:
Select the Designated Forwarder Election (DF) election method

nodetype: leaf (ro)

type: enumeration

  • DEFAULT
    The default Designated Forwarder Election election method
  • HIGHEST_RANDOM_WEIGHT
    The highest random weight (HRW) method
  • PREFERENCE
    The preference based method

/ethernet-segments/ethernet-segment/df-election/state/
preference

description:
Defines a 2-octet value that indicates the PE preference to become the DF in the Ethernet-Segment.

nodetype: leaf (ro)

type: uint16

/ethernet-segments/ethernet-segment/df-election/state/
revertive

description:
The 'preempt' or 'revertive' behavior. This option will allow a non-revertive behavior in the DF election.

nodetype: leaf (ro)

type: boolean

default: true

/ethernet-segments/ethernet-segment/df-election/state/
election-wait-time

description:
Designated Forwarder Election wait-time. When the DF timer expires, the PE device selects the DF based on the highest preference value

nodetype: leaf (ro)

type: uint32