Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)
NX-OS 9.3(x)
Configuring BFD for PIM in VRF Mode
DME
YANG
Copy
POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
 }},{
"pimEntity": {
  "children": [
    {
      "pimInst": {
        "children": [
          {
            "pimDom": {
              "attributes": {
                "bfd": "yes",
                "name": "VRF_1"

}}}]}}]}}]}}

Copy
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
    </Inst-list>
  </inst-items>
  <pim-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <bfd>true</bfd>
        </Dom-list>
      </dom-items>
    </inst-items>
  </pim-items>
</System>

Configuring BFD for PIM

You can configure Bidirectional Forwarding Detection (BFD) for PIM by either VRF or interface.

Configuring BFD for PIM in VRF Mode

Configuring BFD for PIM in VRF Mode

This example configures BFD for PIM on the default DOM.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

interface ethernet 1/2
 vrf context VRF_1
  ip pim 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.

MODN
topSystem sys
l3Inst sys/inst-{name}
pimEntity sys/pim
pimInst sys/pim/inst
pimDom sys/pim/inst/dom-{name}


l3Inst Properties

The following table contains information about the l3Inst 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)		The name of the object.
MAX SIZE: 128


pimDom Properties

The following table contains information about the pimDom 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 NameData TypeDescriptionValues
bfdscalar:Bool
BFDSELECTION: true or false
namenaming:Name256
(string:Basic)		The name of the object.
MAX SIZE: 63


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 for PIM on an Interface

Configuring BFD for PIM on an Interface

This example configures BFD for PIM on Ethernet interface 1/2.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

interface eth1/2
 ip pim bfd-instance

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.

MODN
pimInst sys/pim/inst
pimDom sys/pim/inst/dom-{name}
pimIf sys/pim/inst/dom-{name}/if-{[id]}


pimDom Properties

The following table contains information about the pimDom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)		The name of the object.
MAX SIZE: 63


pimIf Properties

The following table contains information about the pimIf 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 NameData TypeDescriptionValues
bfdInstpim:BfdInstSt
(scalar:Enum8)		BFD Instance StateSELECTION:
0 - none
1 - enabled
2 - disabled
DEFAULT: none
idnw: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

Next