Configuring Label Advertisement

Configuring Label Advertisements

Configuring Label Advertisements
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLbl": {
                "attributes": {
                  "advLbl": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlbl-items>
      <advLbl>true</advLbl>
    </advlbl-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
  advertise-labels


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
mplsldpAdvLbl sys/ldp/advlbl


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


mplsldpAdvLbl Properties

The following table contains information about the mplsldpAdvLbl 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
advLblscalar:Bool
The advLbl property enables the label advertisementsSELECTION: 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 Label Advertisements

Deleting Label Advertisements
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLbl": {
                "attributes": {
                  "advLbl": "no"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlbl-items>
      <advLbl>false</advLbl>
    </advlbl-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 advertise-labels


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
mplsldpAdvLbl sys/ldp/advlbl


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


mplsldpAdvLbl Properties

The following table contains information about the mplsldpAdvLbl 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
advLblscalar:Bool
The advLbl property enables the label advertisementsSELECTION: 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 Label Advertisements for a Prefix List to All Peers

Configuring Label Advertisements for a Prefix List to All Peers
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLblPfx": {
                "attributes": {
                  "peerPfxList": "",
                  "pfxList": "prefix-pfxlist"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlblpfx-items>
      <AdvLblPfx-list>
        <pfxList>prefix-pfxlist</pfxList>
        <peerPfxList></peerPfxList>
      </AdvLblPfx-list>
    </advlblpfx-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
  advertise-labels for 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
mplsldpAdvLblPfx sys/ldp/advlblpfx-prefix-pfxlist


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


mplsldpAdvLblPfx Properties

The following table contains information about the mplsldpAdvLblPfx 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
peerPfxListmplsldp:LdpPrefixListName
(string:Basic)
Prefix list specifying controls on LDP peersA sequence of characters
pfxListmplsldp:LdpPrefixListName
(string:Basic)
Prefix list specifying controls on destination prefixesA 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 Advertisements for a Prefix List to All Peers

Deleting Label Advertisements for a Prefix List to All Peers
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLblPfx": {
                "attributes": {
                  "pfxList": "prefix-pfxlist",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlblpfx-items>
      <AdvLblPfx-list nc:operation="delete">
        <pfxList>prefix-pfxlist</pfxList>
      </AdvLblPfx-list>
    </advlblpfx-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 advertise-labels for 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
mplsldpAdvLblPfx sys/ldp/advlblpfx-prefix-pfxlist


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


mplsldpAdvLblPfx Properties

The following table contains information about the mplsldpAdvLblPfx 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
pfxListmplsldp:LdpPrefixListName
(string:Basic)
Prefix list specifying controls on destination prefixesA sequence of characters
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 Label Advertisements for a Prefix List to Specific Peers

Configuring Label Advertisements for a Prefix List to Specific Peers
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLblPfx": {
                "attributes": {
                  "peerPfxList": "peer-pfxlist",
                  "pfxList": "prefix-pfxlist"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlblpfx-items>
      <AdvLblPfx-list>
        <pfxList>prefix-pfxlist</pfxList>
        <peerPfxList>peer-pfxlist</peerPfxList>
      </AdvLblPfx-list>
    </advlblpfx-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
  advertise-labels for prefix-pfxlist to peer-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
mplsldpAdvLblPfx sys/ldp/advlblpfx-prefix-pfxlist


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


mplsldpAdvLblPfx Properties

The following table contains information about the mplsldpAdvLblPfx 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
peerPfxListmplsldp:LdpPrefixListName
(string:Basic)
Prefix list specifying controls on LDP peersA sequence of characters
pfxListmplsldp:LdpPrefixListName
(string:Basic)
Prefix list specifying controls on destination prefixesA 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 Advertisements for a Prefix List to Specific Peers

Deleting Label Advertisements for a Prefix List to Specific Peers
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLblPfx": {
                "attributes": {
                  "pfxList": "prefix-pfxlist",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlblpfx-items>
      <AdvLblPfx-list nc:operation="delete">
        <pfxList>prefix-pfxlist</pfxList>
      </AdvLblPfx-list>
    </advlblpfx-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 advertise-labels for prefix-pfxlist to peer-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
mplsldpAdvLblPfx sys/ldp/advlblpfx-prefix-pfxlist


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


mplsldpAdvLblPfx Properties

The following table contains information about the mplsldpAdvLblPfx 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
pfxListmplsldp:LdpPrefixListName
(string:Basic)
Prefix list specifying controls on destination prefixesA sequence of characters
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 Label Advertisements for a Prefix Constructed from an Interface Address and a 32-bit Mask

Configuring Label Advertisements for a Prefix Constructed from an Interface Address and a 32-bit Mask
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLblIntf": {
                "attributes": {
                  "interface": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlblintf-items>
      <AdvLblIntf-list>
        <interface>eth1/1</interface>
      </AdvLblIntf-list>
    </advlblintf-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
  advertise-labels interface eth1/1


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
mplsldpAdvLblIntf sys/ldp/advlblintf-[eth1/1]


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


mplsldpAdvLblIntf Properties

The following table contains information about the mplsldpAdvLblIntf 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
interfacenw:IfId
(base:IfIndex)
Advertise /32 interface addressMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Advertisements for a Prefix Constructed from an Interface Address and a 32-bit Mask

Deleting Label Advertisements for a Prefix Constructed from an Interface Address and a 32-bit Mask
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "mplsldpLDP": {
          "attributes": {
            "adminSt": "enabled"
          },
          "children": [
            {
              "mplsldpAdvLblIntf": {
                "attributes": {
                  "interface": "eth1/1",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ldp-items>
    <adminSt>enabled</adminSt>
    <advlblintf-items>
      <AdvLblIntf-list nc:operation="delete">
        <interface>eth1/1</interface>
      </AdvLblIntf-list>
    </advlblintf-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 advertise-labels interface eth1/1


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
mplsldpAdvLblIntf sys/ldp/advlblintf-[eth1/1]


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


mplsldpAdvLblIntf Properties

The following table contains information about the mplsldpAdvLblIntf 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
interfacenw:IfId
(base:IfIndex)
Advertise /32 interface addressMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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