- Cisco Nexus 3000 and 9000 Series NX-API REST Documentation
- Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
- Getting Started with the Cisco Nexus 3000 and 9000 Series NX-API REST SDK
- Related Documentation
- New and Changed Information
- Manageability
- ISSU Commands
- Installing Software Packages
- Configuring NX-API Management
- Managing Images
- Manageability Actions
- Configuring GRPC tunnel destination
- Manageability Using YANG (NETCONF)
- Configuring Fundamentals
- High Availability and Redundancy
- Configuring ITD
- Configuring Interfaces
- Configuring Ethernet Interfaces
- Configuring a MAC Address Limitation
- Configuring VLAN Interfaces
- Configuring Loopback Interfaces
- Configuring MGMT Interfaces
- Configuring Breakout Profiles
- Configuring System Default Switchport
- Configuring UDLD
- Configuring BFD
- Configuring LACP
- Configuring Hostname Loopback
- Configuring Breakout on High-Bandwidth Interfaces
- Configuring Port-Channel Interfaces
- Configuring Virtual Port Channels
- Configuring Tunnel Interfaces
- Configuring Layer 2 Protocol Tunneling
- Configuring Network Address Translation (NAT)
- Configuring IP TCP MSS
- Configuring Hardware Profile Settings
- Querying Interface Information
- Clearing Statistics
- Configuring IP SLAs
- Configuring Label Switching
- Configuring Segment Routing
- Configuring MPLS LDP
- Configuring Label Advertisement
- Configuring Label Allocation
- Configuring MPLS
- Disabling MPLS Forwarding for IP
- Configuring LDP Session Backoff
- Configuring LDP Discovery
- Configuring Explicit Null Label Advertisement
- Configuring LDP Graceful Restart
- Configuring LDP Holdtime
- Configuring a Neighbor
- Configuring an LDP Password
- Configuring LDP Logging
- Configuring LDP Labels
- Configuring an LDP Session
- Configuring MPLS LDP on an Interface
- Configuring Netstack
- Configuring Layer 2 Switching
- Configuring Flex Links
- Configuring Hairpin Forwarding
- Configuring Storm Control
- Configuring a Private VLAN (PVLAN)
- Configuring Multicast Routing
- Configuring PIM/PIM6
- Configuring MSDP
- Configuring IGMP
- Configuring MLD Snooping
- Configuring MRIB
- Configuring RPF Routes for Multicast
- Configuring Fabric Extender
- Configuring QoS
- Configuring Policing
- Configuring QoS Class Maps
- Configuring QoS Policy Maps
- Configuring a User-Defined Network QoS Policy
- Configuring the Hardware Buffer Utilization Thresholds
- Configuring Hardware QoS
- Configuring Hardware Profile Settings on the Cisco Nexus 3500 Platform
- Configuring Cisco Nexus 9000 (Cisco-ASIC based) Platform QoS
- Configuring Priority Flow Control
- Changing the Bandwidth Allocated to Unicast and Multicast Traffic
- Clearing Statistics
- Configuring TCAM
- Enabling Queue-Based ECN Marking
- Configuring Trust Boundaries
- Configuring Security
- Configuring FIPS Mode
- Configuring EAP Profile
- Configuring Keychain Management
- Configuring AAA
- Configuring RADIUS
- Configuring TACACS+
- Configuring LDAP
- Configuring SSH
- Configuring a Trustpool Policy
- Configuring a Trustpoint Certificate Authority
- Configuring a Trustpoint Certificate Authority
- Configuring Certificate Authority Related Information
- Crypto ca import for mytrustpoint pkcs12
- Configuring Telnet
- Configuring the Shell Type for Login
- Configuring User Accounts and RBAC
- Configuring the VSH Roles and Rules
- Configuring ACLs
- Configuring Port Security
- Configuring DHCP
- Configuring Password Encryption
- Configuring VPN Ids
- Configuring Unicast RPF (URPF)
- Configuring System Security Compliance
- Configuring Control Plane Policing
- Configuring Rate Limits
- Configuring MACsec
- Known Behaviour for Logging Level Configs
- Configuring System Management
- Configuring Sup Boot Variables
- Configuring System Cores
- Configuring System Trace Level
- Configuring the Fast Reload Network Stabilization Timer
- Configuring Frequency Synchronization
- Configuring NTP
- Configuring PTP
- Verifying PTP Counters
- Configuring Cisco Discovery Protocol
- Configuring Call Home
- Configuring Checkpoints and Rollback
- Configuring System Logging
- Configuring the Scheduler
- Configuring SNMP
- Configuring RMON
- Configuring Online Diagnostics
- Configuring EVMED
- Configuring Embedded Event Manager
- Configuring Memory Thresholds
- Configuring SPAN
- Configuring ERSPAN
- Configuring LLDP
- Enabling and Disabling LLDP
- Configuring LLDP in Global Mode
- Configuring LLDP on the if-eth-base/if-ethernet-all Command Mode
- Configuring LLDP on the if-gig-ether Command Mode
- Configuring LLDP on the if-gig-ether-all Command Mode
- Configuring LLDP on the if-mgmt-ether Command Mode
- Configuring the DCBXP Version
- Configuring System Interface Shutdown
- Configuring NetFlow
- Configuring Drop Report Tool
- Configuring sFlow
- Attaching a TAP Aggregation Policy to an Interface
- Configuring MPLS Stripping
- Configuring the Maintenance-Mode Profile
- Configuring Maintenance Mode
- Configuring CFS
- Configuring User-Defined Fields
- Configuring a Fan-Direction Mismatch
- System-Level High Availability
- Configuring NX-OS Container Tracker
- Configuring VXLAN
- VXLAN New and Changed
- Micro-segmentation for VXLAN Fabrics Using Group Policy Option (GPO)
- Configuring VXLAN BGP EVPN
- Configuring HMM
- Configure VXLAN FHS
- VXLAN Configuration Command Examples
- Configuring NVE Interfaces
- Configuring BGP EVPN Filtering
- Configuring VXLAN OAM (NGOAM)
- Executing Ping NVE, Traceroute NVE, and Path Trace NVE
- Configuring System NVE
- Associating NVE Interfaces with VNIs
- Configuring ngMVPN
- Configuring Selective Q-in-VNI
- Ephemeral (MOTL) MOs for NVE
- Configuring Unicast Routing
- Configuring the System Routing Mode
- Configuring ARP
- Configuring ALPM
- Configuring Logging for Software Forwarding of IP Packets
- Configuring DNS
- Configuring OSPF, OSPFv2, and OSPFv3
- Configuring OSPF
- Configuring OSPFv2
- Configuring OSPFv3
- Configuring an IPv6 Unicast Address Family Under an OSPFv3 Instance
- Configuring OSPFv3 Broadcast Network Type
- Configuring OSPFv3 on an Ethernet Interface
- Configuring OSPFv3 on a Loopback Interface
- Configuring OSPFv3 on a MGMT Interface
- Configuring OSPFv3 on a P2P Ethernet Interface
- Configuring OSPFv3 on a Tunnel Interface
- Configuring a Virtual Link Under an OSPFv3 Instance
- Configuring a VRF Under an OSPFv3 Instance
- Querying OSPFv3
- Configuring IS-IS
- Configuring IS-IS in Global Configuration Command Mode
- Configuring IS-IS in Interface Configuration Mode
- Configuring IS-IS in Router Configuration Mode
- Configuring IS-IS in Router VRF Configuration Mode
- Configuring IS-IS in Router IPv4 Address Family Configuration Mode
- Configuring IS-IS in Router IPv6 Address Family Configuration Mode
- IS-IS Operational Commands
- Configuring EIGRP
- Enabling EIGRP
- Disabling EIGRP
- Configuring isolate Under EIGRP
- Configuring flush-routes under EIGRP
- Configuring vrf
- Configuring EIGRP address-family
- Configuring EIGRP router-id
- Configuring EIGRP distance
- Configuring EIGRP maximum paths
- Configuring EIGRP default information originate
- Configuring EIGRP administrative state
- Configuring IPV4 EIGRP route redistribution
- Configuring IPv6 EIGRP route redistribution
- Configuring EIGRP table map filter
- Configuring EIGRP redistribute maximum prefix
- Configuring EIGRP graceful restart
- Configuring EIGRP log adjacency changes
- Configuring EIGRP log adjacency warnings
- Configuring EIGRP metric version
- Configuring EIGRP metric maximum hops
- Configuring EIGRP nsf await redistribute proto convergence
- Configuring EIGRP autonomous system number
- Configuring EIGRP nsf route-hold timer
- Configuring EIGRP nsf converge timer
- Configuring EIGRP nsf signal timer
- Configuring EIGRP timers active-time
- Configuring EIGRP supress fib pending
- Configuring EIGRP passive interface
- Configuring EIGRP metric weights
- Configuring EIGRP default metric
- Configuring EIGRP stub
- Configuring EIGRP authentication key chain
- Configuring EIGRP authentication mode
- Configuring BFD for EIGRP
- Configuring EIGRP in Interface Configuration Mode
- Configuring BGP
- Configuring a BGP Router
- VXLAN EVPN Traffic Engineering - Multi-Site Egress Load-Balancing
- VXLAN EVPN Traffic Engineering – RPM support
- Configuring BGP on a VRF
- Configuring BFD Multihop under a Neighbor
- Configuring an IPv4 Multicast Address Family
- Configuring an IPv4 MVPN Address Family
- Configuring an IPv4 Unicast Address Family
- Configuring an IPv6 MVPN Address Family
- Configuring an IPv6 Unicast Address Family
- Configuring a Link-State Address Family
- Configuring a VPNv4 Unicast Address Family
- Configuring a VPNv6 Unicast Address Family
- Configuring a Peer Policy Template
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Policy Template
- Configuring an IPv4 Unicast Subaddress Family for a Peer Policy Template
- Configuring an IPv6 Unicast Subaddress Family for a Peer Policy Template
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Policy Template
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Policy Template
- Configuring a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a Peer Template
- Configuring an IPv4 Labeled Subaddress Family for a Peer Template
- Configuring an IPv4 Unicast Subaddress Family for a Peer Template
- Configuring an IPv6 Unicast Subaddress Family for a Peer Template
- Configuring a VPNv4 Subaddress Family for a Peer Template
- Configuring a VPNV6 Subaddress Family for a Peer Template
- Configuring Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a Peer Template with Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a BGP Neighbor (IP Address)
- Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Labeled Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Multicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv4 MVPN Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 MVPN Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an L2VPN EVPN Address Family under a BGP Neighbor (IP Address)
- Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring a VPNv6 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring BGP Session Templates Under a BGP Neighbor (IP Address)
- Configuring a BGP Neighbor (Ethernet Interface)
- Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring an IPv6 MVPN Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring an L2VPN EVPN Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring Peer Policy Inheritance
- Deleting Peer Policy Inheritance
- Configuring As Path Acceptance with My AS Present In It
- Deleting As Path Acceptance with My AS Present In It
- Configuring to Send Standard and Extended Community Attributes
- Deleting to Send Standard and Extended Community Attributes
- Configuring to Send Standard Community Attributes
- Deleting to Send Standard Community Attributes
- Configuring the Extended Community Attribute
- Deleting the Extended Community Attribute
- Configuring a Neighbor as Route-Reflector Client
- Deleting a Neighbor as Route-Reflector Client
- Configuring the Default Weight for Routes from a Neighbor
- Deleting the Default Weight for Routes from a Neighbor
- Configuring Policy Application to Incoming Routes
- Deleting Policy Application to Incoming Routes
- Configuring Policy Application (Prefix List)
- Deleting Policy Application (Prefix List)
- Configuring a Policy Application to Incoming Routes
- Deleting a Policy Application to Incoming Routes
- Configuring Policy Application (Filter List)
- Deleting Policy Application (Filter List)
- Configuring BGP Connection Restart After a Limit is Exceeded
- Deleting BGP Connection Restart After a Limit is Exceeded
- Configuring a Warning Message When a Limit is Exceeded
- Deleting a Warning Message When a Limit is Exceeded
- Configuring the Minimum Interval Between Sending BGP Routing Updates
- Deleting the Minimum Interval Between Sending BGP Routing Updates
- Configuring Our Address as Nexthop for All Routes
- Deleting Our Address as Nexthop for All Routes
- Configuring to Not Advertise Additional Paths (Send Capability)
- Deleting to Not Advertise Additional Paths (Send Capability)
- Configuring to Not Advertise Additional Paths (Receive Capability)
- Deleting to Not Advertise Additional Paths (Receive Capability)
- Configuring a Route Map to Selectively Unsuppress Suppressed Routes
- Deleting a Route Map to Selectively Unsuppress Suppressed Routes
- Configuring a VPNv6 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a BMP Server
- Configuring Mixed ECMP
- About Querying Ephemeral Data
- Configuring RIP
- Configuring DSCP
- Configuring VRFs
- Configuring Route Policy Manager
- First-Hop Redundancy Protocols
- Configuring Hardware Forwarding
- Configuring Hardware Ejector
- Configuring Hardware Profile Settings
- Configuring the Site of Origin
- Configuring AS-4 Dot Notation
- Configuring Static Routing
- Configuring Load Sharing in the Unicast FIB
- Configuring OpenFlow
- Configuring RTP Flow Monitoring
- Configuring Kernel Stack
- Configuring Apphosting
- Controlling the Guest Shell
- Enabling the Guest Shell and Querying the Result
- Disabling the Guest Shell and Querying the Result
- Destroying the Guest Shell and Querying the Result
- Rebooting the Guest Shell and Querying the Result
- Increasing the Guest Shell Rootfs Size and Querying the Result
- Changing the CPU Memory Size that the Guest Shell Uses and Querying the Result
- Changing the Memory Size the Guest Shell Uses and Querying the Result
- Syncing the Guest Shell Rootfs to the Standby Supervisor and Querying the Result
- Exporting the Guest Shell Rootfs and Querying the Result
- Upgrading the Guest Shell Rootfs and Querying the Result
- Querying Guest Shell Information
- Change Virtual Service Global Configuration
- Managing System Hardware
- Configuring the Baseboard Management Controller
- Configuring Virtual Machine Tracker
- Configuring Virtual Device Contexts
- Configuring iCAM
- Configuring SRv6
- Configuring Smart Software Licensing
- Querying Configurations (Show Commands)
- Querying Advertised Routes
- Querying DHCP Relay Interfaces
- Querying Diagnostic Result Test IDs
- Querying the Environment Settings
- Querying Feature Status
- Querying Inventory Information
- Querying IS-IS Configurations
- Querying IP IGMP Groups
- Querying IP OSPF Neighbor Details
- Querying IP OSPF Neighbor VRF Information
- Querying L2VPN EVPN
- Querying LLDP
- Querying MAC Address Table Info
- Querying Module Information
- Querying NAT ITD
- Querying NTP Peer Status
- Querying an OSPFv2 Instance
- Querying Patterns
- Querying PIM Information
- Querying the Processes Log
- Querying Spanning Tree Information
- Querying a Summary of IP Interface Status and Configuration Information
- Querying TCAM Resource Utilization
- Querying MCAST NAT TCAM Resource Monitoring
- Querying NBM TCAM Resource Monitoring
- Querying the Version
- Querying VLAN ID Counters
- Querying VRF Information
- Querying VRRP Information
- Querying Forwarding Route Information
- Querying IP Route Details
- Querying the Current MOTD Banner Message
- Querying OSPF Neighbors
- Querying Analytic Information
- Querying Interface and VLAN Counters and Statistics
- Querying ITD Runtime Information
- Querying ePBR Runtime Information
- Using the Managed Object Browser
- Monitoring the Environment
CopyPOST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpPeerIf": {
"attributes": {
"id": "eth1/2"
},
"children": [
{
"bgpPeerAf": {
"attributes": {
"type": "vpnv4-ucast"
},
"children": [
{
"bgpPolicyInheritRule": {
"attributes": {
"name": "SampleString_123",
"seq": "8688"
}}}]}}]}}]}}]}}]}}
Response
{
imdata:[]
}
Copy<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<peerif-items>
<PeerIf-list>
<id>eth1/2</id>
<af-items>
<PeerAf-list>
<type>vpnv4-ucast</type>
<pol-items>
<PolicyInheritRule-list>
<name>SampleString_123</name>
<seq>8688</seq>
</PolicyInheritRule-list>
</pol-items>
</PeerAf-list>
</af-items>
</PeerIf-list>
</peerif-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
Configuring Peer Policy Inheritance
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
inherit peer-policy SampleString_123 8688
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpPolicyInheritRule | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pol-SampleString_123 |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpPolicyInheritRule Properties
The following table contains information about the bgpPolicyInheritRule properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
seq | bgp:Order (scalar:Uint16) | Sequence Number | RANGE: [1 , 65535] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Peer Policy Inheritance
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no inherit peer-policy SampleString_123 8688
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpPolicyInheritRule | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pol-SampleString_123 |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpPolicyInheritRule Properties
The following table contains information about the bgpPolicyInheritRule properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring As Path Acceptance with My AS Present In It
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
allowas-in 7
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
allowedSelfAsCnt | scalar:UByte | Allowed Self AS Count | RANGE: [0 , 10] DEFAULT: 0 |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting As Path Acceptance with My AS Present In It
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no allowas-in 7
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
allowedSelfAsCnt | scalar:UByte | Allowed Self AS Count | RANGE: [0 , 10] DEFAULT: 0 |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring to Send Standard and Extended Community Attributes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
send-community both
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
sendComExt | bgp:AdminSt (scalar:Enum8) | Send-community extended | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting to Send Standard and Extended Community Attributes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no send-community both
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
sendComExt | bgp:AdminSt (scalar:Enum8) | Send-community extended | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring to Send Standard Community Attributes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
send-community standard
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting to Send Standard Community Attributes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no send-community standard
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Extended Community Attribute
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
send-community extended
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
sendComExt | bgp:AdminSt (scalar:Enum8) | Send-community extended | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Extended Community Attribute
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no send-community extended
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
sendComExt | bgp:AdminSt (scalar:Enum8) | Send-community extended | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Neighbor as Route-Reflector Client
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
route-reflector-client
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Neighbor as Route-Reflector Client
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no route-reflector-client
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Default Weight for Routes from a Neighbor
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
weight 155
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
wght | string:Basic | Weight for the neighbor. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Default Weight for Routes from a Neighbor
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no weight 155
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
wght | string:Basic | Weight for the neighbor. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Policy Application to Incoming Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
prefix-list SampleString_123 in
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpPfxCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-in |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpPfxCtrlP Properties
The following table contains information about the bgpPfxCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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:
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:
Deleting Policy Application to Incoming Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no prefix-list SampleString_123 in
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpPfxCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-in |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpPfxCtrlP Properties
The following table contains information about the bgpPfxCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Policy Application (Prefix List)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
prefix-list SampleString_123 out
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpPfxCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-out |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpPfxCtrlP Properties
The following table contains information about the bgpPfxCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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:
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:
Deleting Policy Application (Prefix List)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no prefix-list SampleString_123 out
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpPfxCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/pfxctrl-out |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpPfxCtrlP Properties
The following table contains information about the bgpPfxCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Policy Application to Incoming Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
filter-list SampleString_123 in
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpFltrCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-in |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpFltrCtrlP Properties
The following table contains information about the bgpFltrCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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:
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:
Deleting a Policy Application to Incoming Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no filter-list SampleString_123 in
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpFltrCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-in |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpFltrCtrlP Properties
The following table contains information about the bgpFltrCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Policy Application (Filter List)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
filter-list SampleString_123 out
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpFltrCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-out |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpFltrCtrlP Properties
The following table contains information about the bgpFltrCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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:
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:
Deleting Policy Application (Filter List)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no filter-list SampleString_123 out
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpFltrCtrlP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/fltrctrl-out |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpFltrCtrlP Properties
The following table contains information about the bgpFltrCtrlP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring BGP Connection Restart After a Limit is Exceeded
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
maximum-prefix 1 4 restart 27129
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpMaxPfxP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpMaxPfxP Properties
The following table contains information about the bgpMaxPfxP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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:
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:
Deleting BGP Connection Restart After a Limit is Exceeded
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no maximum-prefix 1 4 restart 27129
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpMaxPfxP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpMaxPfxP Properties
The following table contains information about the bgpMaxPfxP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Warning Message When a Limit is Exceeded
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
maximum-prefix 1 4 warning-only
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpMaxPfxP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpMaxPfxP Properties
The following table contains information about the bgpMaxPfxP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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:
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:
Deleting a Warning Message When a Limit is Exceeded
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no maximum-prefix 1 4 warning-only
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpMaxPfxP | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast/maxpfxp |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
bgpMaxPfxP Properties
The following table contains information about the bgpMaxPfxP properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Minimum Interval Between Sending BGP Routing Updates
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
advertisement-interval 219
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Minimum Interval Between Sending BGP Routing Updates
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no advertisement-interval 219
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Our Address as Nexthop for All Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
next-hop-self all
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Our Address as Nexthop for All Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no next-hop-self all
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring to Not Advertise Additional Paths (Send Capability)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
capability additional-paths send disable
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
capAddlPaths | bgp:CapAddlPathCapT (scalar:Bitmask8) | Capability Additional Paths | SELECTION: 1 - send 2 - recv 4 - send-disable 8 - recv-disable |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting to Not Advertise Additional Paths (Send Capability)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no capability additional-paths send disable
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
capAddlPaths | bgp:CapAddlPathCapT (scalar:Bitmask8) | Capability Additional Paths | SELECTION: 1 - send 2 - recv 4 - send-disable 8 - recv-disable |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring to Not Advertise Additional Paths (Receive Capability)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
capability additional-paths receive disable
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
capAddlPaths | bgp:CapAddlPathCapT (scalar:Bitmask8) | Capability Additional Paths | SELECTION: 1 - send 2 - recv 4 - send-disable 8 - recv-disable |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting to Not Advertise Additional Paths (Receive Capability)
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no capability additional-paths receive disable
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
capAddlPaths | bgp:CapAddlPathCapT (scalar:Bitmask8) | Capability Additional Paths | SELECTION: 1 - send 2 - recv 4 - send-disable 8 - recv-disable |
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 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Route Map to Selectively Unsuppress Suppressed Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
unsuppress-map SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
unSupprMap | string:Basic | Route-map to selectively unsuppress suppressed routes | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Route Map to Selectively Unsuppress Suppressed Routes
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
router bgp 100
neighbor ethernet 1/2
address-family vpnv4 unicast
no unsuppress-map SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpPeerIf | sys/bgp/inst/dom-default/peerif-[eth1/2] |
bgpPeerAf | sys/bgp/inst/dom-default/peerif-[eth1/2]/af-vpnv4-ucast |
bgpInst Properties
The following table contains information about the bgpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property 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 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>DEFAULT: ipv4-ucast |
unSupprMap | string:Basic | Route-map to selectively unsuppress suppressed routes | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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: