Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
Configuring an IPv4 Unicast Subaddress Family
Enters neighbor address family configuration mode.
CLI Commands
The CLI commands and options are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
router bgp 100
neighbor 20.1.1.1
address-family ipv4 unicast
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} |
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 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 |
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 |
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 an AS-PATH Filter List to Incoming Routes
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 ipv4 unicast
filter-list List_A 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.
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
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 |
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
Applying an AS-PATH Filter List to Outgoing Routes
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 ipv4 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.
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
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 |
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
Applying a Prefix List to Incoming Routes
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 ipv4 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.
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
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 |
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 |
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
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 ipv4 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.
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
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 |
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 |
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
Querying an IPv4 Aggregate Address Family
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 |
bgpAggAddr |
sys/bgp/inst/dom-{name}/af-{[type]}/aggaddr-{[addr]} |
bgpAggAddr Properties
The following table contains information about the bgpAggAddr properties in the DME 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
| Aggregate Address | Value must match ipv4 or ipv6 known format |
adverMap | string:Basic
| Advertise Map: Route map used to select attribute information from selected routes | A sequence of characters |
asSet | bgp:AsSet (scalar:Enum8) | AS-SET | SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled |
attrMap | string:Basic
| Attribute Map: Route map to set attribute information of aggregate | A sequence of characters |
childAction | mo:ModificationChildAction scalar:Bitmask32 | Delete or ignore. For internal use only. | SELECTION:
16384u - deleteAll4096u - ignore8192u - deleteNonPresent DEFAULT: 0 |
dn | reference:BinRef | A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. | |
lcOwn | NA | NA | NA |
modTs | mo:TStamp (scalar:Date) | The time when this object was last modified. | SELECTION: 0 - never DEFAULT: never |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
summaryOnly | bgp:SummaryOnly (scalar:Enum8) | Aggregate address Summary only | SELECTION: 0 - disabled 1 - enabled DEFAULT: disabled |
supprMap | string:Basic
| Suppress Map to conditionally filter more-specific routes | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Configuring an IPv4 Unicast Sub-Address Family
Enters neighbor address family configuration mode.
CLI Commands
The CLI commands and options are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
router bgp 100
neighbor 20.1.1.1
address-family ipv4 unicast
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} |
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 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 |
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 |
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
Sends the community attribute to this BGP peer. This command triggers an automatic soft clear or refresh of BGP neighbor sessions.
CLI Commands
The CLI commands and options are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
router bgp 100
neighbor 20.1.1.1
address-family ipv4 unicast
send-community
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} |
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 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 |
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 |
sendComStd | bgp:AdminSt (scalar:Enum8) | Send-community standard | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
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
Configuring the Maximum Number of Prefixes from this Neighbor
Configures the maximum number of prefixes from a peer.
CLI Commands
The CLI commands and options are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
router bgp 100
neighbor 20.1.1.1
address-family ipv4 unicast
maximum-prefix 10 11 restart 12
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} |
bgpPeer |
sys/bgp/inst/dom-{name}/peer-{[addr]} |
bgpPeerAf |
sys/bgp/inst/dom-{name}/peerif-{[id]}/af-{[type]} |
bgpMaxPfxP |
sys/bgp/inst/dom-{name}/policycont-{name}/maxpfxp |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
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 |
bgpMaxPfxP Properties
The following table contains information about the bgpMaxPfxP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
action | bgp:MaxPfxAct (scalar:Enum8) | Action to do when limit is exceeded | SELECTION: 1 - log 2 - shut 3 - restart DEFAULT: shut |
maxPfx | bgp:MaxPfx (scalar:Uint32) | Maximum number of prefixes allowed from the peer. | RANGE: [0, 4294967295] |
restartTime | bgp:MaxPfxDuration (scalar:Uint16) | The period of time in minutes before restarting the peer when the prefix limit is reached. | RANGE: [0 , 0xffff] |
thresh | bgp:MaxPfxThresh (scalar:UByte) | The threshold percentage of the maximum number of prefixes before a warning is issued. For example, if the maximum number of prefixes is 10 and the threshold is 70%, a warning is issued when the number of prefixes exceeds 7 (70%). | RANGE: [0 , 100] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Originating a Default Toward this Peer
Generates a default route to the BGP peer.
CLI Commands
The CLI commands and options are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
router bgp 100
neighbor 20.1.1.1
address-family ipv4 unicast
default-originate
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} |
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 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 |
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 |
defOrg | bgp:AdminSt (scalar:Enum8) | Default Originate is enabled | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
defOrgRtMap | string:Basic
| Default Originate Route Map | A sequence of characters |
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 |
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
Advertising a Route With Local Label to Peer
Note: This example was added in Release 9.2(2).
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 ipv4 unicast
default advertise local-labeled-route
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 |
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 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 |
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 |
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
Deleting Route Advertisement with Local Label to Peer
Note: This example was added in Release 9.2(2).
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 ipv4 unicast
no advertise local-labeled-route
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 |
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 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 |
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 |
advLocalLblRt | nw:AdminSt (scalar:Enum8) | Advertise a route with local label to peer | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Configuring the Minimum Interval Between Sending BGP Routing Updates
Note: This example was added in Release 9.2(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor 1.2.3.4
address-family ipv4 unicast
advertisement-interval 9
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 |
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 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 |
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 |
advIntvl | bgp:AdvInterval (scalar:Uint16) | Neighbor advertisement interval | RANGE: [0 , 600] |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Deleting the Minimum Interval Between Sending BGP Routing Updates
Note: This example was added in Release 9.2(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor 1.2.3.4
address-family ipv4 unicast
no advertisement-interval 9
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 |
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 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 |
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 |
advIntvl | bgp:AdvInterval (scalar:Uint16) | Neighbor advertisement interval | RANGE: [0 , 600] |
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 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html
Configuring the Peering Address as Nexthop
Note: This example was added in Release 9.2(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor 1.2.3.4
address-family ipv4 unicast
next-hop-self
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 |
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 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 |
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 |
ctrl | bgp:PeerAfControl (scalar:Bitmask16) | Peer address-family control | SELECTION: 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 |
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 |
nhSelfAll | scalar:Bool
| Set address as next-hop for all routes | SELECTION: true or false |
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
Deleting the Peering Address as Nexthop
Note: This example was added in Release 9.2(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor 1.2.3.4
address-family ipv4 unicast
no next-hop-self
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 |
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 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 |
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 |
ctrl | bgp:PeerAfControl (scalar:Bitmask16) | Peer address-family control | SELECTION: 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 |
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 |
nhSelfAll | scalar:Bool
| Set address as next-hop for all routes | SELECTION: true or false |
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
Configuring the Address as Nexthop for All Routes
Note: This example was added in Release 9.2(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor 1.2.3.4
address-family ipv4 unicast
next-hop-self all
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 |
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 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 |
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 |
ctrl | bgp:PeerAfControl (scalar:Bitmask16) | Peer address-family control | SELECTION: 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 |
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 |
nhSelfAll | scalar:Bool
| Set address as next-hop for all routes | SELECTION: true or false |
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
Note: This example was added in Release 9.2(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor 1.2.3.4
address-family ipv4 unicast
no next-hop-self all
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 |
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 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 |
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 |
ctrl | bgp:PeerAfControl (scalar:Bitmask16) | Peer address-family control | SELECTION: 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 |
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 |
nhSelfAll | scalar:Bool
| Set address as next-hop for all routes | SELECTION: true or false |
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
Configuring Route Advertisement with Local Label to Peer
Note:
- This example was added in Release 9.3(1).
- This command is enabled by default.
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 ipv4 unicast
advertise local-labeled-route
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
bgpEntity |
sys/bgp |
bgpInst |
sys/bgp/inst |
bgpDom |
sys/bgp/inst/dom-default |
bgpPeer |
sys/bgp/inst/dom-default/peer-[1.2.3.4] |
bgpPeerAf |
sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-ipv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved. | |
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 |
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 |
advLocalLblRt | nw:AdminSt (scalar:Enum8) | Advertise a route with local label to peer | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
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 |
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
Deleting Route Advertisement with Local Label to Peer
Note: This example was added in Release 9.3(1).
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 ipv4 unicast
no advertise local-labeled-route
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
bgpEntity |
sys/bgp |
bgpInst |
sys/bgp/inst |
bgpDom |
sys/bgp/inst/dom-default |
bgpPeer |
sys/bgp/inst/dom-default/peer-[1.2.3.4] |
bgpPeerAf |
sys/bgp/inst/dom-default/peer-[1.2.3.4]/af-ipv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved. | |
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 |
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 |
advLocalLblRt | nw:AdminSt (scalar:Enum8) | Advertise a route with local label to peer | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
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 |
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