openconfig-lacp

openconfig-version: 1.2.0

Description

This module describes configuration and operational state data for Link Aggregation Control Protocol (LACP) for managing aggregate interfaces. It works in conjunction with the OpenConfig interfaces and aggregate interfaces models.

Imports

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

Defined types

lacp-timeout-type

description:
Type of timeout used, short or long, by LACP participants

type: enumeration

  • SHORT
    Participant wishes to use short timeouts, i.e., expects frequent transmissions to aggressively detect status changes. Short timeout is 3 seconds.
  • LONG
    Participant wishes to use long timeouts to detect status of the aggregate, i.e., will expect less frequent transmissions. Long timeout is 90 seconds.

lacp-activity-type

description:
Describes the LACP membership type, active or passive, of the interface in the aggregate

type: enumeration

  • ACTIVE
    Interface is an active member, i.e., will detect and maintain aggregates
  • PASSIVE
    Interface is a passive member, i.e., it participates with an active partner

lacp-synchronization-type

description:
Indicates LACP synchronization state of participant

type: enumeration

  • OUT_SYNC
    Participant is not in sync with the system id and key transmitted
  • IN_SYNC
    Participant is in sync with the system id and key transmitted

lacp-period-type

description:
Defines the period options for the time between sending LACP messages

type: enumeration

  • SLOW
    Send LACP packets every 30 seconds
  • FAST
    Send LACP packets every second

Data elements

/
lacp

description:
Configuration and operational state data for LACP protocol operation on the aggregate interface

nodetype: container (rw)

/lacp/
config

description:
Configuration data for LACP

nodetype: container (rw)

/lacp/config/
system-priority

description:
Sytem priority used by the node on this LAG interface. Lower value is higher priority for determining which node is the controlling system.

nodetype: leaf (rw)

type: uint16

/lacp/
state

description:
Operational state data for LACP

nodetype: container (ro)

/lacp/state/
system-priority

description:
Sytem priority used by the node on this LAG interface. Lower value is higher priority for determining which node is the controlling system.

nodetype: leaf (ro)

type: uint16

/lacp/
interfaces

description:
Enclosing container for the list of LACP-enabled interfaces

nodetype: container (rw)

/lacp/interfaces/
interface

description:
List of aggregate interfaces managed by LACP

nodetype: list (rw)

list keys: [name]

/lacp/interfaces/interface/
name

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/lacp/interfaces/interface/
config

description:
Configuration data for each LACP aggregate interface

nodetype: container (rw)

/lacp/interfaces/interface/config/
name

description:
Reference to the interface on which LACP should be configured. The type of the target interface must be ieee8023adLag

nodetype: leaf (rw)

type: oc-if:base-interface-ref

/lacp/interfaces/interface/config/
interval

description:
Set the period between LACP messages -- uses the lacp-period-type enumeration.

nodetype: leaf (rw)

type: lacp-period-type

default: SLOW

/lacp/interfaces/interface/config/
lacp-mode

description:
ACTIVE is to initiate the transmission of LACP packets. PASSIVE is to wait for peer to initiate the transmission of LACP packets.

nodetype: leaf (rw)

type: lacp-activity-type

default: ACTIVE

/lacp/interfaces/interface/config/
system-id-mac

description:
The MAC address portion of the node's System ID. This is combined with the system priority to construct the 8-octet system-id

nodetype: leaf (rw)

type: oc-yang:mac-address

/lacp/interfaces/interface/config/
system-priority

description:
Sytem priority used by the node on this LAG interface. Lower value is higher priority for determining which node is the controlling system.

nodetype: leaf (rw)

type: uint16

/lacp/interfaces/interface/
state

description:
Operational state data for each LACP aggregate interface

nodetype: container (ro)

/lacp/interfaces/interface/state/
name

description:
Reference to the interface on which LACP should be configured. The type of the target interface must be ieee8023adLag

nodetype: leaf (ro)

type: oc-if:base-interface-ref

/lacp/interfaces/interface/state/
interval

description:
Set the period between LACP messages -- uses the lacp-period-type enumeration.

nodetype: leaf (ro)

type: lacp-period-type

default: SLOW

/lacp/interfaces/interface/state/
lacp-mode

description:
ACTIVE is to initiate the transmission of LACP packets. PASSIVE is to wait for peer to initiate the transmission of LACP packets.

nodetype: leaf (ro)

type: lacp-activity-type

default: ACTIVE

/lacp/interfaces/interface/state/
system-id-mac

description:
The MAC address portion of the node's System ID. This is combined with the system priority to construct the 8-octet system-id

nodetype: leaf (ro)

type: oc-yang:mac-address

/lacp/interfaces/interface/state/
system-priority

description:
Sytem priority used by the node on this LAG interface. Lower value is higher priority for determining which node is the controlling system.

nodetype: leaf (ro)

type: uint16

