Configuring BFD

Bidirectional Forwarding Detection (BFD) is a detection protocol designed to provide fast forwarding path failure detection times for all media types, encapsulations, topologies, and routing protocols. In addition to fast forwarding path failure detection, BFD provides a consistent failure detection method for network administrators. Because the network administrator can use BFD to detect forwarding path failures at a uniform rate, rather than the variable rates for different routing protocol hello mechanisms, network profiling and planning will be easier, and reconvergence time will be consistent and predictable.

See the Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide for more information.

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Enabling BFD

Enabling BFD

POST http://<mgmt0_IP>/api/mo/sys/fm.json

{
  "fmEntity": {
    "children": [
      {
        "fmBfd": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <fm-items>
    <bfd-items>
      <adminSt>enabled</adminSt>
    </bfd-items>
  </fm-items>
</System>

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

feature bfd

Note: The property information for this example was added in Release 9.3(3).

Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
fmEntity	sys/fm
fmBfd	sys/fm/bfd

fmBfd Properties

The following table contains information about the fmBfd properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling BFD

Disabling BFD

POST http://<mgmt0_IP>/api/mo/sys/fm.json

{
  "fmEntity": {
    "children": [
      {
        "fmBfd": {
          "attributes": {
            "adminSt": "disabled"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <fm-items>
    <bfd-items>
      <adminSt>disabled</adminSt>
    </bfd-items>
  </fm-items>
</System>

CLI Commands

no feature bfd

Note: The property information for this example was added in Release 9.3(3).

MO	DN
fmEntity	sys/fm
fmBfd	sys/fm/bfd

fmBfd Properties

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an Interface for BFD Echo Frames

Configuring an Interface for BFD Echo Frames

POST http://<mgmt0_IP>/api/mo/sys/bfd.json

{
  "bfdEntity": {
    "children": [
      {
        "bfdInst": {
          "attributes": {
            "echoIf": "lo123"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <echoIf>lo123</echoIf>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd echo-interface loopback 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst

bfdInst Properties

The following table contains information about the bfdInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
echoIf	nw:IfId (base:IfIndex)	Echo Interface to be used for BFD echo frames	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a BFD Echo Frames Configuration

Deleting a BFD Echo Frames Configuration

POST http://<mgmt0_IP>/api/mo/sys/bfd.json

{
  "bfdEntity": {
    "children": [
      {
        "bfdInst": {
          "attributes": {
            "echoIf": "null0"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <echoIf>null0</echoIf>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd echo-interface loopback 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst

bfdInst Properties

Property Name	Data Type	Description	Values
echoIf	nw:IfId (base:IfIndex)	Echo Interface to be used for BFD echo frames	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Delayed Startup Timer

Configuring the Delayed Startup Timer

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdEntity": {
    "children": [
      {
        "bfdInst": {
          "attributes": {
            "startupIntvl": "12"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <startupIntvl>12</startupIntvl>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd startup-timer 12

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst

bfdInst Properties

Property Name	Data Type	Description	Values
startupIntvl	bfd:StartupIntvl (scalar:Uint16)	Startup timer Interval	RANGE: [0 , 30] DEFAULT: 5

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling a Configured Startup Timer

Disabling a Configured Startup Timer

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdEntity": {
    "children": [
      {
        "bfdInst": {
          "attributes": {
            "startupIntvl": "5"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <startupIntvl>5</startupIntvl>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd startup-timer 12

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst

bfdInst Properties

Property Name	Data Type	Description	Values
startupIntvl	bfd:StartupIntvl (scalar:Uint16)	Startup timer Interval	RANGE: [0 , 30] DEFAULT: 5

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

IPv4 Configuration

Configuring the Minimum RX Interval and Multiplier Detection

Configuring the Minimum RX Interval and Multiplier Detection

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv4"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "detectMult": "25",
                  "minRxIntvl": "123",
                  "minTxIntvl": "123"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv4</type>
          <ka-items>
            <detectMult>25</detectMult>
            <minRxIntvl>123</minRxIntvl>
            <minTxIntvl>123</minTxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd ipv4 interval 123 min_rx 123 multiplier 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

The following table contains information about the bfdInstAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

The following table contains information about the bfdKaP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier. This is the desired detection time multiplier for BFD packets on the local system.	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MinRxIntvl (scalar:Uint16)	Required Minimum RX Interval. This is the minimum interval, in ms, between received BFD control packets that this system is capable of supporting.	RANGE: [50 , 999] DEFAULT: 50
minTxIntvl	bfd:MinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval.This is the minimum interval, in ms, that the system would like to use when transmitting BFD control packets.	RANGE: [50 , 999] DEFAULT: 50

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Minimum RX Interval and Multiplier Detection

Disabling the Minimum RX Interval and Multiplier Detection

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv4"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "detectMult": "3",
                  "minRxIntvl": "50",
                  "minTxIntvl": "50"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv4</type>
          <ka-items>
            <detectMult>3</detectMult>
            <minRxIntvl>50</minRxIntvl>
            <minTxIntvl>50</minTxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd ipv4 interval 123 min_rx 123 multiplier 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier. This is the desired detection time multiplier for BFD packets on the local system.	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MinRxIntvl (scalar:Uint16)	Required Minimum RX Interval. This is the minimum interval, in ms, between received BFD control packets that this system is capable of supporting.	RANGE: [50 , 999] DEFAULT: 50
minTxIntvl	bfd:MinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval.This is the minimum interval, in ms, that the system would like to use when transmitting BFD control packets.	RANGE: [50 , 999] DEFAULT: 50

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Slow Timer

Configuring the Slow Timer

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "slowIntvl": "1123",
            "type": "ipv4"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv4</type>
          <slowIntvl>1123</slowIntvl>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd ipv4 slow-timer 1123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}

bfdInstAf Properties

Property Name	Data Type	Description	Values
slowIntvl	bfd:SlowIntvl (scalar:Uint16)	Slow timer Interval	RANGE: [1000 , 30000] DEFAULT: 2000
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Slow Timer

Disabling the Slow Timer

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "slowIntvl": "2000",
            "type": "ipv4"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv4</type>
          <slowIntvl>2000</slowIntvl>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd ipv4 slow-timer 1123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}

bfdInstAf Properties

Property Name	Data Type	Description	Values
slowIntvl	bfd:SlowIntvl (scalar:Uint16)	Slow timer Interval	RANGE: [1000 , 30000] DEFAULT: 2000
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a BFD Session Echo RX Interval

Configuring a BFD Session Echo RX Interval

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv4"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "echoRxIntvl": "123"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv4</type>
          <ka-items>
            <echoRxIntvl>123</echoRxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd ipv4 echo-rx-interval 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
echoRxIntvl	bfd:EchoRxIntvl (scalar:Uint16)	Echo Rx Interval. This is the minimum interval,in ms, between received BFD echo packets that this system is capable of supporting.	RANGE: [0 , 999] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a BFD Session Echo RX Interval Configuration

Deleting a BFD Session Echo RX Interval Configuration

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv4"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "echoRxIntvl": "0"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv4</type>
          <ka-items>
            <echoRxIntvl>0</echoRxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd ipv4 echo-rx-interval 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
echoRxIntvl	bfd:EchoRxIntvl (scalar:Uint16)	Echo Rx Interval. This is the minimum interval,in ms, between received BFD echo packets that this system is capable of supporting.	RANGE: [0 , 999] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Keyed-SHA1 Authentication

Configuring Keyed-SHA1 Authentication

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "type": "ipv4"
                },
                "children": [
                  {
                    "bfdAuthP": {
                      "attributes": {
                        "hexKey": "0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0",
                        "hexKeySize": "0",
                        "key": "Val_1",
                        "keyId": "123",
                        "type": "sha1"
}}}]}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv4</type>
              <auth[met-sha1][sha1][met-sha1]-items>
                <hexKey>0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0</hexKey>
                <hexKeySize>0</hexKeySize>
                <key>Val_1</key>
                <keyId>123</keyId>
                <type>sha1</type>
              </auth[met-sha1][sha1][met-sha1]-items>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
bfd ipv4 auth[met-sha1][sha1][met-sha1]entication Keyed-SHA1 key-id 123 key Val_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
bfdAuthP	sys/bfd/inst/if-{[id]}/af-{type}/auth

bfdIf Properties

The following table contains information about the bfdIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

The following table contains information about the bfdIfAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdAuthP Properties

The following table contains information about the bfdAuthP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
hexKey	bfd:AuthHexKey (base:Uint8Array)	A property to indicate Authentication Hex Key for the BFD session	ARRAY SIZE: 40
hexKeySize	bfd:AuthHexKeySize (scalar:UByte)	A property to indicate Authentication Hex Key Size	RANGE: [0 , 40]
key	bfd:AuthKey (string:Password)	A property to indicate Authentication Key for the BFD session	MAX SIZE: 20
keyId	bfd:AuthKeyId (scalar:UByte)	Authentication Key ID to be used in the BFD session	RANGE: [1 , 255]
type	bfd:AuthT (scalar:Enum8)	Authentication Type of the BFD session	SELECTION: 0 - none 4 - sha1 5 - met-sha1 DEFAULT: none

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Meticulous-Keyed-SHA1 Authentication

Configuring Meticulous-Keyed-SHA1 Authentication

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "type": "ipv4"
                },
                "children": [
                  {
                    "bfdAuthP": {
                      "attributes": {
                        "hexKey": "0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0",
                        "hexKeySize": "0",
                        "key": "VAL_1",
                        "keyId": "123",
                        "type": "met-sha1"
}}}]}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv4</type>
              <auth[met-sha1][sha1]-items>
                <hexKey>0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0</hexKey>
                <hexKeySize>0</hexKeySize>
                <key>VAL_1</key>
                <keyId>123</keyId>
                <type>met-sha1</type>
              </auth[met-sha1][sha1]-items>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
bfd ipv4 auth[met-sha1][sha1]entication meticulous-Keyed-SHA1 key-id 123 key VAL_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
bfdAuthP	sys/bfd/inst/if-{[id]}/af-{type}/auth

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdAuthP Properties

Property Name	Data Type	Description	Values
hexKey	bfd:AuthHexKey (base:Uint8Array)	A property to indicate Authentication Hex Key for the BFD session	ARRAY SIZE: 40
hexKeySize	bfd:AuthHexKeySize (scalar:UByte)	A property to indicate Authentication Hex Key Size	RANGE: [0 , 40]
key	bfd:AuthKey (string:Password)	A property to indicate Authentication Key for the BFD session	MAX SIZE: 20
keyId	bfd:AuthKeyId (scalar:UByte)	Authentication Key ID to be used in the BFD session	RANGE: [1 , 255]
type	bfd:AuthT (scalar:Enum8)	Authentication Type of the BFD session	SELECTION: 0 - none 4 - sha1 5 - met-sha1 DEFAULT: none

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Echo Function for all Address Families

Configuring the Echo Function for all Address Families

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "echoAdminSt": "enabled",
                  "type": "ipv4"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv4</type>
              <echoAdminSt>enabled</echoAdminSt>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
bfd ipv4 echo

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
echoAdminSt	nw:AdminSt (scalar:Enum8)	Echo Mode Admin State for Interface Address family	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Echo Function for all Address Families

Disabling the Echo Function for all Address Families

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "echoAdminSt": "disabled",
                  "type": "ipv4"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv4</type>
              <echoAdminSt>disabled</echoAdminSt>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
no bfd ipv4 echo

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
echoAdminSt	nw:AdminSt (scalar:Enum8)	Echo Mode Admin State for Interface Address family	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring BFD Interval

Configuring BFD Interval

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst/if-{[id]}.json

{
  "bfdIf": {
    "attributes": {
      "id": "eth1/1"
    },
    "children": [
      {
        "bfdKaP": {
          "attributes": {
            "detectMult": "3",
            "minRxIntvl": "50",
            "minTxIntvl": "50"
}}}]}}

{
    imdata:[]
}

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/1</id>
          <ka-items>
            <detectMult>3</detectMult>
            <minRxIntvl>50</minRxIntvl>
            <minTxIntvl>50</minTxIntvl>
          </ka-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

Configures the BFD session parameters for all BFD sessions on the device. This command overrides these values by configuring the BFD session parameters on an interface.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

interface ethernet1/1
bfd interval 50 min_rx 50 multiplier 3

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdIf	sys/bfd/inst/if-{[id]}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdKaP Properties

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier. This is the desired detection time multiplier for BFD packets on the local system.	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MinRxIntvl (scalar:Uint16)	Required Minimum RX Interval. This is the minimum interval, in ms, between received BFD control packets that this system is capable of supporting.	RANGE: [50 , 999] DEFAULT: 50
minTxIntvl	bfd:MinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval.This is the minimum interval, in ms, that the system would like to use when transmitting BFD control packets.	RANGE: [50 , 999] DEFAULT: 50

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring BFD Sessions on Each Port-Channel Link

Configuring BFD Sessions on Each Port-Channel Link

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bfdEntity": {
          "children": [
            {
              "bfdInst": {
                "children": [
                  {
                    "bfdIf": {
                      "attributes": {
                        "id": "po123"
                      },
                      "children": [
                        {
                          "bfdIfAf": {
                            "attributes": {
                              "ctrl": "pc-per-link",
                              "type": "ipv4"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po123"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>po123</id>
          <af-items>
            <IfAf-list>
              <type>ipv4</type>
              <ctrl>pc-per-link</ctrl>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

CLI Commands

interface port-channel 123
bfd ipv4 per-link

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
ctrl	bfd:IfControl (scalar:Bitmask8)	Interface Controls	SELECTION: 1 - opt-subif 2 - pc-per-link
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

pcAggrIf Properties

The following table contains information about the pcAggrIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling BFD Sessions on Each Port-Channel Link

Disabling BFD Sessions on Each Port-Channel Link

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bfdEntity": {
          "children": [
            {
              "bfdInst": {
                "children": [
                  {
                    "bfdIf": {
                      "attributes": {
                        "id": "po123"
                      },
                      "children": [
                        {
                          "bfdIfAf": {
                            "attributes": {
                              "ctrl": "",
                              "type": "ipv4"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po123"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>po123</id>
          <af-items>
            <IfAf-list>
              <type>ipv4</type>
              <ctrl></ctrl>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

CLI Commands

interface port-channel 123
no bfd ipv4 per-link

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
ctrl	bfd:IfControl (scalar:Bitmask8)	Interface Controls	SELECTION: 1 - opt-subif 2 - pc-per-link
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

pcAggrIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

IPv6 Configuration

Configuring the Minimum RX Interval and Multiplier Detection

Configuring the Minimum RX Interval and Multiplier Detection

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv6"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "detectMult": "25",
                  "minRxIntvl": "123",
                  "minTxIntvl": "123"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv6</type>
          <ka-items>
            <detectMult>25</detectMult>
            <minRxIntvl>123</minRxIntvl>
            <minTxIntvl>123</minTxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd ipv6 interval 123 min_rx 123 multiplier 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier. This is the desired detection time multiplier for BFD packets on the local system.	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MinRxIntvl (scalar:Uint16)	Required Minimum RX Interval. This is the minimum interval, in ms, between received BFD control packets that this system is capable of supporting.	RANGE: [50 , 999] DEFAULT: 50
minTxIntvl	bfd:MinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval.This is the minimum interval, in ms, that the system would like to use when transmitting BFD control packets.	RANGE: [50 , 999] DEFAULT: 50

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Minimum RX Interval and Multiplier Detection

Disabling the Minimum RX Interval and Multiplier Detection

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv6"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "detectMult": "3",
                  "minRxIntvl": "50",
                  "minTxIntvl": "50"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv6</type>
          <ka-items>
            <detectMult>3</detectMult>
            <minRxIntvl>50</minRxIntvl>
            <minTxIntvl>50</minTxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd ipv6 interval 123 min_rx 123 multiplier 25

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier. This is the desired detection time multiplier for BFD packets on the local system.	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MinRxIntvl (scalar:Uint16)	Required Minimum RX Interval. This is the minimum interval, in ms, between received BFD control packets that this system is capable of supporting.	RANGE: [50 , 999] DEFAULT: 50
minTxIntvl	bfd:MinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval.This is the minimum interval, in ms, that the system would like to use when transmitting BFD control packets.	RANGE: [50 , 999] DEFAULT: 50

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Slow Timer

Configuring the Slow Timer

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "slowIntvl": "1123",
            "type": "ipv6"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv6</type>
          <slowIntvl>1123</slowIntvl>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd ipv6 slow-timer 1123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}

bfdInstAf Properties

Property Name	Data Type	Description	Values
slowIntvl	bfd:SlowIntvl (scalar:Uint16)	Slow timer Interval	RANGE: [1000 , 30000] DEFAULT: 2000
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Slow Timer

Disabling the Slow Timer

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "slowIntvl": "2000",
            "type": "ipv6"
}}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv6</type>
          <slowIntvl>2000</slowIntvl>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd ipv6 slow-timer 1123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}

bfdInstAf Properties

Property Name	Data Type	Description	Values
slowIntvl	bfd:SlowIntvl (scalar:Uint16)	Slow timer Interval	RANGE: [1000 , 30000] DEFAULT: 2000
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a BFD Session Echo RX Interval

Configuring a BFD Session Echo RX Interval

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv6"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "echoRxIntvl": "123"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv6</type>
          <ka-items>
            <echoRxIntvl>123</echoRxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

bfd ipv6 echo-rx-interval 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
echoRxIntvl	bfd:EchoRxIntvl (scalar:Uint16)	Echo Rx Interval. This is the minimum interval,in ms, between received BFD echo packets that this system is capable of supporting.	RANGE: [0 , 999] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a BFD Session Echo RX Interval Configuration

Deleting a BFD Session Echo RX Interval Configuration

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdInstAf": {
          "attributes": {
            "type": "ipv6"
          },
          "children": [
            {
              "bfdKaP": {
                "attributes": {
                  "echoRxIntvl": "0"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <af-items>
        <InstAf-list>
          <type>ipv6</type>
          <ka-items>
            <echoRxIntvl>0</echoRxIntvl>
          </ka-items>
        </InstAf-list>
      </af-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

no bfd ipv6 echo-rx-interval 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdInstAf	sys/bfd/inst/af-{type}
bfdKaP	sys/bfd/inst/af-{type}/ka

bfdInstAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdKaP Properties

Property Name	Data Type	Description	Values
echoRxIntvl	bfd:EchoRxIntvl (scalar:Uint16)	Echo Rx Interval. This is the minimum interval,in ms, between received BFD echo packets that this system is capable of supporting.	RANGE: [0 , 999] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Keyed-SHA1 Authentication

Configuring Keyed-SHA1 Authentication

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "type": "ipv6"
                },
                "children": [
                  {
                    "bfdAuthP": {
                      "attributes": {
                        "hexKey": "0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0",
                        "hexKeySize": "0",
                        "key": "Val_",
                        "keyId": "123",
                        "type": "sha1"
}}}]}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv6</type>
              <auth[met-sha1]-items>
                <hexKey>0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0</hexKey>
                <hexKeySize>0</hexKeySize>
                <key>Val_</key>
                <keyId>123</keyId>
                <type>sha1</type>
              </auth[met-sha1]-items>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
bfd ipv6 auth[met-sha1]entication Keyed-SHA1 key-id 123 key Val_

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
bfdAuthP	sys/bfd/inst/if-{[id]}/af-{type}/auth

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdAuthP Properties

Property Name	Data Type	Description	Values
hexKey	bfd:AuthHexKey (base:Uint8Array)	A property to indicate Authentication Hex Key for the BFD session	ARRAY SIZE: 40
hexKeySize	bfd:AuthHexKeySize (scalar:UByte)	A property to indicate Authentication Hex Key Size	RANGE: [0 , 40]
key	bfd:AuthKey (string:Password)	A property to indicate Authentication Key for the BFD session	MAX SIZE: 20
keyId	bfd:AuthKeyId (scalar:UByte)	Authentication Key ID to be used in the BFD session	RANGE: [1 , 255]
type	bfd:AuthT (scalar:Enum8)	Authentication Type of the BFD session	SELECTION: 0 - none 4 - sha1 5 - met-sha1 DEFAULT: none

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Meticulous-Keyed-SHA1 Authentication

Configuring Meticulous-Keyed-SHA1 Authentication

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "type": "ipv6"
                },
                "children": [
                  {
                    "bfdAuthP": {
                      "attributes": {
                        "hexKey": "0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0",
                        "hexKeySize": "0",
                        "key": "VAL_1",
                        "keyId": "123",
                        "type": "met-sha1"
}}}]}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv6</type>
              <auth-items>
                <hexKey>0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0</hexKey>
                <hexKeySize>0</hexKeySize>
                <key>VAL_1</key>
                <keyId>123</keyId>
                <type>met-sha1</type>
              </auth-items>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
bfd ipv6 authentication meticulous-Keyed-SHA1 key-id 123 key VAL_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
bfdAuthP	sys/bfd/inst/if-{[id]}/af-{type}/auth

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

bfdAuthP Properties

Property Name	Data Type	Description	Values
hexKey	bfd:AuthHexKey (base:Uint8Array)	A property to indicate Authentication Hex Key for the BFD session	ARRAY SIZE: 40
hexKeySize	bfd:AuthHexKeySize (scalar:UByte)	A property to indicate Authentication Hex Key Size	RANGE: [0 , 40]
key	bfd:AuthKey (string:Password)	A property to indicate Authentication Key for the BFD session	MAX SIZE: 20
keyId	bfd:AuthKeyId (scalar:UByte)	Authentication Key ID to be used in the BFD session	RANGE: [1 , 255]
type	bfd:AuthT (scalar:Enum8)	Authentication Type of the BFD session	SELECTION: 0 - none 4 - sha1 5 - met-sha1 DEFAULT: none

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Echo Function for all Address Families

Configuring the Echo Function for all Address Families

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "echoAdminSt": "enabled",
                  "type": "ipv6"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv6</type>
              <echoAdminSt>enabled</echoAdminSt>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
bfd ipv6 echo

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
echoAdminSt	nw:AdminSt (scalar:Enum8)	Echo Mode Admin State for Interface Address family	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling the Echo Function for all Address Families

Disabling the Echo Function for all Address Families

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "bfdIfAf": {
                "attributes": {
                  "echoAdminSt": "disabled",
                  "type": "ipv6"
}}}]}}]}}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/2</id>
          <af-items>
            <IfAf-list>
              <type>ipv6</type>
              <echoAdminSt>disabled</echoAdminSt>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
</System>

CLI Commands

interface ethernet 1/2
no bfd ipv6 echo

Note: The property information for this example was added in Release 9.3(3).

MO	DN
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
echoAdminSt	nw:AdminSt (scalar:Enum8)	Echo Mode Admin State for Interface Address family	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring BFD Sessions on Each Port-Channel Link

Configuring BFD Sessions on Each Port-Channel Link

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bfdEntity": {
          "children": [
            {
              "bfdInst": {
                "children": [
                  {
                    "bfdIf": {
                      "attributes": {
                        "id": "po123"
                      },
                      "children": [
                        {
                          "bfdIfAf": {
                            "attributes": {
                              "ctrl": "pc-per-link",
                              "type": "ipv6"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po123"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>po123</id>
          <af-items>
            <IfAf-list>
              <type>ipv6</type>
              <ctrl>pc-per-link</ctrl>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

CLI Commands

interface port-channel 123
bfd ipv6 per-link

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
ctrl	bfd:IfControl (scalar:Bitmask8)	Interface Controls	SELECTION: 1 - opt-subif 2 - pc-per-link
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

pcAggrIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling BFD Sessions on Each Port-Channel Link

Disabling BFD Sessions on Each Port-Channel Link

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bfdEntity": {
          "children": [
            {
              "bfdInst": {
                "children": [
                  {
                    "bfdIf": {
                      "attributes": {
                        "id": "po123"
                      },
                      "children": [
                        {
                          "bfdIfAf": {
                            "attributes": {
                              "ctrl": "",
                              "type": "ipv6"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po123"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:

<System>
  <bfd-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>po123</id>
          <af-items>
            <IfAf-list>
              <type>ipv6</type>
              <ctrl></ctrl>
            </IfAf-list>
          </af-items>
        </If-list>
      </if-items>
    </inst-items>
  </bfd-items>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

CLI Commands

interface port-channel 123
no bfd ipv6 per-link

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
bfdEntity	sys/bfd
bfdInst	sys/bfd/inst
bfdIf	sys/bfd/inst/if-{[id]}
bfdIfAf	sys/bfd/inst/if-{[id]}/af-{type}
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

bfdIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

bfdIfAf Properties

Property Name	Data Type	Description	Values
ctrl	bfd:IfControl (scalar:Bitmask8)	Interface Controls	SELECTION: 1 - opt-subif 2 - pc-per-link
type	bfd:AfT (scalar:Enum8)	Type of the Address Family	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

pcAggrIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring BFD Multihop Session Parameters

Configuring BFD Multihop Session Parameters

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdMhop": {
          "attributes": {
            "detectMult": "6",
            "minRxIntvl": "640",
            "minTxIntvl": "640"
}}}]}}

{
    imdata:[]
}

<System>
  <bfd-items>
    <inst-items>
      <mhop-items>
        <detectMult>6</detectMult>
        <minRxIntvl>640</minRxIntvl>
        <minTxIntvl>640</minTxIntvl>
      </mhop-items>
    </inst-items>
  </bfd-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

bfd multihop interval 640 min_rx 640 multiplier 6

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
bfdInst	sys/bfd/inst
bfdMhop	sys/bfd/inst/mhop

bfdMhop Properties

The following table contains information about the bfdMhop properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MhMinRxIntvl (scalar:Uint16)	Required Minimum RX Interval	RANGE: [250 , 999] DEFAULT: 250
minTxIntvl	bfd:MhMinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval	RANGE: [250 , 999] DEFAULT: 250

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Broadcast VPC-watch Session State Notification to Subscribers

Broadcast VPC-watch Session State Notification to Subscribers

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
    imdata:[]
}

CLI Commands

bfdMhop Properties

Property Name	Type	Owner	MOD
vpcWatch	TrkMbrLnk	management	explicit

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting BFD Multihop Session Parameters

Deleting BFD Multihop Session Parameters

POST http://<mgmt0_IP>/api/mo/sys/bfd/inst.json

{
  "bfdInst": {
    "children": [
      {
        "bfdMhop": {
          "attributes": {
            "detectMult": "3",
            "minRxIntvl": "250",
            "minTxIntvl": "250"
}}}]}}

{
    imdata:[]
}

<System>
  <bfd-items>
    <inst-items>
      <mhop-items>
        <detectMult>3</detectMult>
        <minRxIntvl>250</minRxIntvl>
        <minTxIntvl>250</minTxIntvl>
      </mhop-items>
    </inst-items>
  </bfd-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

no bfd multihop interval

Verifying a DME Configuration

MO	DN
bfdInst	sys/bfd/inst
bfdMhop	sys/bfd/inst/mhop

bfdMhop Properties

Property Name	Data Type	Description	Values
detectMult	bfd:DetectMult (scalar:UByte)	Detection Multiplier	RANGE: [1 , 50] DEFAULT: 3
minRxIntvl	bfd:MhMinRxIntvl (scalar:Uint16)	Required Minimum RX Interval	RANGE: [250 , 999] DEFAULT: 250
minTxIntvl	bfd:MhMinTxIntvl (scalar:Uint16)	Desired Minimum TX Interval	RANGE: [250 , 999] DEFAULT: 250

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html