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

Configuring Loop Detection
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes"
}}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
    </loopdetection-items>
  </ngoam-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: 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

Disabling Loop Detection
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "no"
}}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>false</enable>
    </loopdetection-items>
  </ngoam-items>
</System>

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.

no 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.

MODN
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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: 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

Disabling Detection on a VLAN
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes"
          },
          "children": [
            {
              "ngoamDisabled": {
                "attributes": {
                  "vlanId": "100"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
      <dis-items>
        <Disabled-list>
          <vlanId>100</vlanId>
        </Disabled-list>
      </dis-items>
    </loopdetection-items>
  </ngoam-items>
</System>

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
  disable vlan 100


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.

MODN
ngoamEntity sys/ngoam
ngoamLoopDetection sys/ngoam/loopdetection
ngoamDisabled sys/ngoam/loopdetection/dis-100


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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: 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 NameData TypeDescriptionValues
vlanIdngoam:VlanRange
(string:Basic)
Range of Vlans to disable the loop detectionA 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

Configuring the Loop Detection Probe Interval
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes",
            "periodicProbeInterval": "100"
}}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
      <periodicProbeInterval>100</periodicProbeInterval>
    </loopdetection-items>
  </ngoam-items>
</System>

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
  periodic-probe-interval 100


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.

MODN
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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: true or false
periodicProbeIntervalngoam: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

Deleting the Configured Loop Detection Probe Interval
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes",
            "periodicProbeInterval": "300"
}}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
      <periodicProbeInterval>300</periodicProbeInterval>
    </loopdetection-items>
  </ngoam-items>
</System>

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
  no periodic-probe-interval 100


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.

MODN
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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: true or false
periodicProbeIntervalngoam: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

Configuring the Time Interval to Send Recovery Probes
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes",
            "portRecoveryInterval": "100"
}}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
      <portRecoveryInterval>100</portRecoveryInterval>
    </loopdetection-items>
  </ngoam-items>
</System>

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
  port-recovery-interval 100


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.

MODN
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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: true or false
portRecoveryIntervalngoam: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

Deleting the Time Interval to Send Recovery Probes
POST http://<mgmt0_IP>/api/mo/sys/ngoam.json
{
  "ngoamEntity": {
    "children": [
      {
        "ngoamLoopDetection": {
          "attributes": {
            "enable": "yes",
            "portRecoveryInterval": "180"
}}}]}}
{
    imdata:[]
}
<System>
  <ngoam-items>
    <loopdetection-items>
      <enable>true</enable>
      <portRecoveryInterval>180</portRecoveryInterval>
    </loopdetection-items>
  </ngoam-items>
</System>

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
  no port-recovery-interval 100


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.

MODN
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 NameData TypeDescriptionValues
enablescalar:Bool
enable/disable loop detection featureSELECTION: true or false
portRecoveryIntervalngoam: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

Configuring an NGOAM Loop Detection Probe

Configuring an NGOAM Loop Detection Probe
POST: http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys].json
Payload:
{
      "actionLSubj": {
          "attributes": {
              "dn": "sys/action/lsubj-[sys]"
                }
                "children" : [{
                     "ngoamLoopDetectionProbeLTask" : {
                         "attributes" : {
                            "adminSt" : "start",
                            "vlan": "1000",
                            "port": "Ethernet1/40"
                        }

                }
           }]
      }
}
{
    imdata:[]
}

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


CLI Commands

ngoam loop-detection probe {vlan <vlan-range>}[port <port-range>]

Deleting an NGOAM Loop Detection Probe

Deleting an NGOAM Loop Detection Probe
DELETE: http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys]/ngoamLoopDetectionProbeLTask.json

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

Configuring NGOAM Loop Detection Bring Up

Configuring NGOAM Loop Detection Bring Up
POST: http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys].json
{
      "actionLSubj": {
          "attributes": {
              "dn": "sys/action/lsubj-[sys]"
                }
                "children" : [{
                     "ngoamLoopDetectionBringupLTask" : {
                         "attributes" : {
                            "adminSt" : "start",
                            "vlan": "1000",
                            "port": "Ethernet1/40"
                        }

                }
           }]
      }
}
{
    imdata:[]
}

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


CLI Commands

ngoam loop-detection bringup {vlan <vlan-range>}[port <port-range>]

Deleting NGOAM Loop Detection Bring Up

Deleting NGOAM Loop Detection Bring Up
DELETE: http://<mgmt0_IP>/api/mo/sys/action/lsubj-[sys]/ngoamLoopDetectionBringupLTask.json

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