/lacp/interfaces/interface/
members

description:
Enclosing container for the list of members interfaces of the aggregate. This list is considered operational state only so is labeled config false and has no config container

nodetype: container (ro)

/lacp/interfaces/interface/members/
member

description:
List of member interfaces and their associated status for a LACP-controlled aggregate interface. Member list is not configurable here -- each interface indicates items its participation in the LAG.

nodetype: list (ro)

list keys: [interface]

/lacp/interfaces/interface/members/member/
interface

description:
Reference to aggregate member interface

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/interface

/lacp/interfaces/interface/members/member/
state

description:
Operational state data for aggregate members

nodetype: container (ro)

/lacp/interfaces/interface/members/member/state/
interface

description:
Reference to interface member of the LACP aggregate

nodetype: leaf (ro)

type: oc-if:base-interface-ref

/lacp/interfaces/interface/members/member/state/
activity

description:
Indicates participant is active or passive

nodetype: leaf (ro)

type: lacp-activity-type

/lacp/interfaces/interface/members/member/state/
timeout

description:
The timeout type (short or long) used by the participant

nodetype: leaf (ro)

type: lacp-timeout-type

/lacp/interfaces/interface/members/member/state/
synchronization

description:
Indicates whether the participant is in-sync or out-of-sync

nodetype: leaf (ro)

type: lacp-synchronization-type

/lacp/interfaces/interface/members/member/state/
aggregatable

description:
A true value indicates that the participant will allow the link to be used as part of the aggregate. A false value indicates the link should be used as an individual link

nodetype: leaf (ro)

type: boolean

/lacp/interfaces/interface/members/member/state/
collecting

description:
If true, the participant is collecting incoming frames on the link, otherwise false

nodetype: leaf (ro)

type: boolean

/lacp/interfaces/interface/members/member/state/
distributing

description:
When true, the participant is distributing outgoing frames; when false, distribution is disabled

nodetype: leaf (ro)

type: boolean

/lacp/interfaces/interface/members/member/state/
system-id

description:
MAC address that defines the local system ID for the aggregate interface

nodetype: leaf (ro)

type: oc-yang:mac-address

/lacp/interfaces/interface/members/member/state/
oper-key

description:
Current operational value of the key for the aggregate interface

nodetype: leaf (ro)

type: uint16

/lacp/interfaces/interface/members/member/state/
partner-id

description:
MAC address representing the protocol partner's interface system ID

nodetype: leaf (ro)

type: oc-yang:mac-address

/lacp/interfaces/interface/members/member/state/
partner-key

description:
Operational value of the protocol partner's key

nodetype: leaf (ro)

type: uint16

/lacp/interfaces/interface/members/member/state/
port-num

description:
Port number of the local (actor) aggregation member

nodetype: leaf (ro)

type: uint16

/lacp/interfaces/interface/members/member/state/
partner-port-num

description:
Port number of the partner (remote) port for this member port

nodetype: leaf (ro)

type: uint16

/lacp/interfaces/interface/members/member/state/
last-change

description:
The timestamp indicates the absolute time of the last state change of a LACP timeout. The last state change of the LACP timeout is defined as what is reported as the operating state to the system. The state change is both a timeout event and when the timeout event is no longer active. 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

/lacp/interfaces/interface/members/member/state/
counters

description:
LACP protocol counters

nodetype: container (ro)

/lacp/interfaces/interface/members/member/state/counters/
lacp-in-pkts

description:
Number of LACPDUs received

nodetype: leaf (ro)

type: oc-yang:counter64

/lacp/interfaces/interface/members/member/state/counters/
lacp-out-pkts

description:
Number of LACPDUs transmitted

nodetype: leaf (ro)

type: oc-yang:counter64

/lacp/interfaces/interface/members/member/state/counters/
lacp-rx-errors

description:
Number of LACPDU receive packet errors

nodetype: leaf (ro)

type: oc-yang:counter64

/lacp/interfaces/interface/members/member/state/counters/
lacp-tx-errors

description:
Number of LACPDU transmit packet errors

nodetype: leaf (ro)

type: oc-yang:counter64

/lacp/interfaces/interface/members/member/state/counters/
lacp-unknown-errors

description:
Number of LACPDU unknown packet errors

nodetype: leaf (ro)

type: oc-yang:counter64

/lacp/interfaces/interface/members/member/state/counters/
lacp-errors

description:
Number of LACPDU illegal packet errors

nodetype: leaf (ro)

type: oc-yang:counter64

/lacp/interfaces/interface/members/member/state/counters/
lacp-timeout-transitions

description:
Number of times the LACP state has transitioned with a timeout since the time the device restarted or the interface was brought up, whichever is most recent. The last state change of the LACP timeout is defined as what is reported as the operating state to the system. The state change is both a timeout event and when the timeout event is no longer active.

nodetype: leaf (ro)

type: oc-yang:counter64