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 Neighbor Changes

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpLogging": {
                "attributes": {
                  "nbrChanges": "yes"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <logging-items>
      <nbrChanges>true</nbrChanges>
    </logging-items>
  </ldp-items>
</System>

Configuring LDP Logging

Configuring Neighbor Changes

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
logging neighbor-changes

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
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

The following table contains information about the mplsldpLogging 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
nbrChanges	scalar:Bool	Log LDP neighbor state changes	SELECTION: true or false DEFAULT: true

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 Neighbor Changes

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

CLI Commands

mpls ldp configuration
no logging neighbor-changes

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
nbrChanges	scalar:Bool	Log LDP neighbor state changes	SELECTION: true or false DEFAULT: true

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 Password Configuration Logging

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

CLI Commands

mpls ldp configuration
logging password configuration

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
config	scalar:Bool	Log LDP password configuration changes	SELECTION: true or false DEFAULT: true
configRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password configuration rate limit	RANGE: [0 , 60] 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

Deleting Password Configuration Logging

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

CLI Commands

mpls ldp configuration
no logging password configuration

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
config	scalar:Bool	Log LDP password configuration changes	SELECTION: true or false DEFAULT: true
configRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password configuration rate limit	RANGE: [0 , 60] 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 Password Configuration Rate-Limit Logging

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

CLI Commands

mpls ldp configuration
logging password configuration rate-limit 30

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
config	scalar:Bool	Log LDP password configuration changes	SELECTION: true or false DEFAULT: true
configRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password configuration rate limit	RANGE: [0 , 60] 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

Deleting Password Configuration Rate-Limit Logging

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

CLI Commands

mpls ldp configuration
no logging password configuration rate-limit 30

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
config	scalar:Bool	Log LDP password configuration changes	SELECTION: true or false DEFAULT: true
configRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password configuration rate limit	RANGE: [0 , 60] 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 Password Rollover Logging

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

CLI Commands

mpls ldp configuration
logging password rollover

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
rollover	scalar:Bool	Log LDP password rollover events	SELECTION: true or false DEFAULT: true
rolloverRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password rollover rate limit	RANGE: [0 , 60] 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

Deleting Password Rollover Logging

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

CLI Commands

mpls ldp configuration
no logging password rollover

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
rollover	scalar:Bool	Log LDP password rollover events	SELECTION: true or false DEFAULT: true
rolloverRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password rollover rate limit	RANGE: [0 , 60] 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 Password Rollover Rate-Limit Logging

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

CLI Commands

mpls ldp configuration
logging password rollover rate-limit 30

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
rollover	scalar:Bool	Log LDP password rollover events	SELECTION: true or false DEFAULT: true
rolloverRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password rollover rate limit	RANGE: [0 , 60] 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

Deleting Password Rollover Rate-Limit Logging

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

CLI Commands

mpls ldp configuration
no logging password rollover rate-limit 30

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpLogging	sys/ldp/logging

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

mplsldpLogging Properties

Property Name	Data Type	Description	Values
rollover	scalar:Bool	Log LDP password rollover events	SELECTION: true or false DEFAULT: true
rolloverRateLimit	mplsldp:RateLimit (scalar:Uint16)	LDP logging password rollover rate limit	RANGE: [0 , 60] 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