openconfig-bfd

openconfig-version: 0.2.4

Description

An OpenConfig model of Bi-Directional Forwarding Detection (BFD) configuration and operational state.

Imports

openconfig-extensions
openconfig-types
openconfig-interfaces
openconfig-inet-types
openconfig-policy-types
ietf-inet-types

Defined types

bfd-session-state

description:
The state of the BFD session according to the system referred to by the context of the leaf.

type: enumeration

  • UP
    The BFD session is perceived to be up by the system.
  • DOWN
    The BFD session is perceived to be down by the system.
  • ADMIN_DOWN
    The BFD session is administratively disabled.
  • INIT
    The BFD session is perceived to be initialising by the system.

bfd-diagnostic-code

description:
Diagnostic codes defined by BFD. These typically indicate the reason for a change of session state.

type: enumeration

  • NO_DIAGNOSTIC
    No diagnostic code was specified, or the session has not changed state.
  • DETECTION_TIMEOUT
    The control detection time expired: no BFD packet was received within the required period.
  • ECHO_FAILED
    The BFD echo function failed - echo packets have not been received for the required period of time.
  • FORWARDING_RESET
    The forwarding plane in the local system was reset - such that the remote system cannot rely on the forwarding state of the device specifying this error code.
  • PATH_DOWN
    Signalling outside of BFD specified that the path underlying this session has failed.
  • CONCATENATED_PATH_DOWN
    When a BFD session runs over a series of path segments, this error code indicates that a subsequent path segment (i.e., one in the transmit path between the source and destination of the session) has failed.
  • ADMIN_DOWN
    The BFD session has been administratively disabled by the peer.
  • REVERSE_CONCATENATED_PATH_DOWN
    In the case that a BFD session is running over a series of path segments, this error code indicates that a path segment on the reverse path (i.e., in the transmit direction from the destination to the source of the session) has failed.

Data elements

/
bfd

description:
Configuration and operational state parameters for BFD.

nodetype: container (rw)

/bfd/
interfaces

description:
Interfaces on which BFD sessions are to be enabled.

nodetype: container (rw)

/bfd/interfaces/
interface

description:
Per-interface configuration and state parameters for BFD.

nodetype: list (rw)

list keys: [id]

/bfd/interfaces/interface/
id

description:
A reference to an identifier for the interface on which BFD is enabled.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/id

/bfd/interfaces/interface/
config

description:
Configuration parameters for BFD on the specified interface.

nodetype: container (rw)

/bfd/interfaces/interface/config/
id

description:
A unique identifier for the interface.

nodetype: leaf (rw)

type: string

/bfd/interfaces/interface/config/
enabled

description:
When this leaf is set to true then the BFD session is enabled on the specified interface - if it is set to false, it is administratively disabled.

nodetype: leaf (rw)

type: boolean

/bfd/interfaces/interface/config/
local-address

description:
The source IP address to be used for BFD sessions over this interface.

nodetype: leaf (rw)

type: oc-inet:ip-address

/bfd/interfaces/interface/config/
desired-minimum-tx-interval

description:
The minimum interval between transmission of BFD control packets that the operator desires. This value is advertised to the peer, however the actual interval used is specified by taking the maximum of desired-minimum-tx-interval and the value of the remote required-minimum-receive interval value. This value is specified as an integer number of microseconds.

nodetype: leaf (rw)

type: uint32

units: microseconds

/bfd/interfaces/interface/config/
required-minimum-receive

description:
The minimum interval between received BFD control packets that this system should support. This value is advertised to the remote peer to indicate the maximum frequency (i.e., minimum inter-packet interval) between BFD control packets that is acceptable to the local system.

nodetype: leaf (rw)

type: uint32

units: microseconds

/bfd/interfaces/interface/config/
detection-multiplier

description:
The number of packets that must be missed to declare this session as down. The detection interval for the BFD session is calculated by multiplying the value of the negotiated transmission interval by this value.

