Configuring an IPv6 Labeled-Unicast Address Family

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

Configuring a Route Map to Selectively Unsuppress Suppressed Routes

Configuring a Route Map to Selectively Unsuppress Suppressed Routes
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "inheritContPeerCtrl": ""
                },
                "children": [
                  {
                    "bgpPeerAf": {
                      "attributes": {
                        "inheritContPeerPolicyCtrl": "",
                        "type": "ipv6-lucast",
                        "unSupprMap": "map1"

}}}]}}]}}]}}
{
    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>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <unSupprMap>map1</unSupprMap>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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
  address-family ipv6 labeled-unicast
   unsuppress-map map1

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]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting a Route Map to Selectively Unsuppress Suppressed Routes for a Peer (Values inherited from a Peer Template)

Deleting a Route Map to Selectively Unsuppress Suppressed Routes for a Peer (Values inherited from a Peer Template)
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": ""
                },
                "children": [
                  {
                    "bgpPeerAf": {
                      "attributes": {
                        "inheritContPeerPolicyCtrl": "unsuppr-map",
                        "type": "ipv6-lucast",
                        "unSupprMap": "map1"
                      },
                      "children": [
                        {
                          "bgpPolicyInheritRule": {
                            "attributes": {
                              "name": "pol",
                              "seq": "1"
}}}]}}]}}]}}]}}
{
    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>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl>unsuppr-map</inheritContPeerPolicyCtrl>
                  <unSupprMap>map1</unSupprMap>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>pol</name>
                      <seq>1</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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
  address-family ipv6 labeled-unicast
   inherit peer-policy pol 1
   no unsuppress-map map1

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]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPolicyInheritRule sys/bgp/inst/dom-{name}/policycont-{name}/pol-{name}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA sequence of characters


bgpPolicyInheritRule Properties

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

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


Related Documentation

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

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

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

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

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

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

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

Applying an AS-PATH Filter List to Incoming Routes

