Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)

Configuring Peer Policy Inheritance

Configuring Peer Policy 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"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpPolicyInheritRule": {
                                  "attributes": {
                                    "name": "SampleString_123",
                                    "seq": "8688"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>SampleString_123</name>
                      <seq>8688</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </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

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
   address-family vpnv4 unicast
    inherit peer-policy SampleString_123 8688


Verifying a DME Configuration

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

MODN
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
bgpPolicyInheritRule sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pol-SampleString_123


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpPolicyInheritRule Properties

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

Property NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63
seqbgp:Order
(scalar:Uint16)
Sequence Number
RANGE: [1 , 65535]


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

Deleting Peer Policy 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"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpPolicyInheritRule": {
                                  "attributes": {
                                    "name": "SampleString_123",
                                    "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <pol-items>
                    <PolicyInheritRule-list nc:operation="delete">
                      <name>SampleString_123</name>
                    </PolicyInheritRule-list>
                  </pol-items>
                </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

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
   address-family vpnv4 unicast
    no inherit peer-policy SampleString_123 8688


Verifying a DME Configuration

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

MODN
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
bgpPolicyInheritRule sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pol-SampleString_123


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpPolicyInheritRule Properties

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

Property NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63
statusmo: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 As Path Acceptance with My AS Present In It

Configuring As Path Acceptance with My AS Present In It 
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": {
                              "allowedSelfAsCnt": "7",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <allowedSelfAsCnt>7</allowedSelfAsCnt>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    allowas-in 7


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
allowedSelfAsCntscalar:UByte
Allowed Self AS Count
RANGE: [0 , 10]
DEFAULT: 0
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 As Path Acceptance with My AS Present In It

Deleting As Path Acceptance with My AS Present In It 
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": {
                              "allowedSelfAsCnt": "0",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <allowedSelfAsCnt>0</allowedSelfAsCnt>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    no allowas-in 7


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
allowedSelfAsCntscalar:UByte
Allowed Self AS Count
RANGE: [0 , 10]
DEFAULT: 0
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Send Standard and Extended Community Attributes

Configuring to Send Standard and Extended Community Attributes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "sendComExt": "enabled",
                              "sendComStd": "enabled",
                              "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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <sendComExt>enabled</sendComExt>
                  <sendComStd>enabled</sendComStd>
                </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

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
   address-family vpnv4 unicast
    send-community both


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
sendComExtbgp:AdminSt
(scalar:Enum8)
Send-community extendedSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
sendComStdbgp:AdminSt
(scalar:Enum8)
Send-community standardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Send Standard and Extended Community Attributes

Deleting to Send Standard and Extended Community Attributes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "sendComExt": "disabled",
                              "sendComStd": "disabled",
                              "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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <sendComExt>disabled</sendComExt>
                  <sendComStd>disabled</sendComStd>
                </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

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
   address-family vpnv4 unicast
    no send-community both


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
sendComExtbgp:AdminSt
(scalar:Enum8)
Send-community extendedSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
sendComStdbgp:AdminSt
(scalar:Enum8)
Send-community standardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Send Standard Community Attributes

Configuring to Send Standard Community Attributes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "sendComStd": "enabled",
                              "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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <sendComStd>enabled</sendComStd>
                </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

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
   address-family vpnv4 unicast
    send-community standard


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
sendComStdbgp:AdminSt
(scalar:Enum8)
Send-community standardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Send Standard Community Attributes

Deleting to Send Standard Community Attributes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "sendComStd": "disabled",
                              "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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <sendComStd>disabled</sendComStd>
                </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

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
   address-family vpnv4 unicast
    no send-community standard


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
sendComStdbgp:AdminSt
(scalar:Enum8)
Send-community standardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 the Extended Community Attribute

Configuring the Extended Community Attribute
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "sendComExt": "enabled",
                              "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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <sendComExt>enabled</sendComExt>
                </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

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
   address-family vpnv4 unicast
    send-community extended


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
sendComExtbgp:AdminSt
(scalar:Enum8)
Send-community extendedSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 the Extended Community Attribute

Deleting the Extended Community Attribute
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "sendComExt": "disabled",
                              "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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <sendComExt>disabled</sendComExt>
                </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

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
   address-family vpnv4 unicast
    no send-community extended


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
sendComExtbgp:AdminSt
(scalar:Enum8)
Send-community extendedSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 Neighbor as Route-Reflector Client

Configuring a Neighbor as Route-Reflector Client
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": {
                              "ctrl": "rr-client",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <ctrl>rr-client</ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    route-reflector-client


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
ctrlbgp:PeerAfControl
(scalar:Bitmask16)
Peer address-family controlSELECTION:
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - allow-self-as
64 - default-originate
128 - advertisement-interval
256 - suppress-inactive
512 - nh-self-all
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 Neighbor as Route-Reflector Client

Deleting a Neighbor as Route-Reflector Client
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": {
                              "ctrl": "",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <ctrl></ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    no route-reflector-client


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
ctrlbgp:PeerAfControl
(scalar:Bitmask16)
Peer address-family controlSELECTION:
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - allow-self-as
64 - default-originate
128 - advertisement-interval
256 - suppress-inactive
512 - nh-self-all
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 the Default Weight for Routes from a Neighbor

Configuring the Default Weight for Routes from 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"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast",
                              "wght": "155"
}}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <wght>155</wght>
                </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

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
   address-family vpnv4 unicast
    weight 155


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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
wghtstring:Basic
Weight for the 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 the Default Weight for Routes from a Neighbor

Deleting the Default Weight for Routes from 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"
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast",
                              "wght": ""
}}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <wght></wght>
                </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

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
   address-family vpnv4 unicast
    no weight 155


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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
wghtstring:Basic
Weight for the 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 Policy Application to Incoming Routes

