Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling the Maximum Path for iBGP Peers

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpDomAf": {
               "attributes": {
                 "maxEcmp": "34",
                 "type": "ipv6-mcast"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <af-items>
            <DomAf-list>
              <type>ipv6-mcast</type>
              <maxEcmp>34</maxEcmp>
            </DomAf-list>
          </af-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring an IPv6 Multicast Address Family

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

Enabling the Maximum Path for iBGP Peers

Controls the maximum number of parallel iBGP routes that can be installed in a routing table.

CLI Commands

The CLI commands and options are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

router bgp 100
address-family ipv6 multicast
maximum-paths ibgp 34

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.

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/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 Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

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

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

bgpDomAf Properties

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

Property Name	Data Type	Description	Values
maxEcmp	bgp:MaxEcmp (scalar:UByte)	The maximum number of equal-cost paths for BGP load sharing.	RANGE: [1 , 64] DEFAULT: 1
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 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

Applying a Route Map to a Network Prefix

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
address-family ipv6 multicast
network 1:2::3:4/2 route-map Map_1

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpDomAf	sys/bgp/inst/dom-{name}/af-{[type]}
bgpAdvPrefix	sys/bgp/inst/dom-{name}/af-{[type]}/prefix-{[addr]}

bgpInst Properties

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

bgpDom Properties

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

bgpDomAf Properties

Property Name	Data Type	Description	Values
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 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

bgpAdvPrefix Properties

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

Property Name	Data Type	Description	Values
addr	address:Ip	IP address of the network or prefix to advertise	Value must match ipv4 or ipv6 known format
rtMap	string:Basic	Route map to modify attributes	A sequence of characters

Related Documentation

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

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

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

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

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

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

CLI Commands

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

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

MO	DN
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 Name	Data Type	Description	Values
name	pol: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 Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [1 , 4294967294]
regex	string:Basic	Regular Expression	A sequence of characters

bgpInst Properties

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

bgpDom Properties

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

bgpPeer Properties

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

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 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 Name	Data Type	Description	Values
inheritContPeerPolicyCtrl	bgp:InheritContPeerPolicyCtrlType (scalar:Bitmask64)	Inherit control of peer policy parameters	SELECTION: 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
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 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 Name	Data Type	Description	Values
direction	bgp:RtCtrlDir (scalar:Enum8)	Direction: Specifies whether to apply this policy in the incoming or outgoing direction.	SELECTION: 1 - in 2 - out DEFAULT: in
list	string:Basic	Name of list to control the route distribution	A sequence of characters

Related Documentation

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

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

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

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

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

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

CLI Commands

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

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

MO	DN
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

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

rtlistEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [1 , 4294967294]
regex	string:Basic	Regular Expression	A sequence of characters

bgpInst Properties

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

bgpDom Properties

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

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 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

Property Name	Data Type	Description	Values
inheritContPeerPolicyCtrl	bgp:InheritContPeerPolicyCtrlType (scalar:Bitmask64)	Inherit control of peer policy parameters	SELECTION: 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
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 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

Property Name	Data Type	Description	Values
direction	bgp:RtCtrlDir (scalar:Enum8)	Direction: Specifies whether to apply this policy in the incoming or outgoing direction.	SELECTION: 1 - in 2 - out DEFAULT: in
list	string:Basic	Name of list to control the route distribution	A sequence of characters

Related Documentation

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

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

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

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

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

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

Applying a Prefix List to Incoming Routes

CLI Commands

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

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

MO	DN
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 Name	Data Type	Description	Values
name	pol: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 Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
criteria	rtpfx:Criteria (scalar:Enum8)	Criteria	SELECTION: 0 - exact 1 - inexact DEFAULT: exact
fromPfxLen	l3: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
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [1 , 4294967294]
pfx	address:Ip	Specifies the OSPF route prefix.	Value must match ipv4 or ipv6 known format
toPfxLen	l3: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

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

bgpDom Properties

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

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 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

Property Name	Data Type	Description	Values
inheritContPeerPolicyCtrl	bgp:InheritContPeerPolicyCtrlType (scalar:Bitmask64)	Inherit control of peer policy parameters	SELECTION: 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
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 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 Name	Data Type	Description	Values
direction	bgp:RtCtrlDir (scalar:Enum8)	Direction: Specifies whether to apply this policy in the incoming or outgoing direction.	SELECTION: 1 - in 2 - out DEFAULT: in
list	string:Basic	Name of list to control the route distribution	A sequence of characters

Related Documentation

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

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

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

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

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

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

Applying a Prefix List to Outgoing Routes

CLI Commands

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

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

MO	DN
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

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

rtpfxEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
criteria	rtpfx:Criteria (scalar:Enum8)	Criteria	SELECTION: 0 - exact 1 - inexact DEFAULT: exact
fromPfxLen	l3: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
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [1 , 4294967294]
pfx	address:Ip	Specifies the OSPF route prefix.	Value must match ipv4 or ipv6 known format
toPfxLen	l3: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

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

bgpDom Properties

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

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 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

Property Name	Data Type	Description	Values
inheritContPeerPolicyCtrl	bgp:InheritContPeerPolicyCtrlType (scalar:Bitmask64)	Inherit control of peer policy parameters	SELECTION: 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
type	bgp:AfT (scalar:Enum8)	Type	SELECTION: 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

Property Name	Data Type	Description	Values
direction	bgp:RtCtrlDir (scalar:Enum8)	Direction: Specifies whether to apply this policy in the incoming or outgoing direction.	SELECTION: 1 - in 2 - out DEFAULT: in
list	string:Basic	Name of list to control the route distribution	A sequence of characters

Related Documentation

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

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

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

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

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

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

Response

Configuring an IPv6 Multicast Address Family

Enabling the Maximum Path for iBGP Peers

Applying a Route Map to a Network Prefix

Applying an AS-PATH Filter List to Incoming Routes

Applying an AS-PATH Filter List to Outgoing Routes

Applying a Prefix List to Incoming Routes

Applying a Prefix List to Outgoing Routes