Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Configuring the LDP Hello Holdtime
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpHoldTime": {
                "attributes": {
                  "infinite": "no",
                  "sessionHoldTime": "190"
}}}]}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <holdtime-items>
      <infinite>false</infinite>
      <sessionHoldTime>190</sessionHoldTime>
    </holdtime-items>
  </ldp-items>
</System>

Configuring LDP Holdtime

Configuring the LDP Hello Holdtime

Configuring the LDP Hello Holdtime

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.

mpls ldp configuration
  holdtime 190


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
topSystem sys
mplsldpLDP sys/ldp
mplsldpHoldTime sys/ldp/holdtime


mplsldpLDP Properties

The following table contains information about the mplsldpLDP 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
adminStnw:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


mplsldpHoldTime Properties

The following table contains information about the mplsldpHoldTime 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
infinitescalar:Bool
Ignore LDP session holdtimeSELECTION: true or false
DEFAULT: false
sessionHoldTimemplsldp:SessionHoldTime
(scalar:Uint16)		LDP session holdtime specifies how long an LDP session is maintained in the absence of LDP messages from the session peer. The range is from 15 to 65535 seconds
RANGE: [15 , 65535]
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 LDP Hello Holdtime

Deleting the LDP Hello Holdtime

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.

mpls ldp configuration
  no holdtime 190


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
topSystem sys
mplsldpLDP sys/ldp
mplsldpHoldTime sys/ldp/holdtime


mplsldpLDP Properties

The following table contains information about the mplsldpLDP 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
adminStnw:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


mplsldpHoldTime Properties

The following table contains information about the mplsldpHoldTime 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
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

Configuring Infinite LDP Session Holdtime

Configuring Infinite LDP Session Holdtime

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.

mpls ldp configuration
  holdtime infinite


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
topSystem sys
mplsldpLDP sys/ldp
mplsldpHoldTime sys/ldp/holdtime


mplsldpLDP Properties

The following table contains information about the mplsldpLDP 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
adminStnw:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


mplsldpHoldTime Properties

The following table contains information about the mplsldpHoldTime 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
infinitescalar:Bool
Ignore LDP session holdtimeSELECTION: true or false
DEFAULT: false
sessionHoldTimemplsldp:SessionHoldTime
(scalar:Uint16)		LDP session holdtime specifies how long an LDP session is maintained in the absence of LDP messages from the session peer. The range is from 15 to 65535 seconds
RANGE: [15 , 65535]
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 Infinite LDP Session Holdtime

Deleting Infinite LDP Session Holdtime

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.

mpls ldp configuration
  no holdtime infinite


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
topSystem sys
mplsldpLDP sys/ldp
mplsldpHoldTime sys/ldp/holdtime


mplsldpLDP Properties

The following table contains information about the mplsldpLDP 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
adminStnw:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


mplsldpHoldTime Properties

The following table contains information about the mplsldpHoldTime 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
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

Next