nodetype: leaf (rw)

type: uint8

  • range: 1..max

description:
When this leaf is set to true - BFD will be enabled on each member interface of the aggregated Ethernet bundle.

nodetype: leaf (rw)

type: boolean

default: false

/bfd/interfaces/interface/
state

description:
Operational state parameters for BFD on the specified interface.

nodetype: container (ro)

/bfd/interfaces/interface/state/
id

description:
A unique identifier for the interface.

nodetype: leaf (ro)

type: string

/bfd/interfaces/interface/state/
enabled

description:
When this leaf is set to true then the BFD session is enabled on the specified interface - if it is set to false, it is administratively disabled.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/state/
local-address

description:
The source IP address to be used for BFD sessions over this interface.

nodetype: leaf (ro)

type: oc-inet:ip-address

/bfd/interfaces/interface/state/
desired-minimum-tx-interval

description:
The minimum interval between transmission of BFD control packets that the operator desires. This value is advertised to the peer, however the actual interval used is specified by taking the maximum of desired-minimum-tx-interval and the value of the remote required-minimum-receive interval value. This value is specified as an integer number of microseconds.

nodetype: leaf (ro)

type: uint32

units: microseconds

/bfd/interfaces/interface/state/
required-minimum-receive

description:
The minimum interval between received BFD control packets that this system should support. This value is advertised to the remote peer to indicate the maximum frequency (i.e., minimum inter-packet interval) between BFD control packets that is acceptable to the local system.

nodetype: leaf (ro)

type: uint32

units: microseconds

/bfd/interfaces/interface/state/
detection-multiplier

description:
The number of packets that must be missed to declare this session as down. The detection interval for the BFD session is calculated by multiplying the value of the negotiated transmission interval by this value.

nodetype: leaf (ro)

type: uint8

  • range: 1..max

description:
When this leaf is set to true - BFD will be enabled on each member interface of the aggregated Ethernet bundle.

nodetype: leaf (ro)

type: boolean

default: false

/bfd/interfaces/interface/
interface-ref

description:
Reference to an interface or subinterface

nodetype: container (rw)

/bfd/interfaces/interface/interface-ref/
config

description:
Configured reference to interface / subinterface

nodetype: container (rw)

/bfd/interfaces/interface/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

/bfd/interfaces/interface/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

/bfd/interfaces/interface/interface-ref/
state

description:
Operational state for interface-ref

nodetype: container (ro)

/bfd/interfaces/interface/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

/bfd/interfaces/interface/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

/bfd/interfaces/interface/
micro-bfd-sessions

description:
Parameters relating to micro-BFD sessions associated with the interface.

nodetype: container (rw)

/bfd/interfaces/interface/micro-bfd-sessions/
micro-bfd-session

description:
This list contains configuration and state parameters relating to micro-BFD session.

nodetype: list (rw)

list keys: [member-interface]

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/
member-interface

description:
A reference to the member interface of the link aggregate.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/member-interface

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/
config

description:
Configuration parameters for the micro-BFD session.

nodetype: container (rw)

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/config/
local-address

description:
The local IP address used by the system for the micro-BFD session specified.

nodetype: leaf (rw)

type: oc-inet:ip-address

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/config/
remote-address

description:
The remote IP destination that should be used by the system for the micro-BFD session specified.

nodetype: leaf (rw)

type: oc-inet:ip-address

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/config/
member-interface

description:
Reference to a member link of the aggregate interface being described.

nodetype: leaf (rw)

type: leafref

  • path reference: /interfaces/interface/config/name

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/
state

description:
Operational state parameters for the micro-BFD session.

nodetype: container (ro)

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
local-address

description:
The local IP address used by the system for the micro-BFD session specified.

nodetype: leaf (ro)

type: oc-inet:ip-address

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-address

description:
The remote IP destination that should be used by the system for the micro-BFD session specified.

nodetype: leaf (ro)

type: oc-inet:ip-address

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
member-interface

