Configuring UDLD

UDLD is configured at global config level and/or under each interfaces. It monitors a physical connection to detect unidirectional links to avoid spanning-tree topology loops or silent drop traffic.

You can configure normal unidirectional link detection (UDLD) modes for Ethernet interfaces on devices configured to run UDLD.

Before you can enable a UDLD mode for an interface, you must make sure that UDLD is already enabled on the device that includes the interface. UDLD must also be enabled on the other linked interface and its device.

This section contains payload examples to demonstrate how to use the NX-API REST API to configure UDLD on the Cisco Nexus 3000 and 9000 Series switches.

Enabling UDLD

Enabling UDLD
POST http://<IP_Address>/api/node/mo/sys/fm.json
{
  "fmEntity": {
    "children": [
      {
        "fmUdld": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}
{
    "imdata": []
}
<System>
  <fm-items>
    <udld-items>
      <adminSt>enabled</adminSt>
    </udld-items>
  </fm-items>
</System>

Enables UDLD for the device.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

feature udld

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.

MODN
fmEntity sys/fm
fmUdld sys/fm/udld


fmUdld Properties

The following table contains information about the fmUdld properties in the DME 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
adminStfm:AdminState
(scalar:Enum8)
Admin statusSELECTION:
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

Disabling UDLD

Disabling UDLD
POST http://<IP_Address>/api/node/mo/sys/fm.json
{
  "fmEntity": {
    "children": [
      {
        "fmUdld": {
          "attributes": {
            "adminSt": "disabled"
}}}]}}
{
    "imdata": []
}
<System>
  <fm-items>
    <udld-items>
      <adminSt>enabled</adminSt>
    </udld-items>
  </fm-items>
</System>

Disables UDLD for the device.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

no feature udld

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.

MODN
fmEntity sys/fm
fmUdld sys/fm/udld


fmUdld Properties

The following table contains information about the fmUdld properties in the DME 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
adminStfm:AdminState
(scalar:Enum8)
Admin statusSELECTION:
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

Enabling UDLD Aggressive Mode at the Global Level

Enabling UDLD Aggressive Mode at the Global Level
POST http://<IP_Address>/api/mo/sys/udld/inst.json
{
  "udldInst": {
     "attributes": {
        "aggressive": "enabled"
     }
   }
}
{
    "imdata": []
}
<System>
  <udld-items>
    <inst-items>
      <aggressive>enabled</aggressive>
    </inst-items>
  </udld-items>
</System>

Enables UDLD aggressive mode at the global level.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

udld aggressive

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.

MODN
udldInst sys/udld/inst


udldInst Properties

The following table contains information about the udldInst properties in the DME 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
aggressiveudld:AdminSt
(scalar:Enum8)
Global Aggressive ModeSELECTION:
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

Specifying UDLD Aggressive

Specifying UDLD Aggressive
POST http://<IP_Address>/api/node/mo/sys/udld/inst.json
{
"udldInst": {
    "attributes": {
        "adminSt": "enabled",
        "aggressive": "enabled",
        "childAction": "",
        "ctrl": "",
        "dn": "sys/udld/inst",
        "status": ""
}}}
{
    imdata": []
}

Enables UDLD in aggressive mode.

Note: For copper interfaces, you enter the interface command mode for those interfaces you want to configure for UDLD aggressive mode and issue this command in interface command model.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

udld aggressive

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.

MODN
udldInst sys/udld/inst


udldInst Properties

The following table contains information about the udldInst properties in the DME 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
adminSt
nw:AdminSt
scalar:Enum8
The administrative state of the object or policy.SELECTION:
  • 1 - enabled
  • 2 - disabled
  • DEFAULT: enabled(1)
  • aggressiveudld:AdminSt
    (scalar:Enum8)
    Global Aggressive ModeSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32
    Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
  • ctrl
    nw:InstCtrl
    scalar:Bitmask64
    The control state.SELECTION:
  • 1ull - stateful-ha
  • DEFAULT: 0
  • dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    statusmo: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

    No UDLD Aggressive

    No UDLD Aggressive
    
    POST http://<IP_Address>/api/node/mo/sys/udld/inst.json
    
    {
        "udldInst": {
            "attributes": {
                "adminSt": "enabled",
                "aggressive": "disabled",
                "childAction": "",
                "ctrl": "",
                "dn": "sys/udld/inst",
                "status": ""
    }}
    
    {
        imdata": []
    }
    

    Disables aggressive mode UDLD.


    CLI Command

    The CLI command below is the equivalent to the payload example displayed in the pane on the right.

    no udld aggressive

    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.

    MODN
    udldInst sys/udld/inst


    udldInst Properties

    The following table contains information about the udldInst properties in the DME 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
    adminSt
    nw:AdminSt
    scalar:Enum8
    The administrative state of the object or policy.SELECTION:
  • 1 - enabled
  • 2 - disabled
  • DEFAULT: enabled(1)
  • aggressiveudld:AdminSt
    (scalar:Enum8)
    Global Aggressive ModeSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32
    Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
  • ctrl
    nw:InstCtrl
    scalar:Bitmask64
    The control state.SELECTION:
  • 1ull - stateful-ha
  • DEFAULT: 0
  • dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    statusmo: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

    Enabling UDLD Aggressive at the Interface Level

    Enabling UDLD Aggressive at the Interface Level
    
    POST http://{{mgmt-ip}}/api/node/mo/sys/udld/inst.json
    
    {
      "udldInst": {
        "children": [
          {
            "udldPhysIf": {
              "attributes": {
                "aggressive": "enabled",
                "biDirDetect": "port-default",
                "id": "eth1/8"
    }}}]}}
    
            
    
    {
        imdata": []
    }
    
    <System>
      <udld-items>
        <inst-items>
          <physif-items>
            <PhysIf-list>
              <id>eth1/8</id>
              <aggressive>enabled</aggressive>
              <biDirDetect>port-default</biDirDetect>
            </PhysIf-list>
          </physif-items>
        </inst-items>
      </udld-items>
    </System>
    

    Enables UDLD aggressive for an ethernet interface.


    CLI Commands

    The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

    interface ethernet1/8
     udld aggressive

    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.

    MODN
    udldInst sys/udld/inst
    udldPhysIf sys/udld/inst/physif-{[id]}


    udldPhysIf Properties

    The following table contains information about the udldPhysIf properties in the DME 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
    aggressiveudld:AdminSt
    (scalar:Enum8)
    Interface Aggressive ModeSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    biDirDetectudld:PortEnable
    (scalar:Enum8)
    Bidirectional Detection EnabledSELECTION:
    0 - port-enabled
    1 - port-fiber-disabled
    2 - port-default
    3 - port-default-disable
    DEFAULT: port-default
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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 UDLD at the Interface Level

    Disabling UDLD at the Interface Level
    
    POST http://{{mgmt-ip}}/api/node/mo/sys/udld/inst.json
    
    {
      "udldInst": {
        "children": [
          {
            "udldPhysIf": {
              "attributes": {
                "aggressive": "disabled",
                "id": "eth1/8"
    }}}]}}
    
    
    {
        imdata": []
    }
    
    <System>
      <udld-items>
        <inst-items>
          <physif-items>
            <PhysIf-list>
              <id>eth1/8</id>
              <aggressive>disabled</aggressive>
            </PhysIf-list>
          </physif-items>
        </inst-items>
      </udld-items>
    </System>
    

    Disables UDLD aggressive for an interface.


    CLI Commands

    The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

    interface ethernet1/8
     no udld aggressive

    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.

    MODN
    udldInst sys/udld/inst
    udldPhysIf sys/udld/inst/physif-{[id]}


    udldPhysIf Properties

    The following table contains information about the udldPhysIf properties in the DME 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
    aggressiveudld:AdminSt
    (scalar:Enum8)
    Interface Aggressive ModeSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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

    Enabling UDLD on Copper Ports

    Enabling UDLD on Copper Ports
    
    POST http://{{mgmt-ip}}/api/node/mo/sys/udld/inst.json
    
    {
      "udldInst": {
        "children": [
          {
            "udldPhysIf": {
              "attributes": {
                "aggressive": "disabled",
                "biDirDetect": "port-enabled",
                "id": "eth1/8"
    }}}]}}
    
    
    {
        imdata": []
    }
    
    <System>
      <udld-items>
        <inst-items>
          <physif-items>
            <PhysIf-list>
              <id>eth1/8</id>
              <aggressive>disabled</aggressive>
              <biDirDetect>port-enabled</biDirDetect>
            </PhysIf-list>
          </physif-items>
        </inst-items>
      </udld-items>
    </System>
    

    Enables UDLD on copper ports.


    CLI Commands

    The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

    uinterface ethernet1/8
     udld enable

    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.

    MODN
    udldInst sys/udld/inst
    udldPhysIf sys/udld/inst/physif-{[id]}


    udldPhysIf Properties

    The following table contains information about the udldPhysIf properties in the DME 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
    aggressiveudld:AdminSt
    (scalar:Enum8)
    Interface Aggressive ModeSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    biDirDetectudld:PortEnable
    (scalar:Enum8)
    Bidirectional Detection EnabledSELECTION:
    0 - port-enabled
    1 - port-fiber-disabled
    2 - port-default
    3 - port-default-disable
    DEFAULT: port-default
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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

    Enabling UDLD on Fiber Ports

    Enabling UDLD on Fiber Ports
    
    POST http://{{mgmt-ip}}/api/node/mo/sys/udld/inst.json
    
    {
      "udldInst": {
        "children": [
          {
            "udldPhysIf": {
              "attributes": {
                "biDirDetect": "port-enabled",
                "id": "eth1/8"
    }}}]}}
    
    {
        imdata": []
    }
    
    <System>
      <udld-items>
        <inst-items>
          <physif-items>
            <PhysIf-list>
              <id>eth1/8</id>
              <aggressive>disabled</aggressive>
              <biDirDetect>port-enabled</biDirDetect>
            </PhysIf-list>
          </physif-items>
        </inst-items>
      </udld-items>
    </System>
    

    Enables UDLD on fiber ports.


    CLI Commands

    The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

    uinterface ethernet1/8
     no udld enable

    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.

    MODN
    udldInst sys/udld/inst
    udldPhysIf sys/udld/inst/physif-{[id]}


    udldPhysIf Properties

    The following table contains information about the udldPhysIf properties in the DME 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
    biDirDetectudld:PortEnable
    (scalar:Enum8)
    Bidirectional Detection EnabledSELECTION:
    0 - port-enabled
    1 - port-fiber-disabled
    2 - port-default
    3 - port-default-disable
    DEFAULT: port-default
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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 UDLD on Fiber Port

    Disabling UDLD on Fiber Ports
    
    POST http://{{mgmt-ip}}/api/node/mo/sys/udld/inst.json
    
    {
      "udldInst": {
        "children": [
          {
            "udldPhysIf": {
              "attributes": {
                "aggressive": "disabled",
                "biDirDetect": "port-fiber-disabled",
                "id": "eth1/8"
    }}}]}
    
    {
        imdata": []
    }
    
    <System>
      <udld-items>
        <inst-items>
          <physif-items>
            <PhysIf-list>
              <id>eth1/8</id>
              <aggressive>disabled</aggressive>
              <biDirDetect>port-fiber-disabled</biDirDetect>
            </PhysIf-list>
          </physif-items>
        </inst-items>
      </udld-items>
    </System>
    

    Disables UDLD on fiber ports.


    CLI Commands

    The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

    interface ethernet1/8
     udld disable

    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.

    MODN
    udldInst sys/udld/inst
    udldPhysIf sys/udld/inst/physif-{[id]}


    udldPhysIf Properties

    The following table contains information about the udldPhysIf properties in the DME 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
    aggressiveudld:AdminSt
    (scalar:Enum8)
    Interface Aggressive ModeSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: disabled
    biDirDetectudld:PortEnable
    (scalar:Enum8)
    Bidirectional Detection EnabledSELECTION:
    0 - port-enabled
    1 - port-fiber-disabled
    2 - port-default
    3 - port-default-disable
    DEFAULT: port-default
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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

    Enabling UDLD on Fiber Ports

    Enabling UDLD on Fiber Ports 
    
    POST http://{{mgmt-ip}}/api/node/mo/sys/udld/inst.json
    
    {
      "udldInst": {
        "children": [
          {
            "udldPhysIf": {
              "attributes": {
                "biDirDetect": "port-default",
                "id": "eth1/8"
    }}}]}}
    
    {
        imdata": []
    }
    
    <System>
      <udld-items>
        <inst-items>
          <physif-items>
            <PhysIf-list>
              <id>eth1/8</id>
              <biDirDetect>port-default</biDirDetect>
            </PhysIf-list>
          </physif-items>
        </inst-items>
      </udld-items>
    </System>
    

    Enables UDLD on fiber ports.


    CLI Commands

    The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

    interface ethernet1/8
     no udld disable

    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.

    MODN
    udldInst sys/udld/inst
    udldPhysIf sys/udld/inst/physif-{[id]}


    udldPhysIf Properties

    The following table contains information about the udldPhysIf properties in the DME 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
    biDirDetectudld:PortEnable
    (scalar:Enum8)
    Bidirectional Detection EnabledSELECTION:
    0 - port-enabled
    1 - port-fiber-disabled
    2 - port-default
    3 - port-default-disable
    DEFAULT: port-default
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    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

    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 UDLD for any Interface

    Configuring UDLD for any Interface
    
    POST http://<IP_Address>/api/mo/sys/udld/inst.json
    
    {
    "udldInst": {
        "children" : [{
            "udldPhysIf" : {
                "attributes" : {
                    "id" : "eth1/2"
                        "aggressive": "2"
                        "biDirDetect": "0"
    }}}]}}
    
    {
        imdata": []
    }
    


    Related Documentation

    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 in Seconds Between UDLD Probe Messages

    Configuring the Time in Seconds Between UDLD Probe Messages
    
    POST http://<mgmt0_IP>/api/mo/sys/udld.json
    
    {
      "udldEntity": {
        "children": [
          {
            "udldInst": {
              "attributes": {
                "msgIntvl": "10"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <udld-items>
        <inst-items>
          <msgIntvl>10</msgIntvl>
        </inst-items>
      </udld-items>
    </System>
    

    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.

    udld message-time 10


    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
    udldEntity sys/udld
    udldInst sys/udld/inst


    udldInst Properties

    The following table contains information about the udldInst properties in the DME 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
    msgIntvludld:MsgIntvl
    (scalar:UByte)
    Probe Message Interval
    RANGE: [7 , 90]
    DEFAULT: 15


    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 in Seconds Between UDLD Probe Messages

    Deleting the Time in Seconds Between UDLD Probe Messages
    
    POST http://<mgmt0_IP>/api/mo/sys/udld.json
    
    {
      "udldEntity": {
        "children": [
          {
            "udldInst": {
              "attributes": {
                "msgIntvl": "15"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <udld-items>
        <inst-items>
          <msgIntvl>15</msgIntvl>
        </inst-items>
      </udld-items>
    </System>
    

    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.

    no udld message-time 10


    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
    udldEntity sys/udld
    udldInst sys/udld/inst


    udldInst Properties

    The following table contains information about the udldInst properties in the DME 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
    msgIntvludld:MsgIntvl
    (scalar:UByte)
    Probe Message Interval
    RANGE: [7 , 90]
    DEFAULT: 15


    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