Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Loop Detection

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
    </loopdetection-items>
  </ngoam-items>
</System>

Loop prevention and detection in VxLAN EVPN

For more information, see the Cisco Nexus 9000 Series NX-OS VXLAN Configuration Guide.

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

Configuring Loop Detection

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

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.

ngoam loop-detection

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
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection

ngoamLoopDetection Properties

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

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false

Related Documentation

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

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

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

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

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

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

Disabling Loop Detection

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

CLI Commands

no ngoam loop-detection

Verifying a DME Configuration

MO	DN
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection

ngoamLoopDetection Properties

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false

Related Documentation

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

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

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

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

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

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

Disabling Detection on a VLAN

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

CLI Commands

ngoam loop-detection
disable vlan 100

Verifying a DME Configuration

MO	DN
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection
ngoamDisabled	sys/ngoam/loopdetection/dis-100

ngoamLoopDetection Properties

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false

ngoamDisabled Properties

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

Property Name	Data Type	Description	Values
vlanId	ngoam:VlanRange (string:Basic)	Range of Vlans to disable the loop detection	A sequence of characters DEFAULT: 0

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 Loop Detection Probe Interval

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

CLI Commands

ngoam loop-detection
periodic-probe-interval 100

Verifying a DME Configuration

MO	DN
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection

ngoamLoopDetection Properties

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false
periodicProbeInterval	ngoam:SLDperiodicprobeinterval (scalar:Uint32)	Loop detection periodic probe interval value	RANGE: [60 , 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

Deleting the Configured Loop Detection Probe Interval

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

CLI Commands

ngoam loop-detection
no periodic-probe-interval 100

Verifying a DME Configuration

MO	DN
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection

ngoamLoopDetection Properties

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false
periodicProbeInterval	ngoam:SLDperiodicprobeinterval (scalar:Uint32)	Loop detection periodic probe interval value	RANGE: [60 , 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 Time Interval to Send Recovery Probes

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

CLI Commands

ngoam loop-detection
port-recovery-interval 100

Verifying a DME Configuration

MO	DN
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection

ngoamLoopDetection Properties

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false
portRecoveryInterval	ngoam:SLDportrecoveryinterval (scalar:Uint32)	loop detection port recovery interval value	RANGE: [30 , 3600] DEFAULT: 180

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 Time Interval to Send Recovery Probes

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

CLI Commands

ngoam loop-detection
no port-recovery-interval 100

Verifying a DME Configuration

MO	DN
ngoamEntity	sys/ngoam
ngoamLoopDetection	sys/ngoam/loopdetection

ngoamLoopDetection Properties

Property Name	Data Type	Description	Values
enable	scalar:Bool	enable/disable loop detection feature	SELECTION: true or false
portRecoveryInterval	ngoam:SLDportrecoveryinterval (scalar:Uint32)	loop detection port recovery interval value	RANGE: [30 , 3600] DEFAULT: 180