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

Configuring LDP Discovery Hello Interval

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpDiscovery": {
                "children": [
                  {
                    "mplsldpDiscoveryHello": {
                      "attributes": {
                        "helloIntvl": "10"
}}}]}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <discovery-items>
      <discoveryhello-items>
        <helloIntvl>10</helloIntvl>
      </discoveryhello-items>
    </discovery-items>
  </ldp-items>
</System>

Configuring LDP Discovery

Configuring LDP Discovery Hello Interval

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
discovery hello interval 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.

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryHello	sys/ldp/discovery/discoveryhello

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 Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryHello Properties

The following table contains information about the mplsldpDiscoveryHello 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
helloIntvl	mplsldp:IntvlTime (scalar:Uint16)	LDP discovery Hello interval defines the period of time between the sending of consecutive hello messages. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] DEFAULT: 5

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 LDP Discovery Hello Interval

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

CLI Commands

mpls ldp configuration
no discovery hello interval 10

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryHello	sys/ldp/discovery/discoveryhello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryHello Properties

Property Name	Data Type	Description	Values
helloIntvl	mplsldp:IntvlTime (scalar:Uint16)	LDP discovery Hello interval defines the period of time between the sending of consecutive hello messages. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] DEFAULT: 5

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 to Respond to Requests for Targeted-Hello Messages from All Neighbors

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

CLI Commands

mpls ldp configuration
discovery targeted-hello accept

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello
mplsldpDisTgtHelloAccept	sys/ldp/discovery/discoverytgthello/distgthelloaccept

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDisTgtHelloAccept Properties

The following table contains information about the mplsldpDisTgtHelloAccept 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
accept	scalar:Bool	The accept property configures the router to respond to requests for targeted-hello messages from all neighbors	SELECTION: true or false DEFAULT: true
pfxList	mplsldp:LdpPrefixListName (string:Basic)	Neighbor prefix list to specify acceptable targeted hello sources	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

Deleting the Router to Respond to Requests for Targeted-Hello Messages from All Neighbors

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

CLI Commands

mpls ldp configuration
no discovery targeted-hello accept

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello
mplsldpDisTgtHelloAccept	sys/ldp/discovery/discoverytgthello/distgthelloaccept

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDisTgtHelloAccept 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 to Respond to Requests for Targeted-Hello Messages from Neighbors Specified by the Prefix List

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

CLI Commands

mpls ldp configuration
discovery targeted-hello accept from prefix

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello
mplsldpDisTgtHelloAccept	sys/ldp/discovery/discoverytgthello/distgthelloaccept

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDisTgtHelloAccept Properties

Property Name	Data Type	Description	Values
pfxList	mplsldp:LdpPrefixListName (string:Basic)	Neighbor prefix list to specify acceptable targeted hello sources	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

Deleting the Router to Respond to Requests for Targeted-Hello Messages from Neighbors Specified by the Prefix List

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

CLI Commands

mpls ldp configuration
no discovery targeted-hello accept from prefix

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello
mplsldpDisTgtHelloAccept	sys/ldp/discovery/discoverytgthello/distgthelloaccept

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDisTgtHelloAccept 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 Discovery Hello Holdtime for Nondirectly Connected LDP Sessions

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

CLI Commands

mpls ldp configuration
discovery targeted-hello holdtime 50

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryTgtHello Properties

The following table contains information about the mplsldpDiscoveryTgtHello 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
tgtHelloHoldtime	mplsldp:TgtHoldTime (scalar:Uint16)	LDP discovery Targeted Hello holdtime defines the period of time that a discovered LDP neighbor is remembered without receipt of an LDP hello message from the neighbor. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] DEFAULT: 90

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 Discovery Hello Holdtime for Nondirectly Connected LDP Sessions

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

CLI Commands

mpls ldp configuration
no discovery targeted-hello holdtime 50

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryTgtHello Properties

Property Name	Data Type	Description	Values
tgtHelloHoldtime	mplsldp:TgtHoldTime (scalar:Uint16)	LDP discovery Targeted Hello holdtime defines the period of time that a discovered LDP neighbor is remembered without receipt of an LDP hello message from the neighbor. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] DEFAULT: 90

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 Discovery Hello Interval for Nondirectly Connected LDP Sessions

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

CLI Commands

mpls ldp configuration
discovery targeted-hello interval 15

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryTgtHello Properties

Property Name	Data Type	Description	Values
tgtHelloIntvl	mplsldp:TgtIntvlTime (scalar:Uint16)	LDP discovery Targeted Hello interval defines the period of time between the sending of consecutive hello messages. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] DEFAULT: 10

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 Discovery Hello Interval for Nondirectly Connected LDP Sessions

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

CLI Commands

mpls ldp configuration
no discovery targeted-hello interval 15

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryTgtHello	sys/ldp/discovery/discoverytgthello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryTgtHello Properties

Property Name	Data Type	Description	Values
tgtHelloIntvl	mplsldp:TgtIntvlTime (scalar:Uint16)	LDP discovery Targeted Hello interval defines the period of time between the sending of consecutive hello messages. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] DEFAULT: 10

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 LDP Discovery Hello Holdtime

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

CLI Commands

mpls ldp configuration
discovery hello holdtime 100

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryHello	sys/ldp/discovery/discoveryhello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryHello Properties

Property Name	Data Type	Description	Values
helloHoldtime	mplsldp:HelloHoldTime (scalar:Uint16)	LDP discovery Hello holdtime defines the period of time that a discovered LDP neighbor is remembered without receipt of an LDP hello message from the neighbor. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] 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 LDP Discovery Hello Holdtime

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

CLI Commands

mpls ldp configuration
no discovery hello holdtime 100

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpDiscovery	sys/ldp/discovery
mplsldpDiscoveryHello	sys/ldp/discovery/discoveryhello

mplsldpLDP Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

mplsldpDiscoveryHello Properties

Property Name	Data Type	Description	Values
helloHoldtime	mplsldp:HelloHoldTime (scalar:Uint16)	LDP discovery Hello holdtime defines the period of time that a discovered LDP neighbor is remembered without receipt of an LDP hello message from the neighbor. The range is from 1 to 65535 seconds	RANGE: [1 , 65535] 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