Configuring a BGP Neighbor (Ethernet Interface)

Configuring a BGP Neighbor

Configuring a BGP Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <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

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
neighbor ethernet 1/2

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-default
bgpPeerIf	sys/bgp/inst/dom-default/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
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

Configuring the Log Message for Neighbor Up/Down Events

Configuring the Log Message for Neighbor Up/Down Events

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

{
  "bgpEntity": {+
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "logNbrChgs": "enable"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <logNbrChgs>enable</logNbrChgs>
            </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
neighbor ethernet 1/2
log-neighbor-changes

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
logNbrChgs	bgp:LogNbrSt (scalar:Enum8)	Log messages for Neighbor up/down events	SELECTION: 0 - none 1 - enable 2 - disable 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

Deleting the Log Message for Neighbor Up/Down Events

Deleting the Log Message for Neighbor Up/Down Events

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <logNbrChgs>none</logNbrChgs>
            </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
neighbor ethernet 1/2
no log-neighbor-changes

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
logNbrChgs	bgp:LogNbrSt (scalar:Enum8)	Log messages for Neighbor up/down events	SELECTION: 0 - none 1 - enable 2 - disable 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 Peer Inheritance

Configuring Peer Inheritance

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerImp": ""
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "passwdType": "3",
                        "password": "09687c99a3709748e35c138723ac7037"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "passwdType": "LINE",
                        "password": ""
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "connMode": "passive",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "connMode": "",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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

Configuring an IPv4 Unicast Subaddress Family

Configuring an IPv4 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "ipv4-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>ipv4-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family ipv4 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv4-ucast

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

bgpPeerAf Properties

The following table contains information about the bgpPeerAf 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	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 an IPv4 Unicast Subaddress Family

Deleting an IPv4 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "ipv4-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>ipv4-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family ipv4 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv4-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 IPv6 Multicast Subaddress Family

Configuring an IPv6 Multicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "ipv6-mcast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-mcast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family ipv6 multicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv6-mcast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 an IPv6 Multicast Subaddress Family

Deleting an IPv6 Multicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "ipv6-mcast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>ipv6-mcast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family ipv6 multicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv6-mcast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 IPv6 Unicast Subaddress Family

Configuring an IPv6 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "ipv6-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family ipv6 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv6-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 an IPv6 Unicast Subaddress Family

Deleting an IPv6 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "ipv6-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>ipv6-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family ipv6 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv6-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 VPNv4 Unicast Subaddress Family

Configuring a VPNv4 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "vpnv4-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family vpnv4 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 VPNv4 Unicast Subaddress Family

Deleting a VPNv4 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "vpnv4-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>vpnv4-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family vpnv4 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 VPNv6 Unicast Subaddress Family

Configuring a VPNv6 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "vpnv6-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>vpnv6-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family vpnv6 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv6-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 VPNv6 Unicast Subaddress Family

Deleting a VPNv6 Unicast Subaddress Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "vpnv6-ucast"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>vpnv6-ucast</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family vpnv6 unicast

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv6-ucast

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 Link-State Address Family

Configuring a Link-State Address Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "lnkstate"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>lnkstate</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family link-state

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-lnkstate

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 Link-State Address Family

Deleting a Link-State Address Family

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>lnkstate</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family link-state

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-lnkstate

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 IPv6 Multicast VPN (MVPN)

Configuring IPv6 Multicast VPN (MVPN)

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "ipv6-mvpn"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-mvpn</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family ipv6 mvpn

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv6-mvpn

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 IPv6 Multicast VPN (MVPN)

Deleting IPv6 Multicast VPN  (MVPN)

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "ipv6-mvpn"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>ipv6-mvpn</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family ipv6 mvpn

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-ipv6-mvpn

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 L2VPN EVPN Address Family

Configuring an L2VPN EVPN Address Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "l2vpn-evpn"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list>
                  <type>l2vpn-evpn</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
address-family l2vpn evpn

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-l2vpn-evpn

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 an L2VPN EVPN Address Family

Deleting an L2VPN EVPN Address Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "l2vpn-evpn"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>l2vpn-evpn</type>
                </PeerAf-list>
              </af-items>
            </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
neighbor ethernet 1/2
no address-family l2vpn evpn

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/peerif-[eth1/2]
bgpPeerAf	sys/bgp/inst/dom-default/peerif-[eth1/2]/af-l2vpn-evpn

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

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 Bidirectional Fast Detection for the Neighbor

Configuring Bidirectional Fast Detection for the Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl>bfd</ctrl>
            </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
neighbor ethernet 1/2
bfd

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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 Bidirectional Fast Detection for the Neighbor

Deleting Bidirectional Fast Detection for the Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl></ctrl>
            </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
neighbor ethernet 1/2
no bfd

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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

Configuring an Excemption Behavior for Low Memory Situations

Configuring an Excemption Behavior for Low Memory Situations

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <lowMemExempt>enabled</lowMemExempt>
            </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
neighbor ethernet 1/2
low-memory exempt

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
lowMemExempt	bgp:AdminSt (scalar:Enum8)	Low Memory Exempt	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

Deleting an Excemption Behavior for Low Memory Situations

Deleting an Excemption Behavior for Low Memory Situations

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <lowMemExempt>disabled</lowMemExempt>
            </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
neighbor ethernet 1/2
no low-memory exempt

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
lowMemExempt	bgp:AdminSt (scalar:Enum8)	Low Memory Exempt	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 Peer-Session Inheritance

Configuring Peer-Session Inheritance

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <sessionContImp>SampleString_123</sessionContImp>
            </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
neighbor ethernet 1/2
inherit peer-session SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
sessionContImp	string:Basic	Peer Session 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-Session Inheritance

Deleting Peer-Session Inheritance

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <sessionContImp></sessionContImp>
            </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
neighbor ethernet 1/2
no inherit peer-session SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
sessionContImp	string:Basic	Peer Session 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 BMP Monitoring for a Peer

Configuring a BMP Monitoring for a Peer

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <bmpSrvId1St>enabled</bmpSrvId1St>
            </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
neighbor ethernet 1/2
bmp-activate-server 1

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
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 BMP Monitoring for a Peer

Deleting a BMP Monitoring for a Peer

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <bmpSrvId1St>disabled</bmpSrvId1St>
            </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
neighbor ethernet 1/2
no bmp-activate-server 1

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
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

Configuring an AS Number of a Neighbor

Configuring an AS Number of a Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</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

router bgp 100
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-default
bgpPeerIf	sys/bgp/inst/dom-default/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
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 an AS Number of a Neighbor

Deleting an AS Number of a Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <asn></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

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

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
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

Configuring a Connection Using Either the Local AS or the Real AS

Configuring a Connection Using Either the Local AS or the Real AS

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpLocalAsn": {
                            "attributes": {
                              "asnPropagate": "dual-as",
                              "localAsn": "123"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <localasn-items>
                <asnPropagate>dual-as</asnPropagate>
                <localAsn>123</localAsn>
              </localasn-items>
            </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
neighbor ethernet 1/2
local-as 123 no-prepend replace-as dual-as

Verifying a DME Configuration

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

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

bgpLocalAsn Properties

The following table contains information about the bgpLocalAsn 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
asnPropagate	bgp:AsnPropagation (scalar:Enum8)	ASN Propagation	SELECTION: 0 - none 1 - no-prepend 2 - replace-as 3 - dual-as DEFAULT: none
localAsn	bgp:AsnNum (string:Basic)	Local Autonomous System Number	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 Connection Using Either the Local AS or the Real AS

Deleting a Connection Using Either the Local AS or the Real AS

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <localasn-items nc:operation="delete">
              </localasn-items>
            </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
neighbor ethernet 1/2
no local-as 123 no-prepend replace-as dual-as

Verifying a DME Configuration

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

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

bgpLocalAsn Properties

Property Name	Data Type	Description	Values
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 a Neighbor-Specific Description

Configuring a Neighbor-Specific Description

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <name>SampleString_123</name>
            </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
neighbor ethernet 1/2
description SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
name	naming: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

Deleting a Neighbor-Specific Description

Deleting a Neighbor-Specific Description

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <name></name>
            </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
neighbor ethernet 1/2
no description SampleString_123

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
name	naming: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 the Administrative Shutdown of a Neighbor

Configuring the Administrative Shutdown of a Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <adminSt>disabled</adminSt>
            </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
neighbor ethernet 1/2
shutdown

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
adminSt	nw:AdminSt (scalar:Enum8)	Administrative State	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
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 the Administrative Shutdown of a Neighbor

Deleting the Administrative Shutdown of a Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <adminSt>enabled</adminSt>
            </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
neighbor ethernet 1/2
no shutdown

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
adminSt	nw:AdminSt (scalar:Enum8)	Administrative State	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
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

Configuring a Route Map to Modify Attributes for Outbound

Configuring a Route Map to Modify Attributes for Outbound

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpGs": {
                            "attributes": {
                              "gshutActivate": "yes",
                              "rtMap": "SampleString_123"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <gs-items>
                <gshutActivate>true</gshutActivate>
                <rtMap>SampleString_123</rtMap>
              </gs-items>
            </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
neighbor ethernet 1/2
graceful-shutdown activate route-map SampleString_123

Verifying a DME Configuration

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

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

bgpGs Properties

The following table contains information about the bgpGs 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
gshutActivate	scalar:Bool	Send graceful-shutdown community on all routes	SELECTION: true or false
rtMap	string:Basic	Route Map	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 Route Map to Modify Attributes for Outbound

Deleting a Route Map to Modify Attributes for Outbound

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2"
                      },
                      "children": [
                        {
                          "bgpGs": {
                            "attributes": {
                              "gshutActivate": "no",
                              "rtMap": ""
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <gs-items>
                <gshutActivate>false</gshutActivate>
                <rtMap></rtMap>
              </gs-items>
            </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
neighbor ethernet 1/2
no graceful-shutdown activate route-map SampleString_123

Verifying a DME Configuration

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

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

bgpGs Properties

Property Name	Data Type	Description	Values
gshutActivate	scalar:Bool	Send graceful-shutdown community on all routes	SELECTION: true or false
rtMap	string:Basic	Route Map	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 Nonnegotiable Capability with this Neighbor

Configuring Nonnegotiable Capability with this Neighbor

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "ctrl": "cap-neg-off",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl>cap-neg-off</ctrl>
            </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
neighbor ethernet 1/2
dont-capability-negotiate

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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 Nonnegotiable Capability with this Neighbor

Deleting Nonnegotiable Capability with this Neighbor

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl></ctrl>
            </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
neighbor ethernet 1/2
no dont-capability-negotiate

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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

Configuring Dynamic Capability

Configuring Dynamic Capability

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl></ctrl>
            </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
neighbor ethernet 1/2
dynamic-capability

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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 Dynamic Capability

Deleting Dynamic Capability

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "ctrl": "no-dyn-cap",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl>no-dyn-cap</ctrl>
            </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
neighbor ethernet 1/2
no dynamic-capability

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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

Configuring Private AS Number Removal from Outbound Updates (All)

Configuring Private AS Number Removal from Outbound Updates (All)

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "privateASctrl": "remove-all"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <privateASctrl>remove-all</privateASctrl>
            </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
neighbor ethernet 1/2
remove-private-as all

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
privateASctrl	bgp:PrivateASControl (scalar:Enum8)	Remove private AS number from outbound updates	SELECTION: 0 - none 1 - remove-exclusive 2 - remove-all 3 - replace-as 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

Deleting Private AS Number Removal from Outbound Updates (All)

Deleting Private AS Number Removal from Outbound Updates (All)

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <privateASctrl>none</privateASctrl>
            </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
neighbor ethernet 1/2
no remove-private-as all

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
privateASctrl	bgp:PrivateASControl (scalar:Enum8)	Remove private AS number from outbound updates	SELECTION: 0 - none 1 - remove-exclusive 2 - remove-all 3 - replace-as 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 Private AS Number Removal (Replace AS)

Configuring Private AS Number Removal (Replace AS)

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "privateASctrl": "replace-as"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <privateASctrl>replace-as</privateASctrl>
            </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
neighbor ethernet 1/2
remove-private-as replace-as

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
privateASctrl	bgp:PrivateASControl (scalar:Enum8)	Remove private AS number from outbound updates	SELECTION: 0 - none 1 - remove-exclusive 2 - remove-all 3 - replace-as 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

Deleting Private AS Number Removal (Replace AS)

Deleting Private AS Number Removal (Replace AS)

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <privateASctrl>none</privateASctrl>
            </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
neighbor ethernet 1/2
no remove-private-as replace-as

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
privateASctrl	bgp:PrivateASControl (scalar:Enum8)	Remove private AS number from outbound updates	SELECTION: 0 - none 1 - remove-exclusive 2 - remove-all 3 - replace-as 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 Disable Check for Directly Connected Peers

Configuring Disable Check for Directly Connected Peers

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "ctrl": "dis-conn-check",
                        "id": "eth1/2",
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl>dis-conn-check</ctrl>
            </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
neighbor ethernet 1/2
disable-connected-check

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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 Disable Check for Directly Connected Peers

Deleting Disable Check for Directly Connected Peers

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ctrl></ctrl>
            </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
neighbor ethernet 1/2
no disable-connected-check

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ctrl	bgp:PeerControl (scalar:Bitmask8)	Peer Controls	SELECTION: 1 - bfd 2 - dis-conn-check 4 - cap-neg-off 8 - no-dyn-cap
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

Configuring 4-Byte AS Capability Suppression

Configuring 4-Byte AS Capability Suppression

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <capSuppr4ByteAsn>enabled</capSuppr4ByteAsn>
            </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
neighbor ethernet 1/2
capability suppress 4-byte-as

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
capSuppr4ByteAsn	bgp:AdminSt (scalar:Enum8)	Capability Suppress 4-byte-as	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
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 4-Byte AS Capability Suppression

Deleting 4-Byte AS Capability Suppression

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <capSuppr4ByteAsn>disabled</capSuppr4ByteAsn>
            </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
neighbor ethernet 1/2
no capability suppress 4-byte-as

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
capSuppr4ByteAsn	bgp:AdminSt (scalar:Enum8)	Capability Suppress 4-byte-as	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
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

Configuring Hop Counts for a Remote Peer

Configuring Hop Counts for a Remote Peer

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ttlScrtyHops>91</ttlScrtyHops>
            </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
neighbor ethernet 1/2
ttl-security hops 91

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ttlScrtyHops	scalar:Uint16	Enable TTL Security Mechanism	RANGE: [0 , 254]

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 Hop Counts for a Remote Peer

Deleting Hop Counts for a Remote Peer

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <ttlScrtyHops>0</ttlScrtyHops>
            </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
neighbor ethernet 1/2
no ttl-security hops 91

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
ttlScrtyHops	scalar:Uint16	Enable TTL Security Mechanism	RANGE: [0 , 254]

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 Keepalive and Hold Timers

Deleting Keepalive and Hold Timers

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "holdIntvl": "180",
                        "id": "eth1/2",
                        "kaIntvl": "60"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <holdIntvl>180</holdIntvl>
              <kaIntvl>60</kaIntvl>
            </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
neighbor ethernet 1/2
no timers 1 1

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
holdIntvl	bgp:HoldIntvl (scalar:Uint16)	Hold Interval	RANGE: [3 , 3600] DEFAULT: 180
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
kaIntvl	bgp:KaIntvl (scalar:Uint16)	Keepalive Interval	RANGE: [0 , 3600] DEFAULT: 60

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 DSCP Value for Locally Originated Packets

Configuring the DSCP Value for Locally Originated Packets

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <dscp>1</dscp>
            </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
neighbor ethernet 1/2
dscp 1

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
dscp	bgp:BgpDscp (scalar:Enum8)	Specify DSCP value for Locally Originated packets	SELECTION: 0 - 0 1 - 1 2 - 2 3 - 3 4 - 4 5 - 5 6 - 6 7 - 7 8 - cs1 9 - 9 10 - af11 11 - 11 12 - af12 13 - 13 14 - af13 15 - 15 16 - cs2 17 - 17 18 - af21 19 - 19 20 - af22 21 - 21 22 - af23 23 - 23 24 - cs3 25 - 25 26 - af31 27 - 27 28 - af32 29 - 29 30 - af33 31 - 31 32 - cs4 33 - 33 34 - af41 35 - 35 36 - af42 37 - 37 38 - af43 39 - 39 40 - cs5 41 - 41 42 - 42 43 - 43 44 - 44 45 - 45 46 - ef 47 - 47 48 - cs6 49 - 49 50 - 50 51 - 51 52 - 52 53 - 53 54 - 54 55 - 55 56 - cs7 57 - 57 58 - 58 59 - 59 60 - 60 61 - 61 62 - 62 63 - 63 DEFAULT: cs6
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 the DSCP Value for Locally Originated Packets

Deleting the DSCP Value for Locally Originated Packets

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <dscp>cs6</dscp>
            </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
neighbor ethernet 1/2
no dscp 1

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
dscp	bgp:BgpDscp (scalar:Enum8)	Specify DSCP value for Locally Originated packets	SELECTION: 0 - 0 1 - 1 2 - 2 3 - 3 4 - 4 5 - 5 6 - 6 7 - 7 8 - cs1 9 - 9 10 - af11 11 - 11 12 - af12 13 - 13 14 - af13 15 - 15 16 - cs2 17 - 17 18 - af21 19 - 19 20 - af22 21 - 21 22 - af23 23 - 23 24 - cs3 25 - 25 26 - af31 27 - 27 28 - af32 29 - 29 30 - af33 31 - 31 32 - cs4 33 - 33 34 - af41 35 - 35 36 - af42 37 - 37 38 - af43 39 - 39 40 - cs5 41 - 41 42 - 42 43 - 43 44 - 44 45 - 45 46 - ef 47 - 47 48 - cs6 49 - 49 50 - 50 51 - 51 52 - 52 53 - 53 54 - 54 55 - 55 56 - cs7 57 - 57 58 - 58 59 - 59 60 - 60 61 - 61 62 - 62 63 - 63 DEFAULT: cs6
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

Configuring AF41 DSCP

Configuring AF41 DSCP

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <dscp>af41</dscp>
            </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
neighbor ethernet 1/2
dscp af41

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
dscp	bgp:BgpDscp (scalar:Enum8)	Specify DSCP value for Locally Originated packets	SELECTION: 0 - 0 1 - 1 2 - 2 3 - 3 4 - 4 5 - 5 6 - 6 7 - 7 8 - cs1 9 - 9 10 - af11 11 - 11 12 - af12 13 - 13 14 - af13 15 - 15 16 - cs2 17 - 17 18 - af21 19 - 19 20 - af22 21 - 21 22 - af23 23 - 23 24 - cs3 25 - 25 26 - af31 27 - 27 28 - af32 29 - 29 30 - af33 31 - 31 32 - cs4 33 - 33 34 - af41 35 - 35 36 - af42 37 - 37 38 - af43 39 - 39 40 - cs5 41 - 41 42 - 42 43 - 43 44 - 44 45 - 45 46 - ef 47 - 47 48 - cs6 49 - 49 50 - 50 51 - 51 52 - 52 53 - 53 54 - 54 55 - 55 56 - cs7 57 - 57 58 - 58 59 - 59 60 - 60 61 - 61 62 - 62 63 - 63 DEFAULT: cs6
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 AF41 DSCP

Deleting AF41 DSCP

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <dscp>cs6</dscp>
            </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
neighbor ethernet 1/2
no dscp af41

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
dscp	bgp:BgpDscp (scalar:Enum8)	Specify DSCP value for Locally Originated packets	SELECTION: 0 - 0 1 - 1 2 - 2 3 - 3 4 - 4 5 - 5 6 - 6 7 - 7 8 - cs1 9 - 9 10 - af11 11 - 11 12 - af12 13 - 13 14 - af13 15 - 15 16 - cs2 17 - 17 18 - af21 19 - 19 20 - af22 21 - 21 22 - af23 23 - 23 24 - cs3 25 - 25 26 - af31 27 - 27 28 - af32 29 - 29 30 - af33 31 - 31 32 - cs4 33 - 33 34 - af41 35 - 35 36 - af42 37 - 37 38 - af43 39 - 39 40 - cs5 41 - 41 42 - 42 43 - 43 44 - 44 45 - 45 46 - ef 47 - 47 48 - cs6 49 - 49 50 - 50 51 - 51 52 - 52 53 - 53 54 - 54 55 - 55 56 - cs7 57 - 57 58 - 58 59 - 59 60 - 60 61 - 61 62 - 62 63 - 63 DEFAULT: cs6
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

Configuring a Fabric Border Leaf

Configuring a Fabric Border Leaf

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerType": "fabric-border-leaf"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <peerType>fabric-border-leaf</peerType>
            </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
neighbor ethernet 1/2
peer-type fabric-border-leaf

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
peerType	bgp:PeerFabType (scalar:Enum8)	Neighbor Fabric Type	SELECTION: 0 - fabric-internal 1 - fabric-external 2 - fabric-border-leaf DEFAULT: fabric-internal

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 Fabric Border Leaf

Deleting a Fabric Border Leaf

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerType": "fabric-internal"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <peerType>fabric-internal</peerType>
            </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
neighbor ethernet 1/2
no peer-type fabric-border-leaf

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
peerType	bgp:PeerFabType (scalar:Enum8)	Neighbor Fabric Type	SELECTION: 0 - fabric-internal 1 - fabric-external 2 - fabric-border-leaf DEFAULT: fabric-internal

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 Fabric External

Configuring Fabric External

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerType": "fabric-external"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <peerType>fabric-external</peerType>
            </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
neighbor ethernet 1/2
peer-type fabric-external

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
peerType	bgp:PeerFabType (scalar:Enum8)	Neighbor Fabric Type	SELECTION: 0 - fabric-internal 1 - fabric-external 2 - fabric-border-leaf DEFAULT: fabric-internal

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 Fabric External

Deleting Fabric External

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeerIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "peerType": "fabric-internal"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <peerType>fabric-internal</peerType>
            </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
neighbor ethernet 1/2
no peer-type fabric-external

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
peerType	bgp:PeerFabType (scalar:Enum8)	Neighbor Fabric Type	SELECTION: 0 - fabric-internal 1 - fabric-external 2 - fabric-border-leaf DEFAULT: fabric-internal

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 Affinity Group Id

Configuring an Affinity Group Id

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <affGrp>1435</affGrp>
            </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
neighbor ethernet 1/2
affinity-group 1435

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
affGrp	scalar:Uint16	Affinity group for the neighbor.	RANGE: [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 an Affinity Group Id

Deleting an Affinity Group Id

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

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

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peerif-items>
            <PeerIf-list>
              <id>eth1/2</id>
              <affGrp>0</affGrp>
            </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
neighbor ethernet 1/2
no affinity-group 1435

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeerIf	sys/bgp/inst/dom-default/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
affGrp	scalar:Uint16	Affinity group for the neighbor.	RANGE: [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

Configuring a Link State Address Family

Configuring a Link State Address Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "lnkstate"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <af-items>
                <PeerAf-list>
                  <type>lnkstate</type>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-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
neighbor 1.2.3.4
address-family link-state

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeer	sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf	sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-lnkstate

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

bgpPeer Properties

The following table contains information about the bgpPeer 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
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format

bgpPeerAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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 Link State Address Family

Deleting a Link State Address Family

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

{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "status": "deleted",
                              "type": "lnkstate"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <af-items>
                <PeerAf-list nc:operation="delete">
                  <type>lnkstate</type>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-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
neighbor 1.2.3.4
no address-family link-state

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-default
bgpPeer	sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPeerAf	sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-lnkstate

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

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format

bgpPeerAf Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast

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