Applying an AS-PATH Filter List to Incoming Routes 
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
 {
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtlistRule": {
                "attributes": {
                  "name": "List_A"
                },
                "children": [
                  {
                    "rtlistEntry": {
                      "attributes": {
                        "action": "permit",
                        "order": "10",
                        "regex": "1"
}}}]}}]}},{
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpFltrCtrlP": {
                                        "attributes": {
                                          "direction": "in",
                                          "list": "List_A"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <rpm-items>
    <accesslist-items>
      <Rule-list>
        <name>List_A</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <regex>1</regex>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </accesslist-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list>
                      <direction>in</direction>
                      <list>List_A</list>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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.

ip as-path access-list List_A seq 10 permit 1
router bgp 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   filter-list List_A in


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/media/dme/index.html

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

Applying an AS-PATH Filter List to Outgoing Routes

Applying an AS-PATH Filter List to Outgoing Routes 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtlistRule": {
                "attributes": {
                  "name": "List_A"
                },
                "children": [
                  {
                    "rtlistEntry": {
                      "attributes": {
                        "action": "permit",
                        "order": "10",
                        "regex": "1"
}}}]}}]}},{
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpFltrCtrlP": {
                                        "attributes": {
                                          "direction": "out",
                                          "list": "List_A"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <rpm-items>
    <accesslist-items>
      <Rule-list>
        <name>List_A</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <regex>1</regex>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </accesslist-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <fltrctrl-items>
                    <FltrCtrlP-list>
                      <direction>out</direction>
                      <list>List_A</list>
                    </FltrCtrlP-list>
                  </fltrctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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.

ip as-path access-list List_A seq 10 permit 1
router bgp 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   filter-list List_A out

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


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

MODN
topSystem sys
rpmEntity sys/rpm
rtlistRule sys/rpm/accesslist-{[name]}
rtlistEntry sys/rpm/accesslist-{[name]}/ent-{order}
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpFltrCtrlP sys/bgp/inst/dom-{name}/policycont-{name}/fltrctrl-{direction}


rtlistRule Properties

The following table contains information about the rtlistRule properties in the DME 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


rtlistEntry Properties

The following table contains information about the rtlistEntry properties in the DME 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
actionrtflt:Action
(scalar:Enum8)
ActionSELECTION:
0 - deny
1 - permit
DEFAULT: permit
orderrtflt:Order
(scalar:Uint32)
Order
RANGE: [1 , 4294967294]
regexstring:Basic
Regular ExpressionA sequence of characters


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpFltrCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA sequence of characters


Related Documentation

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

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

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

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

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

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

Applying a Prefix List to Incoming Routes

Applying a Prefix List to Incoming Routes 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtpfxRuleV4": {
                "attributes": {
                  "name": "List_1"
                },
                "children": [
                  {
                    "rtpfxEntry": {
                      "attributes": {
                        "action": "permit",
                        "criteria": "exact",
                        "fromPfxLen": "0",
                        "order": "10",
                        "pfx": "4.3.2.1/3",
                        "toPfxLen": "0"
}}}]}}]}},{
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpPfxCtrlP": {
                                        "attributes": {
                                          "direction": "in",
                                          "list": "List_1"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <rpm-items>
    <pfxlistv4-items>
      <RuleV4-list>
        <name>List_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <criteria>exact</criteria>
            <fromPfxLen>0</fromPfxLen>
            <pfx>4.3.2.1/3</pfx>
            <toPfxLen>0</toPfxLen>
          </Entry-list>
        </ent-items>
      </RuleV4-list>
    </pfxlistv4-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list>
                      <direction>in</direction>
                      <list>List_1</list>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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.

ip prefix-list List_1 seq 10 permit 4.3.2.1/3
router bgp 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   prefix-list List_1 in

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


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

MODN
topSystem sys
rpmEntity sys/rpm
rtpfxRuleV4 sys/rpm/pfxlistv4-{[name]}
rtpfxEntry sys/rpm/pfxlistv6-{[name]}/ent-{order}
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPfxCtrlP sys/bgp/inst/dom-{name}/policycont-{name}/pfxctrl-{direction}


rtpfxRuleV4 Properties

The following table contains information about the rtpfxRuleV4 properties in the DME 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


rtpfxEntry Properties

The following table contains information about the rtpfxEntry properties in the DME 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
actionrtflt:Action
(scalar:Enum8)
ActionSELECTION:
0 - deny
1 - permit
DEFAULT: permit
criteriartpfx:Criteria
(scalar:Enum8)
CriteriaSELECTION:
0 - exact
1 - inexact
DEFAULT: exact
fromPfxLenl3:IpPfxLen
(scalar:Uint16)
The start of a range used to describe the prefix length if the criteria is not an exact match.
RANGE: [0 , 128]
DEFAULT: 0
orderrtflt:Order
(scalar:Uint32)
Order
RANGE: [1 , 4294967294]
pfxaddress:Ip
Specifies the OSPF route prefix.Value must match ipv4 or ipv6 known format
toPfxLenl3:IpPfxLen
(scalar:Uint16)
The end of a range to describe the prefix length if the criteria is not an exact match.
RANGE: [0 , 128]
DEFAULT: 0


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpPfxCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA sequence of characters


Related Documentation

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

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

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

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

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

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

Applying a Prefix List to Outgoing Routes

Applying a Prefix List to Outgoing Routes 
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "rpmEntity": {
          "children": [
            {
              "rtpfxRuleV4": {
                "attributes": {
                  "name": "List_1"
                },
                "children": [
                  {
                    "rtpfxEntry": {
                      "attributes": {
                        "action": "permit",
                        "criteria": "exact",
                        "fromPfxLen": "0",
                        "order": "10",
                        "pfx": "4.3.2.1/3",
                        "toPfxLen": "0"
}}}]}}]}},{
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpPfxCtrlP": {
                                        "attributes": {
                                          "direction": "out",
                                          "list": "List_1"
}}}]}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <rpm-items>
    <pfxlistv4-items>
      <RuleV4-list>
        <name>List_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <criteria>exact</criteria>
            <fromPfxLen>0</fromPfxLen>
            <pfx>4.3.2.1/3</pfx>
            <toPfxLen>0</toPfxLen>
          </Entry-list>
        </ent-items>
      </RuleV4-list>
    </pfxlistv4-items>
  </rpm-items>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pfxctrl-items>
                    <PfxCtrlP-list>
                      <direction>out</direction>
                      <list>List_1</list>
                    </PfxCtrlP-list>
                  </pfxctrl-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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.

