Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the LDP Fallback Password

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpPassword": {
                "children": [
                  {
                    "mplsldpPasswordFallback": {
                      "attributes": {
                        "keyChain": "KeyChainName"
}}}]}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <password-items>
      <passwordfallback-items>
        <keyChain>KeyChainName</keyChain>
      </passwordfallback-items>
    </password-items>
  </ldp-items>
</System>

Configuring an LDP Password

Configuring the LDP Fallback Password

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
password fallback key-chain KeyChainName

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
mplsldpPassword	sys/ldp/password
mplsldpPasswordFallback	sys/ldp/password/passwordfallback

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

mplsldpPasswordFallback Properties

The following table contains information about the mplsldpPasswordFallback 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
keyChain	string:Basic	The key-chain keychain-name keyword-argument pair specifies a keychain of multiple MD5 keys to be used for the LDP sessions.	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 LDP Fallback Password

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

CLI Commands

mpls ldp configuration
no password fallback key-chain KeyChainName

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordFallback	sys/ldp/password/passwordfallback

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

mplsldpPasswordFallback 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 LDP Password Option

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

CLI Commands

mpls ldp configuration
password option 123 for List1 key-chain KeyChainName

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordOption	sys/ldp/password/passwordoption-123

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

mplsldpPasswordOption Properties

The following table contains information about the mplsldpPasswordOption 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
keyChain	string:Basic	Specifies a keychain of multiple MD5 keys to be used for the LDP sessions.	A sequence of characters
pfxList	mplsldp:LdpPrefixListName (string:Basic)	Specifies the name of the prefix list that includes the LDP router IDs of those neighbors for which the password applies	A sequence of characters
seqNum	mplsldp:SeqNum (scalar:Uint16)	The number argument defines the order in which the prefix lists are evaluated in the determination of a neighbor password. The valid range is from 1 to 32767.	RANGE: [1 , 32767]

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 Password Option

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

CLI Commands

mpls ldp configuration
no password option 123 for List1 key-chain KeyChainName

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordOption	sys/ldp/password/passwordoption-123

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

mplsldpPasswordOption Properties

Property Name	Data Type	Description	Values
seqNum	mplsldp:SeqNum (scalar:Uint16)	The number argument defines the order in which the prefix lists are evaluated in the determination of a neighbor password. The valid range is from 1 to 32767.	RANGE: [1 , 32767]
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 LDP Password Required

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

CLI Commands

mpls ldp configuration
password required

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordRequired	sys/ldp/password/passwordrequired

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

mplsldpPasswordRequired Properties

The following table contains information about the mplsldpPasswordRequired 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
reqPfxList	mplsldp:LdpPrefixListName (string:Basic)	Specifies a prefix list, which specifies that a password is mandatory only for LDP sessions with neighbors whose LDP router IDs are permitted by the list	A sequence of characters
required	scalar:Bool	Specifies that LDP must use a password when establishing a session between LDP peers.	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 LDP Password Required

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

CLI Commands

mpls ldp configuration
no password required

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordRequired	sys/ldp/password/passwordrequired

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

mplsldpPasswordRequired 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 LDP Password Required for a Prefix

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

CLI Commands

mpls ldp configuration
password required for prefix1

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordRequired	sys/ldp/password/passwordrequired

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

mplsldpPasswordRequired Properties

Property Name	Data Type	Description	Values
reqPfxList	mplsldp:LdpPrefixListName (string:Basic)	Specifies a prefix list, which specifies that a password is mandatory only for LDP sessions with neighbors whose LDP router IDs are permitted by the list	A sequence of characters
required	scalar:Bool	Specifies that LDP must use a password when establishing a session between LDP peers.	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 LDP Password Required for a Prefix

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

CLI Commands

mpls ldp configuration
no password required for prefix1

Verifying a DME Configuration

MO	DN
topSystem	sys
mplsldpLDP	sys/ldp
mplsldpPassword	sys/ldp/password
mplsldpPasswordRequired	sys/ldp/password/passwordrequired

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

mplsldpPasswordRequired 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