Configuring a Neighbor

Configuring LDP Neighbor Implicit Withdraw

Configuring LDP Neighbor Implicit Withdraw
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpNeighbor": {
                "attributes": {
                  "implicitWithdraw": "yes",
                  "nbrAddr": "1.2.3.4"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <neighbor-items>
      <Neighbor-list>
        <nbrAddr>1.2.3.4</nbrAddr>
        <implicitWithdraw>true</implicitWithdraw>
      </Neighbor-list>
    </neighbor-items>
  </ldp-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.

mpls ldp configuration
  neighbor 1.2.3.4 implicit-withdraw


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
mplsldpNeighbor sys/ldp/neighbor-[1.2.3.4]


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


mplsldpNeighbor Properties

The following table contains information about the mplsldpNeighbor 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
implicitWithdrawscalar:Bool
Enable LDP neighbor implicit withdrawSELECTION: true or false
DEFAULT: false
nbrAddraddress:Ip
IP address for LDP neighborValue must match ipv4 or ipv6 known format


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 Neighbor Implicit Withdraw Label

Deleting LDP Neighbor Implicit Withdraw Label
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpNeighbor": {
                "attributes": {
                  "implicitWithdraw": "no",
                  "nbrAddr": "1.2.3.4"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <neighbor-items>
      <Neighbor-list>
        <nbrAddr>1.2.3.4</nbrAddr>
        <implicitWithdraw>false</implicitWithdraw>
      </Neighbor-list>
    </neighbor-items>
  </ldp-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.

mpls ldp configuration
  no neighbor 1.2.3.4 implicit-withdraw


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
mplsldpNeighbor sys/ldp/neighbor-[1.2.3.4]


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


mplsldpNeighbor Properties

The following table contains information about the mplsldpNeighbor 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
implicitWithdrawscalar:Bool
Enable LDP neighbor implicit withdrawSELECTION: true or false
DEFAULT: false
nbrAddraddress:Ip
IP address for LDP neighborValue must match ipv4 or ipv6 known format


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 Label Binding Exchange Controls

Configuring Label Binding Exchange Controls
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpNeighbor": {
                "attributes": {
                  "nbrAddr": "1.2.3.4",
                  "pfxList": "prefix-pfxlist"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <neighbor-items>
      <Neighbor-list>
        <nbrAddr>1.2.3.4</nbrAddr>
        <pfxList>prefix-pfxlist</pfxList>
      </Neighbor-list>
    </neighbor-items>
  </ldp-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.

mpls ldp configuration
  neighbor 1.2.3.4 labels accept prefix-pfxlist


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
mplsldpNeighbor sys/ldp/neighbor-[1.2.3.4]


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


mplsldpNeighbor Properties

The following table contains information about the mplsldpNeighbor 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
nbrAddraddress:Ip
IP address for LDP neighborValue must match ipv4 or ipv6 known format
pfxListmplsldp:LdpPrefixListName
(string:Basic)
Specifies the prefix list to be used to filter label bindings for the specified LDP neighbor.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 Label Binding Exchange Controls

Deleting Label Binding Exchange Controls
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpNeighbor": {
                "attributes": {
                  "nbrAddr": "1.2.3.4",
                  "pfxList": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <neighbor-items>
      <Neighbor-list>
        <nbrAddr>1.2.3.4</nbrAddr>
        <pfxList></pfxList>
      </Neighbor-list>
    </neighbor-items>
  </ldp-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.

mpls ldp configuration
  no neighbor 1.2.3.4 labels accept prefix-pfxlist


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
mplsldpNeighbor sys/ldp/neighbor-[1.2.3.4]


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


mplsldpNeighbor Properties

The following table contains information about the mplsldpNeighbor 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
nbrAddraddress:Ip
IP address for LDP neighborValue must match ipv4 or ipv6 known format
pfxListmplsldp:LdpPrefixListName
(string:Basic)
Specifies the prefix list to be used to filter label bindings for the specified LDP neighbor.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

Configuring Targeted Session

Configuring Targeted Session
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpNeighbor": {
                "attributes": {
                  "nbrAddr": "1.2.3.4",
                  "targeted": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <neighbor-items>
      <Neighbor-list>
        <nbrAddr>1.2.3.4</nbrAddr>
        <targeted>true</targeted>
      </Neighbor-list>
    </neighbor-items>
  </ldp-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.

mpls ldp configuration
  neighbor 1.2.3.4 targeted


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
mplsldpNeighbor sys/ldp/neighbor-[1.2.3.4]


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


mplsldpNeighbor Properties

The following table contains information about the mplsldpNeighbor 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
nbrAddraddress:Ip
IP address for LDP neighborValue must match ipv4 or ipv6 known format
targetedscalar:Bool
Establish LDP targeted sessionSELECTION: true or false
DEFAULT: false


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 Targeted Session

Deleting Targeted Session
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpNeighbor": {
                "attributes": {
                  "nbrAddr": "1.2.3.4",
                  "targeted": "no"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <neighbor-items>
      <Neighbor-list>
        <nbrAddr>1.2.3.4</nbrAddr>
        <targeted>false</targeted>
      </Neighbor-list>
    </neighbor-items>
  </ldp-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.

mpls ldp configuration
  no neighbor 1.2.3.4 targeted


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
mplsldpNeighbor sys/ldp/neighbor-[1.2.3.4]


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


mplsldpNeighbor Properties

The following table contains information about the mplsldpNeighbor 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
nbrAddraddress:Ip
IP address for LDP neighborValue must match ipv4 or ipv6 known format
targetedscalar:Bool
Establish LDP targeted sessionSELECTION: true or false
DEFAULT: false


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