ip prefix-list List_1 seq 10 permit 4.3.2.1/3
router bgp 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   prefix-list List_1 out

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


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

MODN
topSystem sys
rpmEntity sys/rpm
rtpfxRuleV4 sys/rpm/pfxlistv4-{[name]}
rtpfxEntry sys/rpm/pfxlistv6-{[name]}/ent-{order}
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPfxCtrlP sys/bgp/inst/dom-{name}/policycont-{name}/pfxctrl-{direction}


rtpfxRuleV4 Properties

The following table contains information about the rtpfxRuleV4 properties in the DME 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


rtpfxEntry Properties

The following table contains information about the rtpfxEntry properties in the DME 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
actionrtflt:Action
(scalar:Enum8)
ActionSELECTION:
0 - deny
1 - permit
DEFAULT: permit
criteriartpfx:Criteria
(scalar:Enum8)
CriteriaSELECTION:
0 - exact
1 - inexact
DEFAULT: exact
fromPfxLenl3:IpPfxLen
(scalar:Uint16)
The start of a range used to describe the prefix length if the criteria is not an exact match.
RANGE: [0 , 128]
DEFAULT: 0
orderrtflt:Order
(scalar:Uint32)
Order
RANGE: [1 , 4294967294]
pfxaddress:Ip
Specifies the OSPF route prefix.Value must match ipv4 or ipv6 known format
toPfxLenl3:IpPfxLen
(scalar:Uint16)
The end of a range to describe the prefix length if the criteria is not an exact match.
RANGE: [0 , 128]
DEFAULT: 0


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpPfxCtrlP Properties

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

Property NameData TypeDescriptionValues
directionbgp:RtCtrlDir
(scalar:Enum8)
Direction: Specifies whether to apply this policy in the incoming or outgoing direction.SELECTION:
1 - in
2 - out
DEFAULT: in
liststring:Basic
Name of list to control the route distributionA sequence of characters


Related Documentation

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

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

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

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

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

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

Configuring to Advertise Only Active Routes to the Peer

Configuring to Advertise Only Active Routes to the Peer
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "ctrl": "suppress-inactive",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <ctrl>suppress-inactive</ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  suppress-inactive

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
ctrlbgp:PeerAfControl
(scalar:Bitmask16)
Peer address-family controlSELECTION:
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - allow-self-as
64 - default-originate
128 - advertisement-interval
256 - suppress-inactive
512 - nh-self-all
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Deleting the Configuration for Advertising Only Active Routes to the Peer