description:
Reference to a member link of the aggregate interface being described.

nodetype: leaf (ro)

type: leafref

  • path reference: /interfaces/interface/config/name

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
session-state

description:
The state of the BFD session perceived by the local system.

nodetype: leaf (ro)

type: bfd-session-state

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-session-state

description:
The reported state of the BFD session according to the remote system. This state reflects the last state reported in a BFD control packet.

nodetype: leaf (ro)

type: bfd-session-state

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
last-failure-time

description:
The time of the last transition of the BFD session out of the UP state, expressed as the number of nanoseconds since the Unix epoch.

nodetype: leaf (ro)

type: oc-types:timeticks64

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
failure-transitions

description:
The number of times that the BFD session has transitioned out of the UP state.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
local-discriminator

description:
A unique identifier used by the local system to identify this BFD session.

nodetype: leaf (ro)

type: string

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-discriminator

description:
A unique identified used by the remote system to identify this BFD session.

nodetype: leaf (ro)

type: string

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
local-diagnostic-code

description:
The local BFD diagnostic code indicating the most recent reason for failure of this BFD session.

nodetype: leaf (ro)

type: bfd-diagnostic-code

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-diagnostic-code

description:
The remote BFD diagnostic code indicating the remote system's reason for failure of the BFD session

nodetype: leaf (ro)

type: bfd-diagnostic-code

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-minimum-receive-interval

description:
The value of the minimum receive interval that was specified in the most recent BFD control packet received from the peer.

nodetype: leaf (ro)

type: uint32

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
demand-mode-requested

description:
This leaf is set to true when the remote system has requested demand mode be run for this session.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-authentication-enabled

description:
This leaf is set to true when the remote system has specified that authentication is present for the BFD session.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
remote-control-plane-independent

description:
This leaf is set to true when the remote system has specified that the hardware implementing this BFD session is independent of the control plane's liveliness.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/
async

description:
Operational state parameters specifically relating to asynchronous mode of BFD.

nodetype: container (ro)

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/async/
last-packet-transmitted

description:
The date and time at which the last BFD packet was transmitted for this session, expressed as the number of nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/async/
last-packet-received

description:
The date and time at which the last BFD packet was received for this session, expressed as the number of nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/async/
transmitted-packets

description:
The number of packets that have been transmitted by the local system.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/async/
received-packets

description:
The number of packets that have been received by the local system from the remote neighbour.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/micro-bfd-sessions/micro-bfd-session/state/async/
up-transitions

description:
The number of times that the adjacency with the neighbor has transitioned into the up state.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/
peers

description:
Parameters relating to the BFD peers which are seen over this interface.

nodetype: container (rw)

/bfd/interfaces/interface/peers/
peer

description:
Parameters relating to the BFD peer specified by the remote address.

nodetype: list (ro)

list keys: [local-discriminator]

/bfd/interfaces/interface/peers/peer/
local-discriminator

description:
The local discriminator, which is unique for the session on the system.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/local-discriminator

/bfd/interfaces/interface/peers/peer/
state

description:
Operational state parameters for the BFD session.

nodetype: container (ro)

/bfd/interfaces/interface/peers/peer/state/
local-address

description:
The IP address used by the local system for this BFD session.

nodetype: leaf (ro)

type: oc-inet:ip-address

/bfd/interfaces/interface/peers/peer/state/
remote-address

description:
The IP address used by the remote system for this BFD session.

nodetype: leaf (ro)

type: oc-inet:ip-address

/bfd/interfaces/interface/peers/peer/state/
subscribed-protocols

description:
Indicates the set of protocols that currently use this BFD session for liveliness detection.

nodetype: leaf-list (ro)

type: identityref

  • base: oc-pol-types:INSTALL_PROTOCOL_TYPE

/bfd/interfaces/interface/peers/peer/state/
session-state

description:
The state of the BFD session perceived by the local system.

nodetype: leaf (ro)

