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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Creating a BGP Instance

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
 "bgpEntity": {
   "children": [
     {
       "bgpInst": {
         "attributes": {
           "asn": "100"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
    </inst-items>
  </bgp-items>
</System>

Configuring a BGP Router

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

Creating a BGP Instance

This example enables BGP and assigns the AS number to the local BGP speaker. The AS number can be a 16-bit integer or a 32-bit integer in the form of a higher 16-bit decimal number and a lower 16-bit decimal number in xx.xx format.

Issue an HTTP GET request to verify that the configuration was successful. See Verifying a BGP Instance.

CLI Command

The CLI command below is the equivalent of the payload example displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

router bgp 100

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

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst

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

Related Documentation

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

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

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

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

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

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

Verifying a BGP Instance

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

MO	DN
bgpInst	sys/bgp/inst

bgpInst Properties

Property Name	Data Type	Description	Values
activateTs	scalar:Date	Activation timestamp	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
affGrpActv	bgp:AffGrpActv (scalar:Uint16)	Activate the affinity group	RANGE: [0 , 65535]
asPathDbSz	bgp:AsPathDbSz (scalar:Uint32)	Current size of AS path database	RANGE: [0, 4294967295]
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters
attribDbSz	bgp:AttribDbSz (scalar:Uint32)	Current size of attribute database	RANGE: [0, 4294967295]
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
createTs	scalar:Date	Creation timestamp	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
ctrl	nw:InstCtrl (scalar:Bitmask64)	The control state.	SELECTION: 1 - stateful-ha DEFAULT: fastExtFallover
disPolBatch	bgp:AdminSt (scalar:Enum8)	Disable Batching Evaluation To All Peers	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
disPolBatchv4PfxLst	string:Basic	Disable Batching Evaluation Of IPv4 Prefix Advertisements To All Peers	A sequence of characters
disPolBatchv6PfxLst	string:Basic	Disable Batching Evaluation Of IPv6 Prefix Advertisements To All Peers	A sequence of characters
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
epeActivePeers	bgp:NumPeers (scalar:Uint32)	EPE Active Peers	RANGE: [0, 4294967295]
epeConfiguredPeers	bgp:NumPeers (scalar:Uint32)	EPE Configured Peers	RANGE: [0, 4294967295]
fabricSoo	base:Community	Fabric Site of Origin extcommunity
flushRoutes	bgp:AdminSt (scalar:Enum8)	Flush routes in RIB upon controlled restart	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
isolate	bgp:AdminSt (scalar:Enum8)	Isolate router from BGP perspective	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
lnkStClnt	bgp:LsAdminSt (scalar:Enum8)	EPE Link-State Server	SELECTION: 0 - inactive 1 - active DEFAULT: inactive
lnkStSrvr	bgp:LsAdminSt (scalar:Enum8)	EPE Link-State Server	SELECTION: 0 - inactive 1 - active DEFAULT: inactive
medDampIntvl	bgp:MedIntvl (scalar:Uint32)	Setting med dampening interval	RANGE: [0 , 4294967295]
memAlert	nw:MemAlertLevel (scalar:Enum8)	Memory Alert Level	SELECTION: 0 - normal 1 - minor 2 - major 3 - critical DEFAULT: normal
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128 DEFAULT: bgp
numAsPath	cap:Quant (scalar:Uint16)	The number of autonomous system (AS) path entries learned.	RANGE: [0 , 0xFFFF] DEFAULT: 0
numRtAttrib	cap:Quant (scalar:Uint16)	The number of route attribute entries learned.	RANGE: [0 , 0xFFFF] DEFAULT: 0
operErr	nw:OperErrQual (scalar:Bitmask64)	Operational Errors Qualifier	SELECTION: 1 - init-err 2 - mem-err 4 - ipc-err 8 - int-err 16 - sock-err 32 - proto-err
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
snmpTrapSt	snmp:SnmpTrapSt scalar:Enum8	Administrative port snmp trap state	SELECTION: 1 - enable 2 - disable DEFAULT: disable(2)
srgbMaxLbl	bgp:SRGBRange (scalar:Uint32)	Segment Routing Global Block Max Label. (Value should be in the range 16000-471804 when feature segment-routing is enabled.	RANGE: [0 , 471804] DEFAULT: none
srgbMinLbl	bgp:SRGBRange (scalar:Uint32)	Segment Routing Global Block Min Label. (Value should be in the range 16000-471804 when feature segment-routing is enabled.	RANGE: [0 , 471804] DEFAULT: none
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
syslogLvl	syslog:Level scalar:Enum8	syslog level	SELECTION: 0 - emerg 1 - alert 2 - crit 3 - err 4 - warn 5 - notif 6 - inform 7 - debug DEFAULT: err(3)
uid	scalar:Uint16	A unique identifier for this object.
ver	bgp:Ver scalar:Enum8	BGP version.	SELECTION: 4 - v4 DEFAULT: v4(4)
waitDoneTs	scalar:Date	The timestamp when the BGP protocol came out of wait mode.	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z

Related Documentation

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

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

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

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

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

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

Deleting a BGP

This Example demonstrates how to delete a BGP instance.

CLI Commands

no router bgp 100

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

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst

bgpInst Properties

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:

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

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

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

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

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

Configuring the Router Id

This example configures the BGP router ID. This IP address identifies this BGP speaker.

CLI Commands

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

router bgp 100
router-id 1.1.1.1

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}

bgpInst Properties

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
rtrId	ip:RtrId (address:IPv4)	The BGP router ID.	Value must match ipv4 format

Related Documentation

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

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

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

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

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

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

Configuring the Cluster Id

This example configures the local router as one of the route reflectors that serve the cluster. You specify a cluster ID to identify the cluster. This command triggers an automatic soft clear or refresh of BGP neighbor sessions.

CLI Commands

router bgp 100
cluster-id 110

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}

bgpInst Properties

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

bgpDom Properties

Property Name	Data Type	Description	Values
clusterId	bgp:ClusterId (string:Basic)	The BGP route reflector ID (Cluster ID) that identifies the cluster of the route reflector domain.	A sequence of characters
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

Related Documentation

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

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

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

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

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

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

Configuring the Graceful Restart Helper

This example enables the graceful restart helper functionality. Use this command if you have disabled graceful restart but you still want to enable graceful restart helper functionality. This command triggers an automatic notification and session reset for the BGP neighbor sessions.

CLI Commands

router bgp 100
graceful-restart-helper

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpGr	sys/bgp/inst/dom-{name}/gr

bgpInst Properties

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

bgpDom Properties

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

bgpGr Properties

The following table contains information about the bgpGr properties in the DME payload. For more information about 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:GrCtrl (scalar:Bitmask8)	Graceful restart controls	SELECTION: 1 - helper 2 - complete DEFAULT: complete

Related Documentation

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

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

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

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

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

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

Configuring the Graceful Restart Time

This example configures the maximum time for a restart sent to the BGP peer.

CLI Commands

router bgp 100
graceful-restart restart-time 200

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpGr	sys/bgp/inst/dom-{name}/gr

bgpInst Properties

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

bgpDom Properties

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

bgpGr Properties

Property Name	Data Type	Description	Values
restartIntvl	bgp:GrIntvl (scalar:Uint16)	The graceful restart interval.	RANGE: [1 , 3600] DEFAULT: 120

Related Documentation

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

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

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

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

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

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

Configuring the Graceful Restart Stale-Path Time

Configuring the Graceful Restart Stale-path Time

This example configures the maximum time that BGP keeps the stale routes from the restarting BGP peer.

CLI Commands

router bgp 100
graceful-restart stalepath-time 400

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpGr	sys/bgp/inst/dom-{name}/gr

bgpInst Properties

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

bgpDom Properties

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

bgpGr Properties

Property Name	Data Type	Description	Values
staleIntvl	bgp:GrStaleIntvl (scalar:Uint16)	The stale interval for routes advertised by the BGP peer.	RANGE: [1 , 3600] DEFAULT: 300

Related Documentation

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

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

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

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

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

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

Configuring the Confederation Identifier

This example configures a confederation identifier for an AS confederation. This command triggers an automatic notification and session reset for the BGP neighbor sessions.

CLI Commands

router bgp 100
confederation identifier 102

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpConfederation	sys/bgp/inst/dom-{name}/confed

bgpInst Properties

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

bgpDom Properties

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

bgpConfederation Properties

The following table contains information about the bgpConfederation properties in the DME payload. For more information about 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, takes value from (1-4294967295 \	1-65535[.(0-65535)])

Related Documentation

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

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

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

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

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

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

Relaxing AS-Path Restrictions when Choosing Multipath

Allows load sharing across the providers with different (but equal-length) AS paths. Without the as-path multipath-relax option, the AS paths must be identical for load sharing.

CLI Commands

router bgp 100
bestpath as-path multipath-relax

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPathCtrl	sys/bgp/inst/dom-{name}/pathctrl

bgpInst Properties

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

bgpDom Properties

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

bgpPathCtrl Properties

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

Property Name	Data Type	Description	Values
asPathMultipathRelax	bgp:AdminSt (scalar:Enum8)	Relax AS-Path restriction when choosing multipaths	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Comparing the Router Id for Identical EBGP Paths

Compares the router IDs for identical eBGP paths.

CLI Commands

router bgp 100
bestpath compare-routerid

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPathCtrl	sys/bgp/inst/dom-{name}/pathctrl

bgpInst Properties

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

bgpDom Properties

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

bgpPathCtrl Properties

Property Name	Data Type	Description	Values
compRtrId	bgp:AdminSt (scalar:Enum8)	Compare Router Id	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Compare MED on Paths from a Different AS

Compares MED on paths from different autonomous systems.

CLI Commands

router bgp 100
bestpath always-compare-med

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPathCtrl	sys/bgp/inst/dom-{name}/pathctrl

bgpInst Properties

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

bgpDom Properties

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

bgpPathCtrl Properties

Property Name	Data Type	Description	Values
alwaysCompMed	bgp:AdminSt (scalar:Enum8)	Compare MED on paths from different AS	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Configuring the Default Route for Nexthop Address Resolution

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

CLI Commands

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

router bgp 100
nexthop suppress-default-resolution

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

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters
nhSupprDefRes	scalar:Enum8	nexthop suppress-default-resolutionA	enabled or disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Deleting the Default Route for Nexthop Address Resolution

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

CLI Commands

router bgp 100
no nexthop suppress-default-resolution

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters
nhSupprDefRes	scalar:Enum8	nexthop suppress-default-resolutionA	enabled or disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Configuring the Socket History Buffer Size

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

CLI Commands

router bgp 100
event-history socket size 81000

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

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

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Deleting the Socket History Buffer Size

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

CLI Commands

router bgp 100
no event-history socket size 81000

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Configuring the Socket History Buffer Size as Disable

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

CLI Commands

router bgp 100
event-history socket size disable

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Deleting the Socket History Buffer Size as Disable

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

CLI Commands

router bgp 100
no event-history socket size disable

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Configuring the Socket History Buffer Size as Small

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

CLI Commands

router bgp 100
event-history socket size small

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Deleting the Socket History Buffer Size as Small

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

CLI Commands

router bgp 100
no event-history socket size small

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Configuring the Socket History Buffer Size as Medium

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

CLI Commands

router bgp 100
event-history socket size medium

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Deleting the Socket History Buffer Size as Medium

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

CLI Commands

router bgp 100
no event-history socket size medium

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Configuring the Socket History Buffer Size as Large

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

CLI Commands

router bgp 100
event-history socket size large

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Deleting the Socket History Buffer Size as Large

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

CLI Commands

router bgp 100
no event-history socket size large

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst
bgpEvtHist	sys/bgp/inst/evthist-socket

bgpInst Properties

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

bgpEvtHist Properties

Property Name	Data Type	Description	Values
size	bgp:Size (scalar:Uint32)	Configure event-history with buffer size	RANGE: [0 , 4] DEFAULT: default
type	bgp:EhType (scalar:Enum8)	Configure event-history {cli \	events \

Related Documentation

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

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

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

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

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

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

Configuring BGP Enhanced-Error Handling

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

CLI Commands

router bgp 100
enhanced-error

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters
enhancedErr	scalar:Bool	Enable BGP Enhanced Error Handling to prevent inadvertent session resets for minor errors. See RFC7606 for more details	SELECTION: true or false DEFAULT: true

Related Documentation

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

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

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

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

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

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

Deleting BGP Enhanced-Error Handling

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

CLI Commands

router bgp 100
no enhanced-error

Verifying a DME Configuration

MO	DN
bgpEntity	sys/bgp
bgpInst	sys/bgp/inst

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters
enhancedErr	scalar:Bool	Enable BGP Enhanced Error Handling to prevent inadvertent session resets for minor errors. See RFC7606 for more details	SELECTION: true or false DEFAULT: true

Related Documentation

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

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

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

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

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

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