Configuring a BGP Neighbor (Ethernet Interface) Under a VRF

Configuring the AS Number of the Neighbor

Configuring the AS Number of the Neighbor

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "asn": "123",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <asn>123</asn>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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.

router bgp 100
vrf VRF_1
neighbor ethernet 1/2 remote-as 123

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
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

The following table contains information about the bgpInst 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
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

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

bgpPeerIf Properties

The following table contains information about the bgpPeerIf 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
asn	string:Basic	Autonomous System Number, takes value from (1-4294967295 \	1-65535[.(0-65535)])
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	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 BGP Neighbor remote-as 123

Deleting a BGP Neighbor remote-as 123

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list nc:operation="delete">
              <id>eth1/2</id>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
vrf VRF_1
no neighbor ethernet 1/2 remote-as 123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 Peer Inheritance

Configuring Peer Inheritance

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerImp": "SampleString_123"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <peerImp>SampleString_123</peerImp>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
  vrf VRF_1
   neighbor ethernet 1/2
    inherit peer SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
peerImp	string:Basic	Peer Template To Import From	A sequence of characters

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 Peer Inheritance

Deleting Peer Inheritance

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerImp": ""
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <peerImp></peerImp>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
  vrf VRF_1
   neighbor ethernet 1/2
    no inherit peer SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
peerImp	string:Basic	Peer Template To Import From	A sequence of characters

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 Password for a Neighbor

Configuring a Password for a Neighbor

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "passwdType": "3",
                        "password": "09687c99a3709748e35c138723ac7037"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <passwdType>3</passwdType>
              <password>09687c99a3709748e35c138723ac7037</password>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
  vrf VRF_1
   neighbor ethernet 1/2
    password SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
passwdType	bgp:PwdType (scalar:Enum8)	Password EnCrypt Type	SELECTION: 0 - 0 3 - 3 5 - LINE 7 - 7 DEFAULT: LINE
password	string:Basic	Configure a password for neighbor	A sequence of characters

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 Password for a Neighbor

Deleting a Password for a Neighbor

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "passwdType": "LINE",
                        "password": ""
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <passwdType>LINE</passwdType>
              <password></password>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
  vrf VRF_1
   neighbor ethernet 1/2
    no password SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
passwdType	bgp:PwdType (scalar:Enum8)	Password EnCrypt Type	SELECTION: 0 - 0 3 - 3 5 - LINE 7 - 7 DEFAULT: LINE
password	string:Basic	Configure a password for neighbor	A sequence of characters

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 Passive Connection Setup Only

Configuring a Passive Connection Setup Only

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "connMode": "passive",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <connMode>passive</connMode>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
  vrf VRF_1
   neighbor ethernet 1/2
    transport connection-mode passive

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
connMode	bgp:ConnMode (scalar:Bitmask8)	BGP transport connection mode	SELECTION: 1 - passive
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	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 Passive Connection Setup Only

Deleting a Passive Connection Setup Only

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "VRF_1"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "connMode": "",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>VRF_1</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <connMode></connMode>
            </PeerIf-list>
          </peerif-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

CLI Commands

router bgp 100
  vrf VRF_1
   neighbor ethernet 1/2
    no transport connection-mode passive

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-VRF_1
bgpPeerIf	sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeerIf Properties

Property Name	Data Type	Description	Values
connMode	bgp:ConnMode (scalar:Bitmask8)	BGP transport connection mode	SELECTION: 1 - passive
id	nw:IfId (base:IfIndex)	Interface identifier of the neighbor	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