Deleting the Configuration for Advertising Only Active Routes to the Peer
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "ctrl": "",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <ctrl></ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no suppress-inactive

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
ctrlbgp:PeerAfControl
(scalar:Bitmask16)
Peer address-family controlSELECTION:
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - allow-self-as
64 - default-originate
128 - advertisement-interval
256 - suppress-inactive
512 - nh-self-all
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Advertise Only Active Routes to the Peer (Values inherited from a Peer Template)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
 {
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "ctrl": "",
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpPolicyInheritRule": {
                                        "attributes": {
                                          "name": "Pol1",
                                          "seq": "123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPolicyCont": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "name": "Pol1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <ctrl></ctrl>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>Pol1</name>
                      <seq>123</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
          <policycont-items>
            <PolicyCont-list>
              <name>Pol1</name>
              <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
            </PolicyCont-list>
          </policycont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 template peer-policy Pol1
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   inherit peer-policy Pol1 123
    default suppress-inactive


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/media/dme/index.html

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 Receive Capability for Additional Paths

Configuring Receive Capability for Additional Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "capAddlPaths": "recv",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <capAddlPaths>recv</capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  capability additional-paths receive

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Disabling Receive Capability for Additional Paths

Disabling Receive Capability for Additional Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "capAddlPaths": "recv-disable",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <capAddlPaths>recv-disable</capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  capability additional-paths receive disable

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Deleting Receive Capability for Additional Paths

Deleting Receive Capability for Additional Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "capAddlPaths": "",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <capAddlPaths></capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no capability additional-paths receive

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Configuring Receive Capability for Additional Paths (Values inherited from a Peer Template)

Configuring Receive Capability for Additional Paths (Values inherited from a Peer Template)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "capAddlPaths": "",
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpPolicyInheritRule": {
                                        "attributes": {
                                          "name": "Pol1",
                                          "seq": "123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPolicyCont": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "name": "Pol1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <capAddlPaths></capAddlPaths>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>Pol1</name>
                      <seq>123</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
          <policycont-items>
            <PolicyCont-list>
              <name>Pol1</name>
              <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
            </PolicyCont-list>
          </policycont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 template peer-policy Pol1
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   inherit peer-policy Pol1 123
    default capability additional-paths receive

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


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

MODN
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPolicyInheritRule sys/bgp/inst/dom-{name}/policycont-{name}/pol-{name}
bgpPolicyCont sys/bgp/inst/dom-{name}/policycont-{name}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
capAddlPathsbgp:CapAddlPathCapT
(scalar:Bitmask8)
Capability Additional PathsSELECTION:
1 - send
2 - recv
4 - send-disable
8 - recv-disable
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpPolicyInheritRule Properties

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

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


bgpPolicyCont Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring a Third-Party Nexthop (If Possible)

Configuring a Third-Party Nexthop (If Possible)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "nhThirdparty": "enabled",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <nhThirdparty>enabled</nhThirdparty>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  next-hop-third-party

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
nhThirdpartybgp:AdminSt
(scalar:Enum8)
Compute a third-party nexthop if possibleSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Deleting a Third-Party Nexthop

Deleting a Third-Party Nexthop
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "nhThirdparty": "disabled",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <nhThirdparty>disabled</nhThirdparty>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no next-hop-third-party

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
nhThirdpartybgp:AdminSt
(scalar:Enum8)
Compute a third-party nexthop if possibleSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Configuring a Third-Party Nexthop (Values inherited from a Peer Template)

Configuring a Third-Party Nexthop (Values inherited from a Peer Template) 
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": "",
                              "peerImp": "peer"
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "nhThirdparty": "enabled",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpPolicyInheritRule": {
                                        "attributes": {
                                          "name": "Pol1",
                                          "seq": "123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPolicyCont": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "name": "Pol1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <peerImp>peer</peerImp>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <nhThirdparty>enabled</nhThirdparty>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>Pol1</name>
                      <seq>123</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
          <policycont-items>
            <PolicyCont-list>
              <name>Pol1</name>
              <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
            </PolicyCont-list>
          </policycont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 template peer-policy Pol1
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   inherit peer-policy Pol1 123
    default next-hop-third-party

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


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

MODN
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPolicyInheritRule sys/bgp/inst/dom-{name}/policycont-{name}/pol-{name}
bgpPolicyCont sys/bgp/inst/dom-{name}/policycont-{name}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
nhThirdpartybgp:AdminSt
(scalar:Enum8)
Compute a third-party nexthop if possibleSELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpPolicyInheritRule Properties

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

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


bgpPolicyCont Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring a Route-Map to Selectively Unsuppress Suppressed Routes

Configuring a Route-Map to Selectively Unsuppress Suppressed Routes 
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast",
                              "unSupprMap": "Map1"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <unSupprMap>Map1</unSupprMap>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  unsuppress-map Map1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting a Configuration that Selectively Unsuppress Suppressed Routes

Deleting a Configuration that Selectively Unsuppress Suppressed Routes 
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast",
                              "unSupprMap": ""
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <unSupprMap></unSupprMap>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no unsuppress-map Map1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA sequence of characters


Related Documentation

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

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

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

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

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

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

Configuring a Route-Map to Selectively Unsuppress Suppressed Routes (Values inherited from a Peer Template)

Configuring a Route-Map to Selectively Unsuppress Suppressed Routes (Values inherited from a Peer Template)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast",
                                    "unSupprMap": ""
                                  },
                                  "children": [
                                    {
                                      "bgpPolicyInheritRule": {
                                        "attributes": {
                                          "name": "Pol1",
                                          "seq": "123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPolicyCont": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "name": "Pol1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <unSupprMap></unSupprMap>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>Pol1</name>
                      <seq>123</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
          <policycont-items>
            <PolicyCont-list>
              <name>Pol1</name>
              <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
            </PolicyCont-list>
          </policycont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 template peer-policy Pol1 &nbsp;neighbor 1.2.3.4 &nbsp;&nbsp;address-family ipv6 labeled-unicast &nbsp;&nbsp;&nbsp;inherit peer-policy Pol1 123 &nbsp;&nbsp;&nbsp;&nbsp;default unsuppress-map Map1 `

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


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

MODN
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPolicyInheritRule sys/bgp/inst/dom-{name}/policycont-{name}/pol-{name}
bgpPolicyCont sys/bgp/inst/dom-{name}/policycont-{name}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast
unSupprMapstring:Basic
Route-map to selectively unsuppress suppressed routesA sequence of characters


bgpPolicyInheritRule Properties

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

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


bgpPolicyCont Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring a Conditioned Route-Map to Advertise Only When Prefix in Condition Exists

Configuring a Conditioned Route-Map to Advertise Only When Prefix in Condition Exists
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
                            },
                            "children": [
                              {
                                "bgpAdvtMap": {
                                  "attributes": {
                                    "condMap": "map1",
                                    "condition": "exist",
                                    "rtMap": "map1"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <advtmap-items>
                    <condMap>map1</condMap>
                    <condition>exist</condition>
                    <rtMap>map1</rtMap>
                  </advtmap-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  advertise-map map1 exist-map map1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpAdvtMap sys/bgp/inst/dom-{name}/policycont-{name}/advtmap


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpAdvtMap Properties

The following table contains information about the bgpAdvtMap properties in the DME 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
condMapstring:Basic
conditional exist or non-exist route mapA sequence of characters
conditionbgp:AdvtMapCondition
(scalar:Enum8)
Specify route-map for conditional advertisementSELECTION:
0 - none
1 - exist
2 - non-exist
DEFAULT: none
rtMapstring:Basic
advertise route mapA sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting a Conditioned Route-Map to Advertise Only When Prefix in Condition Exists

Deleting a Conditioned Route-Map to Advertise Only When Prefix in Condition Exists
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
                            },
                            "children": [
                              {
                                "bgpAdvtMap": {
                                  "attributes": {
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <advtmap-items xc:operation="delete">
                  </advtmap-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no advertise-map map1 exist-map map1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpAdvtMap sys/bgp/inst/dom-{name}/policycont-{name}/advtmap


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpAdvtMap Properties

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

Property NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring a Conditioned Route-Map to Advertise Only When Prefix in Condition Does Not Exist

Configuring a Conditioned Route-Map to Advertise Only When Prefix in Condition Does Not Exist
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
                            },
                            "children": [
                              {
                                "bgpAdvtMap": {
                                  "attributes": {
                                    "condMap": "rtmap1",
                                    "condition": "non-exist",
                                    "rtMap": "map1"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <advtmap-items>
                    <condMap>rtmap1</condMap>
                    <condition>non-exist</condition>
                    <rtMap>map1</rtMap>
                  </advtmap-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  advertise-map map1 non-exist-map rtmap1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpAdvtMap sys/bgp/inst/dom-{name}/policycont-{name}/advtmap


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpAdvtMap Properties

The following table contains information about the bgpAdvtMap properties in the DME 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
condMapstring:Basic
conditional exist or non-exist route mapA sequence of characters
conditionbgp:AdvtMapCondition
(scalar:Enum8)
Specify route-map for conditional advertisementSELECTION:
0 - none
1 - exist
2 - non-exist
DEFAULT: none
rtMapstring:Basic
advertise route mapA sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting a Conditioned Route-Map to Advertise Only When Prefix in Condition Does Not Exist

Deleting a Conditioned Route-Map to Advertise Only When Prefix in Condition Does Not Exist
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
                            },
                            "children": [
                              {
                                "bgpAdvtMap": {
                                  "attributes": {
                                    "status": "deleted"
}}}]}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <advtmap-items xc:operation="delete">
                  </advtmap-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no advertise-map map1 non-exist-map rtmap1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpAdvtMap sys/bgp/inst/dom-{name}/policycont-{name}/advtmap


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpAdvtMap Properties

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

Property NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring a Route Map for Conditional Advertisement (Values inherited From a Peer Template)

Configuring a Route Map for Conditional Advertisement (Values inherited From a Peer Template)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpAdvtMap": {
                                        "attributes": {
                                          "status": "deleted"
                                        }
                                      }
                                    },
                                    {
                                      "bgpPolicyInheritRule": {
                                        "attributes": {
                                          "name": "Pol1",
                                          "seq": "123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPolicyCont": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "name": "Pol1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}                            
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <advtmap-items xc:operation="delete">
                  </advtmap-items>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>Pol1</name>
                      <seq>123</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
          <policycont-items>
            <PolicyCont-list>
              <name>Pol1</name>
              <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
            </PolicyCont-list>
          </policycont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 template peer-policy Pol1
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   inherit peer-policy Pol1 123
    default advertise-map

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


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

MODN
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpAdvtMap sys/bgp/inst/dom-{name}/policycont-{name}/advtmap
bgpPolicyInheritRule sys/bgp/inst/dom-{name}/policycont-{name}/pol-{name}
bgpPolicyCont sys/bgp/inst/dom-{name}/policycont-{name}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpAdvtMap Properties

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

Property NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


bgpPolicyInheritRule Properties

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

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


bgpPolicyCont Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring a Route Map to Specify Criteria for Originating the Default

Configuring a Route Map to Specify Criteria for Originating the Default
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "defOrg": "enabled",
                              "defOrgRtMap": "rtmap1",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <defOrg>enabled</defOrg>
                  <defOrgRtMap>rtmap1</defOrgRtMap>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  default-originate route-map rtmap1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
defOrgbgp:AdminSt
(scalar:Enum8)
Default Originate is enabledSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
defOrgRtMapstring:Basic
Default Originate Route MapA sequence of characters
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Deleting a Configured Route Map to Specify Criteria for Originating the Default

Deleting a Configured Route Map to Specify Criteria for Originating the Default
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "bgpEntity": {
    "children": [
      {
        "bgpInst": {
          "attributes": {
            "asn": "123"
          },
          "children": [
            {
              "bgpDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "bgpPeer": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "inheritContPeerCtrl": ""
                      },
                      "children": [
                        {
                          "bgpPeerAf": {
                            "attributes": {
                              "defOrg": "disabled",
                              "defOrgRtMap": "rtmap1",
                              "inheritContPeerPolicyCtrl": "",
                              "type": "ipv6-lucast"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <defOrg>disabled</defOrg>
                  <defOrgRtMap>rtmap1</defOrgRtMap>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
  no default-originate route-map rtmap1

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
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
defOrgbgp:AdminSt
(scalar:Enum8)
Default Originate is enabledSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
defOrgRtMapstring:Basic
Default Originate Route MapA sequence of characters
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


Related Documentation

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

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

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

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

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

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

Configuring a Route Map to Specify Criteria for Originating the Default (Values inherited From a Peer Template)

Configuring a Route Map to Specify Criteria for Originating the Default (Values inherited From a Peer Template)
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
  "topSystem": {
    "children": [
      {
        "bgpEntity": {
          "children": [
            {
              "bgpInst": {
                "attributes": {
                  "asn": "123"
                },
                "children": [
                  {
                    "bgpDom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "bgpPeer": {
                            "attributes": {
                              "addr": "1.2.3.4",
                              "inheritContPeerCtrl": ""
                            },
                            "children": [
                              {
                                "bgpPeerAf": {
                                  "attributes": {
                                    "defOrg": "disabled",
                                    "defOrgRtMap": "",
                                    "inheritContPeerPolicyCtrl": "",
                                    "type": "ipv6-lucast"
                                  },
                                  "children": [
                                    {
                                      "bgpPolicyInheritRule": {
                                        "attributes": {
                                          "name": "Pol1",
                                          "seq": "123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "bgpPolicyCont": {
                            "attributes": {
                              "inheritContPeerPolicyCtrl": "",
                              "name": "Pol1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <af-items>
                <PeerAf-list>
                  <type>ipv6-lucast</type>
                  <defOrg>disabled</defOrg>
                  <defOrgRtMap></defOrgRtMap>
                  <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
                  <pol-items>
                    <PolicyInheritRule-list>
                      <name>Pol1</name>
                      <seq>123</seq>
                    </PolicyInheritRule-list>
                  </pol-items>
                </PeerAf-list>
              </af-items>
            </Peer-list>
          </peer-items>
          <policycont-items>
            <PolicyCont-list>
              <name>Pol1</name>
              <inheritContPeerPolicyCtrl></inheritContPeerPolicyCtrl>
            </PolicyCont-list>
          </policycont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>


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 123
 template peer-policy Pol1
 neighbor 1.2.3.4
  address-family ipv6 labeled-unicast
   inherit peer-policy Pol1 123
    default default-originate route-map rtmap1

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


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

MODN
topSystem sys
bgpEntity sys/bgp
bgpInst sys/bgp/inst
bgpDom sys/bgp/inst/dom-{name}
bgpPeer sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerAf sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]}
bgpPolicyInheritRule sys/bgp/inst/dom-{name}/policycont-{name}/pol-{name}
bgpPolicyCont sys/bgp/inst/dom-{name}/policycont-{name}


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


bgpPeerAf Properties

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

Property NameData TypeDescriptionValues
defOrgbgp:AdminSt
(scalar:Enum8)
Default Originate is enabledSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
defOrgRtMapstring:Basic
Default Originate Route MapA sequence of characters
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
typebgp:AfT
(scalar:Enum8)
TypeSELECTION:
1 - ipv4-ucast
2 - ipv4-mcast
3 - vpnv4-ucast
5 - ipv6-ucast
6 - ipv6-mcast
7 - vpnv6-ucast
8 - vpnv6-mcast
9 - l2vpn-evpn
10 - ipv4-lucast
11 - ipv6-lucast
12 - lnkstate
13 - ipv4-mvpn
14 - ipv6-mvpn
15 - l2vpn-vpls
16 - ipv4-mdt
DEFAULT: ipv4-ucast


bgpPolicyInheritRule Properties

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

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


bgpPolicyCont Properties

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

Property NameData TypeDescriptionValues
inheritContPeerPolicyCtrlbgp:InheritContPeerPolicyCtrlType
(scalar:Bitmask64)
Inherit control of peer policy parametersSELECTION:
1 - allow-as-in
2 - send-com-std
4 - rr-client
8 - nh-self
16 - dis-peer-as-check
32 - soft-reconfig-in
64 - max-prefix
128 - route-map-in
256 - route-map-out
512 - prefix-map-in
1024 - prefix-map-out
2048 - fltr-map-in
4096 - fltr-map-out
8192 - unsuppr-map
16384 - default-originate
32768 - advertisement-interval
65536 - addl-paths-send-cap
131072 - addl-paths-recv-cap
262144 - send-com-ext
524288 - suppress-inactive
1048576 - as-override
2097152 - next-hop-third-party
4194304 - wght
8388608 - soo
16777216 - advt-map
33554432 - encap-mpls
67108864 - rewrite-rt-asn
134217728 - adv-gw-ip
268435456 - adv-loc-lbl-rt
536870912 - nh-self-all
1073741824 - import-vpn-unicast
2147483648 - import-l2vpn-evpn
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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