Configuring Policy Application to Incoming Routes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpPfxCtrlP": {
                                  "attributes": {
                                    "direction": "in",
                                    "list": "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list>
                      <direction>in</direction>
                      <list>SampleString_123</list>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </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

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
   address-family vpnv4 unicast
    prefix-list SampleString_123 in


Verifying a DME Configuration

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

MODN
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
bgpPfxCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-in


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpPfxCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA 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 Policy Application to Incoming Routes

Deleting Policy Application to Incoming Routes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpPfxCtrlP": {
                                  "attributes": {
                                    "direction": "in",
                                    "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list nc:operation="delete">
                      <direction>in</direction>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </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

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
   address-family vpnv4 unicast
    no prefix-list SampleString_123 in


Verifying a DME Configuration

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

MODN
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
bgpPfxCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-in


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpPfxCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
statusmo: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 Policy Application (Prefix List)

Configuring Policy Application (Prefix List)
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpPfxCtrlP": {
                                  "attributes": {
                                    "direction": "out",
                                    "list": "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list>
                      <direction>out</direction>
                      <list>SampleString_123</list>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </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

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
   address-family vpnv4 unicast
    prefix-list SampleString_123 out


Verifying a DME Configuration

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

MODN
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
bgpPfxCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-out


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpPfxCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA 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 Policy Application (Prefix List)

Deleting Policy Application (Prefix List)
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpPfxCtrlP": {
                                  "attributes": {
                                    "direction": "out",
                                    "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list nc:operation="delete">
                      <direction>out</direction>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </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

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
   address-family vpnv4 unicast
    no prefix-list SampleString_123 out


Verifying a DME Configuration

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

MODN
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
bgpPfxCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-out


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpPfxCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
statusmo: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 Policy Application to Incoming Routes

Configuring a Policy Application to Incoming Routes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpFltrCtrlP": {
                                  "attributes": {
                                    "direction": "in",
                                    "list": "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list>
                      <direction>in</direction>
                      <list>SampleString_123</list>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </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

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
   address-family vpnv4 unicast
    filter-list SampleString_123 in


Verifying a DME Configuration

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

MODN
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
bgpFltrCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-in


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpFltrCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA 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 Policy Application to Incoming Routes

Deleting a Policy Application to Incoming Routes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpFltrCtrlP": {
                                  "attributes": {
                                    "direction": "in",
                                    "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list nc:operation="delete">
                      <direction>in</direction>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </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

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
   address-family vpnv4 unicast
    no filter-list SampleString_123 in


Verifying a DME Configuration

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

MODN
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
bgpFltrCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-in


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpFltrCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
statusmo: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 Policy Application (Filter List)

Configuring Policy Application (Filter List)
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpFltrCtrlP": {
                                  "attributes": {
                                    "direction": "out",
                                    "list": "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list>
                      <direction>out</direction>
                      <list>SampleString_123</list>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </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

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
   address-family vpnv4 unicast
    filter-list SampleString_123 out


Verifying a DME Configuration

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

MODN
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
bgpFltrCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-out


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpFltrCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA 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 Policy Application (Filter List)

Deleting Policy Application (Filter List)
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpFltrCtrlP": {
                                  "attributes": {
                                    "direction": "out",
                                    "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list nc:operation="delete">
                      <direction>out</direction>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </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

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
   address-family vpnv4 unicast
    no filter-list SampleString_123 out


Verifying a DME Configuration

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

MODN
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
bgpFltrCtrlP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-out


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpFltrCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
statusmo: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 BGP Connection Restart After a Limit is Exceeded

Configuring BGP Connection Restart After a Limit is Exceeded 
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpMaxPfxP": {
                                  "attributes": {
                                    "action": "restart",
                                    "maxPfx": "1",
                                    "restartTime": "27129",
                                    "thresh": "4"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <maxpfxp-items>
                    <action>restart</action>
                    <maxPfx>1</maxPfx>
                    <restartTime>27129</restartTime>
                    <thresh>4</thresh>
                  </maxpfxp-items>
                </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

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
   address-family vpnv4 unicast
    maximum-prefix 1 4 restart 27129


Verifying a DME Configuration

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

MODN
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
bgpMaxPfxP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpMaxPfxP Properties

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

Property NameData TypeDescriptionValues
actionbgp:MaxPfxAct
(scalar:Enum8)
Action to do when limit is exceededSELECTION:
1 - log
2 - shut
3 - restart
DEFAULT: shut
maxPfxbgp:MaxPfx
(scalar:Uint32)
Maximum number of prefixes allowed from the peer.RANGE: [0, 4294967295]
restartTimebgp:MaxPfxDuration
(scalar:Uint16)
The period of time in minutes before restarting the peer when the prefix limit is reached.
RANGE: [0 , 0xffff]
threshbgp:MaxPfxThresh
(scalar:UByte)
The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
RANGE: [0 , 100]


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 BGP Connection Restart After a Limit is Exceeded

Deleting BGP Connection Restart After a Limit is Exceeded 
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpMaxPfxP": {
                                  "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <maxpfxp-items nc:operation="delete">
                  </maxpfxp-items>
                </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

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
   address-family vpnv4 unicast
    no maximum-prefix 1 4 restart 27129


Verifying a DME Configuration

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

MODN
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
bgpMaxPfxP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpMaxPfxP Properties

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

Property NameData TypeDescriptionValues
statusmo: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 Warning Message When a Limit is Exceeded

Configuring a Warning Message When a Limit is Exceeded
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpMaxPfxP": {
                                  "attributes": {
                                    "action": "log",
                                    "maxPfx": "1",
                                    "restartTime": "0",
                                    "thresh": "4"
}}}]}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <maxpfxp-items>
                    <action>log</action>
                    <maxPfx>1</maxPfx>
                    <restartTime>0</restartTime>
                    <thresh>4</thresh>
                  </maxpfxp-items>
                </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

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
   address-family vpnv4 unicast
    maximum-prefix 1 4 warning-only


Verifying a DME Configuration

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

MODN
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
bgpMaxPfxP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpMaxPfxP Properties

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

Property NameData TypeDescriptionValues
actionbgp:MaxPfxAct
(scalar:Enum8)
Action to do when limit is exceededSELECTION:
1 - log
2 - shut
3 - restart
DEFAULT: shut
maxPfxbgp:MaxPfx
(scalar:Uint32)
Maximum number of prefixes allowed from the peer.RANGE: [0, 4294967295]
restartTimebgp:MaxPfxDuration
(scalar:Uint16)
The period of time in minutes before restarting the peer when the prefix limit is reached.
RANGE: [0 , 0xffff]
threshbgp:MaxPfxThresh
(scalar:UByte)
The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%).
RANGE: [0 , 100]


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 Warning Message When a Limit is Exceeded

Deleting a Warning Message When a Limit is Exceeded
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast"
                            },
                            "children": [
                              {
                                "bgpMaxPfxP": {
                                  "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <maxpfxp-items nc:operation="delete">
                  </maxpfxp-items>
                </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

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
   address-family vpnv4 unicast
    no maximum-prefix 1 4 warning-only


Verifying a DME Configuration

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

MODN
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
bgpMaxPfxP sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp


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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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


bgpMaxPfxP Properties

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

Property NameData TypeDescriptionValues
statusmo: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 the Minimum Interval Between Sending BGP Routing Updates

Configuring the Minimum Interval Between Sending BGP Routing Updates 
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": {
                              "advIntvl": "219",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <advIntvl>219</advIntvl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    advertisement-interval 219


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
advIntvlbgp:AdvInterval
(scalar:Uint16)
Neighbor advertisement interval
RANGE: [0 , 600]
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 the Minimum Interval Between Sending BGP Routing Updates

Deleting the Minimum Interval Between Sending BGP Routing Updates 
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": {
                              "advIntvl": "0",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <advIntvl>0</advIntvl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    no advertisement-interval 219


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
advIntvlbgp:AdvInterval
(scalar:Uint16)
Neighbor advertisement interval
RANGE: [0 , 600]
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 Our Address as Nexthop for All Routes

Configuring Our Address as Nexthop for All Routes
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": {
                              "ctrl": "",
                              "inheritContPeerPolicyCtrl": "",
                              "nhSelfAll": "yes",
                              "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>
                  <ctrl></ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <nhSelfAll>true</nhSelfAll>
                </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

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
   address-family vpnv4 unicast
    next-hop-self all


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
ctrlbgp:PeerAfControl
(scalar:Bitmask16)
Peer address-family controlSELECTION:
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - allow-self-as
64 - default-originate
128 - advertisement-interval
256 - suppress-inactive
512 - nh-self-all
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
nhSelfAllscalar:Bool
Set address as next-hop for all routesSELECTION: true or false
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 Our Address as Nexthop for All Routes

Deleting Our Address as Nexthop for All Routes
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": {
                              "ctrl": "",
                              "inheritContPeerPolicyCtrl": "",
                              "nhSelfAll": "no",
                              "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>
                  <ctrl></ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <nhSelfAll>false</nhSelfAll>
                </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

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
   address-family vpnv4 unicast
    no next-hop-self all


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
ctrlbgp:PeerAfControl
(scalar:Bitmask16)
Peer address-family controlSELECTION:
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - allow-self-as
64 - default-originate
128 - advertisement-interval
256 - suppress-inactive
512 - nh-self-all
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
nhSelfAllscalar:Bool
Set address as next-hop for all routesSELECTION: true or false
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Not Advertise Additional Paths (Send Capability)

Configuring to Not Advertise Additional Paths (Send Capability)
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": {
                              "capAddlPaths": "send-disable",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <capAddlPaths>send-disable</capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    capability additional-paths send disable


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Not Advertise Additional Paths (Send Capability)

Deleting to Not Advertise Additional Paths (Send Capability)
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": {
                              "capAddlPaths": "",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <capAddlPaths></capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    no capability additional-paths send disable


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Not Advertise Additional Paths (Receive Capability)

Configuring to Not Advertise Additional Paths (Receive Capability)
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": {
                              "capAddlPaths": "recv-disable",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <capAddlPaths>recv-disable</capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    capability additional-paths receive disable


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 to Not Advertise Additional Paths (Receive Capability)

Deleting to Not Advertise Additional Paths (Receive Capability)
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": {
                              "capAddlPaths": "",
                              "inheritContPeerPolicyCtrl": "",
                              "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>
                  <capAddlPaths></capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </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

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
   address-family vpnv4 unicast
    no capability additional-paths receive disable


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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 Route Map to Selectively Unsuppress Suppressed Routes

Configuring a Route Map to Selectively Unsuppress Suppressed Routes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast",
                              "unSupprMap": "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>
              <af-items>
                <PeerAf-list>
                  <type>vpnv4-ucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <unSupprMap>SampleString_123</unSupprMap>
                </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

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
   address-family vpnv4 unicast
    unsuppress-map SampleString_123


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA 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 Selectively Unsuppress Suppressed Routes

Deleting a Route Map to Selectively Unsuppress Suppressed Routes
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": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "vpnv4-ucast",
                              "unSupprMap": ""
}}}]}}]}}]}}]}}
{
    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>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <unSupprMap></unSupprMap>
                </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

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
   address-family vpnv4 unicast
    no unsuppress-map SampleString_123


Verifying a DME Configuration

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

MODN
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

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 NameData TypeDescriptionValues
asnbgp:AsnNum
(string:Basic)
Autonomous system numberA 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 NameData TypeDescriptionValues
namenaming: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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
Interface identifier of the neighborMust 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 NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
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
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA 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