Configuring a BGP Neighbor (IP Address)

This section uses examples to demonstrate many of the BGP configuration options and to show how the REST APIs correspond to the CLI commands.

Configuring a BGP Neighbor

Configuring a BGP Neighbor                   
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


Related Documentation

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

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

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

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

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

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

Deleting a BGP Peer

Deleting a BGP Peer
DELETE http://<mgmt0_IP>/api/mo/sys/bgp/inst/dom-default.json
{
 "bgpDom": {
   "attributes": {
     "name": "default"
   },
   "children": [
     {
       "bgpPeer": {
         "attributes": {
           "addr": "1.1.1.1",
           "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list xc:operation="delete">
              <addr>1.1.1.1</addr>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Deletes a BGP peer.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 no neighbor 1.1.1.1

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


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

MODN
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
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

Inheriting a Peer Policy Template

Inheriting a Peer Policy Template               
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": "",
                 "peerImp": "20.1.1.2"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <peerImp>20.1.1.2</peerImp>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  inherit peer 20.1.1.2

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth
peerImpstring:Basic
Peer Template To Import FromA 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 the Autonomous System Number of the Neighbor

Configuring the Autonomous System Number of the Neighbor                     
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "asn": "200",
                 "inheritContPeerCtrl": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <asn>200</asn>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  remote-as 200

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
asnstring:Basic
Autonomous System Number, takes value from (1-4294967295 \ 1-65535[.(0-65535)])
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


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 Log Message for Neighbor Up/Down Events

Configuring a Log Message for Neighbor Up/Down Events             
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": "",
                 "logNbrChgs": "enable"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <logNbrChgs>enable</logNbrChgs>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Logs a message for a neighbor up/down events.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  log-neighbor-changes

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth
logNbrChgsbgp:LogNbrSt
(scalar:Enum8)
Log messages for Neighbor up/down eventsSELECTION:
0 - none
1 - enable
2 - disable
DEFAULT: none


Related Documentation

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

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

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

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

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

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

Configuring the Local-as Number for the eBGP Neighbor

Configuring the Local-as Number for the eBGP Neighbor                     
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": ""
               },
               "children": [
                 {
                   "bgpLocalAsn": {
                     "attributes": {
                       "asnPropagate": "none",
                       "localAsn": "100"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <localasn-items>
                <asnPropagate>none</asnPropagate>
                <localAsn>100</localAsn>
              </localasn-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures the local-as.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  local-as 100

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpLocalAsn sys/bgp/inst/dom-{name}/peerif-{[id]}/localasn


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpLocalAsn Properties

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

Property NameData TypeDescriptionValues
asnPropagatebgp:AsnPropagation
(scalar:Enum8)
ASN PropagationSELECTION:
0 - none
1 - no-prepend
2 - replace-as
3 - dual-as
DEFAULT: none
localAsnbgp:AsnNum
(string:Basic)
Local Autonomous System NumberA 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

Creating a Neighbor-Specific Description

Creating a Neighbor-Specific Description            
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": ""
               },
               "children": [
                 {
                   "bgpLocalAsn": {
                     "attributes": {
                       "asnPropagate": "none",
                       "localAsn": "100"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <name>nx-oc-bgp</name>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Adds a description to a specified neighbor.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  description nx-oc-bgp

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpLocalAsn sys/bgp/inst/dom-{name}/peerif-{[id]}/localasn


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


bgpLocalAsn Properties

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

Property NameData TypeDescriptionValues
asnPropagatebgp:AsnPropagation
(scalar:Enum8)
ASN PropagationSELECTION:
0 - none
1 - no-prepend
2 - replace-as
3 - dual-as
DEFAULT: none
localAsnbgp:AsnNum
(string:Basic)
Local Autonomous System NumberA 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

Removing a Private AS Number from Outbound Updates

Removing a Private AS Number from Outbound Updates     
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": "",
                 "privateASctrl": "replace-as"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <privateASctrl>replace-as</privateASctrl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Replaces all private AS numbers with the replace-as AS-path value.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  remove-private-as replace-as

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth
privateASctrlbgp:PrivateASControl
(scalar:Enum8)
Remove private AS number from outbound updatesSELECTION:
0 - none
1 - remove-exclusive
2 - remove-all
3 - replace-as
DEFAULT: none


Related Documentation

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

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

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

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

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

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

Configuring Multihop TTL for a Remote Peer

Configuring Multihop TTL for a Remote Peer                      
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "inheritContPeerCtrl": "",
                 "ttl": "2"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <ttl>2</ttl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures a multihop TTL for a remote peer.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  ebgp-multihop 2

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth
ttlbgp:TtlVal
(scalar:Uint16)
eBGP Multihop TTL value
RANGE: [0 , 255]


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 BGP Transport Connection as Passive Only

Configuring the BGP Transport Connection as Passive Only   
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "connMode": "passive",
                 "inheritContPeerCtrl": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <connMode>passive</connMode>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Allows a passive connection setup only.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  transport connection-mode passive

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
connModebgp:ConnMode
(scalar:Bitmask8)
BGP transport connection modeSELECTION:
1 - passive
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth


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

Configuring the Keepalive and Hold Timers                       
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeer": {
               "attributes": {
                 "addr": "20.1.1.1",
                 "holdIntvl": "90",
                 "inheritContPeerCtrl": "",
                 "kaIntvl": "70"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>20.1.1.1</addr>
              <holdIntvl>90</holdIntvl>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <kaIntvl>70</kaIntvl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Adds the keepalive and hold time BGP timer values for the neighbor. The range is from 0 to 3600 seconds. The default is 60 seconds for the keepalive time and 180 seconds for the hold time.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
 neighbor 20.1.1.1
  timers 70 90

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
holdIntvlbgp:HoldIntvl
(scalar:Uint16)
Hold Interval
RANGE: [3 , 3600]
DEFAULT: 180
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth
kaIntvlbgp:KaIntvl
(scalar:Uint16)
Keepalive Interval
RANGE: [0 , 3600]
DEFAULT: 60


Related Documentation

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

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

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

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

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

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

Configuring a Fabric Border Leaf for a Neighbor

Configuring a Fabric Border Leaf for a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "inheritContPeerCtrl": "",
                  "peerType": "fabric-border-leaf"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <peerType>fabric-border-leaf</peerType>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configures a fabric border leaf for a neighbor


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 1.2.3.4
  peer-type fabric-border-leaf

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


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

MODN
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
4398046511104 - mhop-intvl
8796093022208 - mhop-auth
peerTypebgp:PeerFabType
(scalar:Enum8)
Neighbor Fabric TypeSELECTION:
0 - fabric-internal
1 - fabric-external
2 - fabric-border-leaf
DEFAULT: fabric-internal


Related Documentation

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

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

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

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

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

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

Configuring Path Attribute Filtering on Inbound Updates

Configuring Path Attribute Filtering on Inbound Updates
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "discard"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "200",
                                    "inheritFltrAttrCtrl": "enabled",
                                    "startVal": "100"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>100</startVal>
                      <endVal>200</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   path-attribute discard range 100 200 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard/dir-in-start-100-end-200


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


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 Path Attribute Filtering on Inbound Updates

Deleting Path Attribute Filtering on Inbound Updates
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "discard"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "200",
                                    "startVal": "100",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list nc:operation="delete">
                      <direction>in</direction>
                      <startVal>100</startVal>
                      <endVal>200</endVal>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   no path-attribute discard range 100 200 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard/dir-in-start-100-end-200


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
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 Withdrawing Routes for Matching Path Attributes from a Neighbor

Configuring Withdrawing Routes for Matching Path Attributes from a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "treataswithdraw"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "200",
                                    "inheritFltrAttrCtrl": "enabled",
                                    "startVal": "100"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>treataswithdraw</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>100</startVal>
                      <endVal>200</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   path-attribute treat-as-withdraw range 100 200 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw/dir-in-start-100-end-200


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


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 Withdrawing Routes for Matching Path Attributes from a Neighbor

Deleting Withdrawing Routes for Matching Path Attributes from a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "treataswithdraw"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "200",
                                    "startVal": "100",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>treataswithdraw</fltrType>
                  <dir-items>
                    <FltrAttr-list nc:operation="delete">
                      <direction>in</direction>
                      <startVal>100</startVal>
                      <endVal>200</endVal>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   no path-attribute treat-as-withdraw range 100 200 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw/dir-in-start-100-end-200


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
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

Discarding a Matching Path-Attribute from a Neighbor

Discarding a Matching Path-Attribute from a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "discard"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "None",
                                    "inheritFltrAttrCtrl": "enabled",
                                    "startVal": "120"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>120</startVal>
                      <endVal>0</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   path-attribute discard 120 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard/dir-in-start-120-end-None


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


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

Unconfiguring the Discarding of a Matching Path-Attribute from a Neighbor

Unconfiguring the Discarding of a Matching Path-Attribute from a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "discard"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "None",
                                    "startVal": "120",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list nc:operation="delete">
                      <direction>in</direction>
                      <startVal>120</startVal>
                      <endVal>0</endVal>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   no path-attribute discard 120 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard/dir-in-start-120-end-None


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
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

Withdrawing Routes for Matching Path-Attribute from a Neighbor

Withdrawing Routes for Matching Path-Attribute from a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "treataswithdraw"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "None",
                                    "inheritFltrAttrCtrl": "enabled",
                                    "startVal": "120"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>treataswithdraw</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>120</startVal>
                      <endVal>0</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   path-attribute treat-as-withdraw 120 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw/dir-in-start-120-end-None


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


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

Unconfiguring the Withdrawing of Routes for Matching Path-Attribute from a Neighbor

Unconfiguring the Withdrawing of Routes for Matching Path-Attribute from a Neighbor
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "100"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPathAttr": {
                            "attributes": {
                              "fltrType": "treataswithdraw"
                            },
                            "children": [
                              {
                                "bgpFltrAttr": {
                                  "attributes": {
                                    "direction": "in",
                                    "endVal": "None",
                                    "startVal": "120",
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>treataswithdraw</fltrType>
                  <dir-items>
                    <FltrAttr-list nc:operation="delete">
                      <direction>in</direction>
                      <startVal>120</startVal>
                      <endVal>0</endVal>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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


CLI Commands

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 1.2.3.4
   no path-attribute treat-as-withdraw 120 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
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-treataswithdraw/dir-in-start-120-end-None


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.
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 Path Attribute Filtering on Inbound Updates (Inherited from a Peer)

Configuring Path Attribute Filtering on Inbound Updates (Inherited from a Peer)
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "100"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": "",
                              "peerImp": "P1"
                            },
                            "children": [
                              {
                                "bgpPathAttr": {
                                  "attributes": {
                                    "fltrType": "discard"
                                  },
                                  "children": [
                                    {
                                      "bgpFltrAttr": {
                                        "attributes": {
                                          "direction": "in",
                                          "endVal": "None",
                                          "inheritFltrAttrCtrl": "enabled",
                                          "startVal": "99"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPeerCont": {
                            "attributes": {
                              "inheritContPeerCtrl": "",
                              "name": "PT_1"
                            },
                            "children": [
                              {
                                "bgpPathAttr": {
                                  "attributes": {
                                    "fltrType": "discard"
                                  },
                                  "children": [
                                    {
                                      "bgpFltrAttr": {
                                        "attributes": {
                                          "direction": "in",
                                          "endVal": "None",
                                          "inheritFltrAttrCtrl": "enabled",
                                          "startVal": "99"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <peerImp>P1</peerImp>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>99</startVal>
                      <endVal>0</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
          <peercont-items>
            <PeerCont-list>
              <name>PT_1</name>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>99</startVal>
                      <endVal>0</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </PeerCont-list>
          </peercont-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
  template peer PT_1
   path-attribute discard 99 in
    neighbor 1.2.3.4
     inherit peer P1
      path-attribute discard 99 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
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard/dir-in-start-99-end-None
bgpPeerCont sys/bgp/inst/dom-default/peercont-PT_1
bgpPathAttr sys/bgp/inst/dom-default/peercont-PT_1/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peercont-PT_1/pathattr-discard/dir-in-start-99-end-None


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
peerImpstring:Basic
Peer Template To Import FromA sequence of characters


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesSELECTION:
0 - None
1 - BGP_ORIGIN
2 - BGP_AS_PATH
3 - BGP_NEXT_HOP
4 - BGP_MED
5 - BGP_LOCALPREF
6 - BGP_ATOMIC_AGG
7 - BGP_AGGREGATOR
8 - BGP_COMMUNITY
9 - BGP_ORIGINATOR
10 - BGP_CLUSTERLIST
11 - 11
12 - 12
13 - 13
14 - BGP_MP_REACH
15 - BGP_MP_UNREACH
16 - BGP_EXTCOMMUNITY
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


bgpPeerCont Properties

The following table contains information about the bgpPeerCont 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
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesSELECTION:
0 - None
1 - BGP_ORIGIN
2 - BGP_AS_PATH
3 - BGP_NEXT_HOP
4 - BGP_MED
5 - BGP_LOCALPREF
6 - BGP_ATOMIC_AGG
7 - BGP_AGGREGATOR
8 - BGP_COMMUNITY
9 - BGP_ORIGINATOR
10 - BGP_CLUSTERLIST
11 - 11
12 - 12
13 - 13
14 - BGP_MP_REACH
15 - BGP_MP_UNREACH
16 - BGP_EXTCOMMUNITY
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


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 Path Attribute Filtering on Inbound Updates (Inherited from a Peer)

Deleting Path Attribute Filtering on Inbound Updates (Inherited from a Peer)
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "100"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": "",
                              "peerImp": "P1"
                            },
                            "children": [
                              {
                                "bgpPathAttr": {
                                  "attributes": {
                                    "fltrType": "discard"
                                  },
                                  "children": [
                                    {
                                      "bgpFltrAttr": {
                                        "attributes": {
                                          "direction": "in",
                                          "endVal": "None",
                                          "inheritFltrAttrCtrl": "disabled",
                                          "startVal": "99"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPeerCont": {
                            "attributes": {
                              "inheritContPeerCtrl": "",
                              "name": "PT_1"
                            },
                            "children": [
                              {
                                "bgpPathAttr": {
                                  "attributes": {
                                    "fltrType": "discard"
                                  },
                                  "children": [
                                    {
                                      "bgpFltrAttr": {
                                        "attributes": {
                                          "direction": "in",
                                          "endVal": "None",
                                          "inheritFltrAttrCtrl": "enabled",
                                          "startVal": "99"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <peerImp>P1</peerImp>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>99</startVal>
                      <endVal>0</endVal>
                      <inheritFltrAttrCtrl>disabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </Peer-list>
          </peer-items>
          <peercont-items>
            <PeerCont-list>
              <name>PT_1</name>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <pathattr-items>
                <PathAttr-list>
                  <fltrType>discard</fltrType>
                  <dir-items>
                    <FltrAttr-list>
                      <direction>in</direction>
                      <startVal>99</startVal>
                      <endVal>0</endVal>
                      <inheritFltrAttrCtrl>enabled</inheritFltrAttrCtrl>
                    </FltrAttr-list>
                  </dir-items>
                </PathAttr-list>
              </pathattr-items>
            </PeerCont-list>
          </peercont-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
  template peer PT_1
   path-attribute discard 99 in
    neighbor 1.2.3.4
     inherit peer P1
      no path-attribute discard 99 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
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-default
bgpPeer sys/bgp/inst/dom-default/peer-[1.2.3.4]
bgpPathAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peer-[1.2.3.4]/pathattr-discard/dir-in-start-99-end-None
bgpPeerCont sys/bgp/inst/dom-default/peercont-PT_1
bgpPathAttr sys/bgp/inst/dom-default/peercont-PT_1/pathattr-discard
bgpFltrAttr sys/bgp/inst/dom-default/peercont-PT_1/pathattr-discard/dir-in-start-99-end-None


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


bgpPeer Properties

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

Property NameData TypeDescriptionValues
addraddress:Ip
Peer addressValue must match ipv4 or ipv6 known format
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
peerImpstring:Basic
Peer Template To Import FromA sequence of characters


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesSELECTION:
0 - None
1 - BGP_ORIGIN
2 - BGP_AS_PATH
3 - BGP_NEXT_HOP
4 - BGP_MED
5 - BGP_LOCALPREF
6 - BGP_ATOMIC_AGG
7 - BGP_AGGREGATOR
8 - BGP_COMMUNITY
9 - BGP_ORIGINATOR
10 - BGP_CLUSTERLIST
11 - 11
12 - 12
13 - 13
14 - BGP_MP_REACH
15 - BGP_MP_UNREACH
16 - BGP_EXTCOMMUNITY
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


bgpPeerCont Properties

The following table contains information about the bgpPeerCont 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
inheritContPeerCtrlbgp:InheritContPeerCtrlType
(scalar:Bitmask64)
Inherit control of peer parametersSELECTION:
1 - shutdown
2 - remote-as
4 - conn-mode
8 - bfd
16 - dis-conn-check
32 - cap-neg-off
64 - description
128 - timer
256 - password
512 - source-interface
1024 - ttl
2048 - ipv4-ucast
4096 - ipv4-mcast
8192 - epe
16384 - ipv6-ucast
32768 - ipv6-mcast
65536 - no-dyn-cap
131072 - local-as
262144 - remove-private-as
524288 - ipv4-lucast
1048576 - ipv6-lucast
2097152 - lnkstate
4194304 - log-nbr-chgs
8388608 - peer-type
16777216 - ipv4-mvpn
33554432 - ipv6-mvpn
67108864 - low-memory-exempt
134217728 - cap-suppr-4-byte-as
268435456 - l2vpn-evpn
536870912 - aff-grp
2147483648 - vpnv4-ucast
8589934592 - vpnv6-ucast
34359738368 - security-hops
137438953472 - bmp-activate-server-1
274877906944 - bmp-activate-server-2
549755813888 - dscp
1099511627776 - gshut-activate
2199023255552 - ipv4-mdt
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


bgpPathAttr Properties

The following table contains information about the bgpPathAttr 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
fltrTypebgp:AttrFltrType
(scalar:Enum8)
Specify type of action performed on the filtered BGP Update MessageSELECTION:
0 - treataswithdraw
1 - discard


bgpFltrAttr Properties

The following table contains information about the bgpFltrAttr 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:AttrFltrDir
(scalar:Enum8)
Specify the filter direction of the BGP Update messagesSELECTION:
1 - in
2 - out
DEFAULT: in
endValbgp:AttrTypes
(scalar:Uint16)
Specify the end of the range of attributesSELECTION:
0 - None
1 - BGP_ORIGIN
2 - BGP_AS_PATH
3 - BGP_NEXT_HOP
4 - BGP_MED
5 - BGP_LOCALPREF
6 - BGP_ATOMIC_AGG
7 - BGP_AGGREGATOR
8 - BGP_COMMUNITY
9 - BGP_ORIGINATOR
10 - BGP_CLUSTERLIST
11 - 11
12 - 12
13 - 13
14 - BGP_MP_REACH
15 - BGP_MP_UNREACH
16 - BGP_EXTCOMMUNITY
inheritFltrAttrCtrlbgp:FltrSt
(nw:AdminSt)
Specify the State of the filter. Whether its enabled or disabled. A Filter can only be disabled when peer inheritsSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
startValbgp:AttrTypes
(scalar:Uint16)
Specify the start of the range of attributesRANGE: 1-255
Attributes 1-5, 8, 14-16 affect best path considerations and are blocked. Attributes 9, 10 are internally disabled when set on an iBGP session.


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