An OpenConfig model of Bi-Directional Forwarding Detection (BFD) configuration and operational state.
openconfig-extensions
openconfig-types
openconfig-interfaces
openconfig-inet-types
openconfig-policy-types
ietf-inet-types
description:
The state of the BFD session according to the system referred
to by the context of the leaf.
type: enumeration
description:
Diagnostic codes defined by BFD. These typically indicate the
reason for a change of session state.
type: enumeration
description:
Configuration and operational state parameters for BFD.
nodetype: container (rw)
description:
Interfaces on which BFD sessions are to be enabled.
nodetype: container (rw)
description:
Per-interface configuration and state parameters for BFD.
The interface referenced is based on the interface and
subinterface leaves within the interface-ref container -
which reference an entry in the /interfaces/interface list -
and should not rely on the value of the list key.
nodetype: list (rw)
list keys: [id]
description:
A reference to an identifier for the interface on which
BFD is enabled.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters for BFD on the specified
interface.
nodetype: container (rw)
description:
A unique identifier for the interface.
nodetype: leaf (rw)
type: oc-if:interface-id
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
description:
The source IP address to be used for BFD sessions over this
interface.
nodetype: leaf (rw)
type: oc-inet:ip-address
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
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
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
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
description:
Operational state parameters for BFD on the specified
interface.
nodetype: container (ro)
description:
A unique identifier for the interface.
nodetype: leaf (ro)
type: oc-if:interface-id
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
description:
The source IP address to be used for BFD sessions over this
interface.
nodetype: leaf (ro)
type: oc-inet:ip-address
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
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
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
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
description:
Reference to an interface or subinterface. The interface
that is being referenced is uniquely referenced based on
the specified interface and subinterface leaves. In contexts
where a Layer 3 interface is to be referenced, both the
interface and subinterface leaves must be populated, as
Layer 3 configuration within the OpenConfig models is
associated with a subinterface. In the case where a
Layer 2 interface is to be referenced, only the
interface is specified.
The interface/subinterface leaf tuple must be used as
the means by which the interface is specified, regardless
of any other context information (e.g., key in a list).
nodetype: container (rw)
description:
Configured reference to interface / subinterface
nodetype: container (rw)
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
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
description:
Operational state for interface-ref
nodetype: container (ro)
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
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
description:
Parameters relating to micro-BFD sessions associated
with the interface.
nodetype: container (rw)
description:
This list contains configuration and state parameters
relating to micro-BFD session.
nodetype: list (rw)
list keys: [member-interface]
description:
A reference to the member interface of the link
aggregate.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration parameters for the micro-BFD session.
nodetype: container (rw)
description:
The local IP address used by the system for the micro-BFD session
specified.
nodetype: leaf (rw)
type: oc-inet:ip-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
description:
Reference to a member link of the aggregate interface being
described.
nodetype: leaf (rw)
type: leafref
description:
Operational state parameters for the micro-BFD session.
nodetype: container (ro)
description:
The local IP address used by the system for the micro-BFD session
specified.
nodetype: leaf (ro)
type: oc-inet:ip-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
description:
Reference to a member link of the aggregate interface being
described.
nodetype: leaf (ro)
type: leafref
description:
The state of the BFD session perceived by the local system.
nodetype: leaf (ro)
type: bfd-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
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
description:
The number of times that the BFD session has transitioned
out of the UP state.
nodetype: leaf (ro)
type: uint64
description:
A unique identifier used by the local system to identify this
BFD session.
nodetype: leaf (ro)
type: string
description:
A unique identified used by the remote system to identify this
BFD session.
nodetype: leaf (ro)
type: string
description:
The local BFD diagnostic code indicating the most recent
reason for failure of this BFD session.
nodetype: leaf (ro)
type: bfd-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
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
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
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
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
description:
Operational state parameters specifically relating to
asynchronous mode of BFD.
nodetype: container (ro)
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
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
description:
The number of packets that have been transmitted
by the local system.
nodetype: leaf (ro)
type: uint64
description:
The number of packets that have been received by the
local system from the remote neighbour.
nodetype: leaf (ro)
type: uint64
description:
The number of times that the adjacency with the neighbor
has transitioned into the up state.
nodetype: leaf (ro)
type: uint64
description:
Parameters relating to the BFD peers which are seen
over this interface.
nodetype: container (rw)
description:
Parameters relating to the BFD peer specified by the
remote address.
nodetype: list (ro)
list keys: [local-discriminator]
description:
The local discriminator, which is unique for the
session on the system.
nodetype: leaf (list key) (ro)
type: leafref
description:
Operational state parameters for the BFD session.
nodetype: container (ro)
description:
The IP address used by the local system for this BFD session.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
The IP address used by the remote system for this BFD session.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Indicates the set of protocols that currently use
this BFD session for liveliness detection.
nodetype: leaf-list (ro)
type: identityref
description:
The state of the BFD session perceived by the local system.
nodetype: leaf (ro)
type: bfd-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
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
description:
The number of times that the BFD session has transitioned
out of the UP state.
nodetype: leaf (ro)
type: uint64
description:
A unique identifier used by the local system to identify this
BFD session.
nodetype: leaf (ro)
type: string
description:
A unique identified used by the remote system to identify this
BFD session.
nodetype: leaf (ro)
type: string
description:
The local BFD diagnostic code indicating the most recent
reason for failure of this BFD session.
nodetype: leaf (ro)
type: bfd-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
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
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
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
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
description:
Operational state parameters specifically relating to the
echo mode of BFD.
nodetype: container (ro)
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
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
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
description:
The number of packets that have been transmitted
by the local system.
nodetype: leaf (ro)
type: uint64
description:
The number of packets that have been received by the
local system from the remote neighbour.
nodetype: leaf (ro)
type: uint64
description:
The number of times that the adjacency with the neighbor
has transitioned into the up state.
nodetype: leaf (ro)
type: uint64
description:
Operational state parameters specifically relating to
asynchronous mode of BFD.
nodetype: container (ro)
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
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
description:
The number of packets that have been transmitted
by the local system.
nodetype: leaf (ro)
type: uint64
description:
The number of packets that have been received by the
local system from the remote neighbour.
nodetype: leaf (ro)
type: uint64
description:
The number of times that the adjacency with the neighbor
has transitioned into the up state.
nodetype: leaf (ro)
type: uint64