type: bfd-session-state

/bfd/interfaces/interface/peers/peer/state/
remote-session-state

description:
The reported state of the BFD session according to the remote system. This state reflects the last state reported in a BFD control packet.

nodetype: leaf (ro)

type: bfd-session-state

/bfd/interfaces/interface/peers/peer/state/
last-failure-time

description:
The time of the last transition of the BFD session out of the UP state, expressed as the number of nanoseconds since the Unix epoch.

nodetype: leaf (ro)

type: oc-types:timeticks64

/bfd/interfaces/interface/peers/peer/state/
failure-transitions

description:
The number of times that the BFD session has transitioned out of the UP state.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/
local-discriminator

description:
A unique identifier used by the local system to identify this BFD session.

nodetype: leaf (ro)

type: string

/bfd/interfaces/interface/peers/peer/state/
remote-discriminator

description:
A unique identified used by the remote system to identify this BFD session.

nodetype: leaf (ro)

type: string

/bfd/interfaces/interface/peers/peer/state/
local-diagnostic-code

description:
The local BFD diagnostic code indicating the most recent reason for failure of this BFD session.

nodetype: leaf (ro)

type: bfd-diagnostic-code

/bfd/interfaces/interface/peers/peer/state/
remote-diagnostic-code

description:
The remote BFD diagnostic code indicating the remote system's reason for failure of the BFD session

nodetype: leaf (ro)

type: bfd-diagnostic-code

/bfd/interfaces/interface/peers/peer/state/
remote-minimum-receive-interval

description:
The value of the minimum receive interval that was specified in the most recent BFD control packet received from the peer.

nodetype: leaf (ro)

type: uint32

/bfd/interfaces/interface/peers/peer/state/
demand-mode-requested

description:
This leaf is set to true when the remote system has requested demand mode be run for this session.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/peers/peer/state/
remote-authentication-enabled

description:
This leaf is set to true when the remote system has specified that authentication is present for the BFD session.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/peers/peer/state/
remote-control-plane-independent

description:
This leaf is set to true when the remote system has specified that the hardware implementing this BFD session is independent of the control plane's liveliness.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/peers/peer/state/
echo

description:
Operational state parameters specifically relating to the echo mode of BFD.

nodetype: container (ro)

/bfd/interfaces/interface/peers/peer/state/echo/
active

description:
This leaf is set to true when echo mode is running between the local and remote system. When it is set to false, solely asynchronous mode is active.

nodetype: leaf (ro)

type: boolean

/bfd/interfaces/interface/peers/peer/state/echo/
last-packet-transmitted

description:
The date and time at which the last BFD packet was transmitted for this session, expressed as the number of nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/echo/
last-packet-received

description:
The date and time at which the last BFD packet was received for this session, expressed as the number of nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/echo/
transmitted-packets

description:
The number of packets that have been transmitted by the local system.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/echo/
received-packets

description:
The number of packets that have been received by the local system from the remote neighbour.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/echo/
up-transitions

description:
The number of times that the adjacency with the neighbor has transitioned into the up state.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/
async

description:
Operational state parameters specifically relating to asynchronous mode of BFD.

nodetype: container (ro)

/bfd/interfaces/interface/peers/peer/state/async/
last-packet-transmitted

description:
The date and time at which the last BFD packet was transmitted for this session, expressed as the number of nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/async/
last-packet-received

description:
The date and time at which the last BFD packet was received for this session, expressed as the number of nanoseconds since the Unix Epoch (January 1, 1970, 00:00 UTC).

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/async/
transmitted-packets

description:
The number of packets that have been transmitted by the local system.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/async/
received-packets

description:
The number of packets that have been received by the local system from the remote neighbour.

nodetype: leaf (ro)

type: uint64

/bfd/interfaces/interface/peers/peer/state/async/
up-transitions

description:
The number of times that the adjacency with the neighbor has transitioned into the up state.

nodetype: leaf (ro)

type: uint64