Configuring Static MPLS

Generally, label switching routers (LSRs) use a label distribution protocol to dynamically learn the labels that they should use to label-switch packets. Examples of such protocols include:

  • Label Distribution Protocol (LDP), the Internet Engineering Task Force (IETF) standard that is used to bind labels to network addresses
  • Resource Reservation Protocol (RSVP), which is used to distribute labels for traffic engineering (TE)
  • Border Gateway Protocol (BGP), which is used to distribute labels for MPLS virtual private networks (VPNs) To use a learned label to label-switch packets, an LSR installs the label into its Label Forwarding Information Base (LFIB). The static MPLS feature enables you to statically configure the following:
  • The binding between a label and an IPv4 or IPv6 prefix
  • The action corresponding to the binding between a label and an IPv4 or IPv6 prefix (label swap or pop)
  • The contents of an LFIB cross-connect entry

For more information, see the Cisco Nexus 9000 Series NX-Label Switching Configuration Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Enabling Static MPLS

Enabling Static MPLS

POST http://<IP_Address>/api/mo/sys/fm.json

{
"fmEntity": {
  "children": [
    {
      "fmMplsStatic": {
        "attributes": {
          "adminSt": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <mplsstatic-items>
      <adminSt>enabled</adminSt>
    </mplsstatic-items>
  </fm-items>
</System>

This example enables static MPLS.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

feature mpls static

Note: The property information for this example was added in Release 9.3(3).


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
fmEntity sys/fm
fmMplsStatic sys/fm/mplsstatic


fmMplsStatic Properties

The following table contains information about the fmMplsStatic 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
adminStfm:AdminState
(scalar:Enum8)		Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Disabling Static MPLS

Disabling Static MPLS

POST http://<IP_Address>/api/mo/sys/fm.json


{
"fmEntity": {
  "children": [
    {
      "fmMplsStatic": {
        "attributes": {
          "adminSt": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <mplsstatic-items>
      <adminSt>disabled</adminSt>
    </mplsstatic-items>
  </fm-items>
</System>

This example disables static MPLS.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

no feature mpls static

Note: The property information for this example was added in Release 9.3(3).


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
fmEntity sys/fm
fmMplsStatic sys/fm/mplsstatic


fmMplsStatic Properties

The following table contains information about the fmMplsStatic 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
adminStfm:AdminState
(scalar:Enum8)		Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Enabling MPLS on an Interface

Enabling MPLS on an Interface

POST http://<IP_Address>/api/mo/sys.json

{
"topSystem": {
"children": [
  {
    "mplsEntity": {
      "children": [
        {
          "mplsIf": {
            "attributes": {
              "id": "eth1/5"
}}}]}},
{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/5",
          "layer": "Layer3",
          "userCfgdFlags": "admin_layer"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mpls-items>
    <If-items>
      <If-list>
        <id>eth1/5</id>
      </If-list>
    </If-items>
  </mpls-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/5</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Enables MPLS forwarding on Ethernet interface 1/5.

Creating an instance of this MO enables MPLS on the specified interface. Deleting an instance of this MO disables MPLS on the specified interface.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

int eth1/5
 no switchport
 mpls ip forwarding

Note: The property information for this example was added in Release 9.3(3).


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
mplsEntity sys/mpls
mplsIf sys/mpls/If-{[id]}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


mplsIf Properties

The following table contains information about the mplsIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIf Properties

The following table contains information about the l1PhysIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)		Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)		Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


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

Disabling MPLS on an Interface

Disabling MPLS on an Interface

POST http://<IP_Address>/api/mo/sys.json

{
"topSystem": {
"children": [
  {
    "mplsEntity": {
      "children": [
        {
          "mplsIf": {
            "attributes": {
              "id": "eth1/5"
}}}]}},
{
"interfaceEntity": {
  "children": [
    {
      "l1PhysIf": {
        "attributes": {
          "id": "eth1/5",
          "layer": "Layer3",
          "userCfgdFlags": "admin_layer"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <mpls-items>
    <If-items>
      <If-list>
        <id>eth1/5</id>
      </If-list>
    </If-items>
  </mpls-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/5</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Disables MPLS forwarding on Ethernet interface 1/5.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

int eth1/5
 no switchport
 no mpls ip forwarding

Note: The property information for this example was added in Release 9.3(3).


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
mplsEntity sys/mpls
mplsIf sys/mpls/If-{[id]}
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}


mplsIf Properties

The following table contains information about the mplsIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIf Properties

The following table contains information about the l1PhysIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)		Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)		Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


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

Enabling MPLS Segment Routing

Enabling MPLS Segment Routing

POST http://<IP_Address>/api/mo/sys/fm.json

{
"fmEntity": {
  "children": [
    {
      "fmMplsSgmntRtg": {
        "attributes": {
          "adminSt": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <mplssgmntrtg-items>
      <adminSt>enabled</adminSt>
    </mplssgmntrtg-items>
  </fm-items>
</System>


CLI Commands

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

feature mpls segment-routing

Note: The property information for this example was added in Release 9.3(3).


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
fmEntity sys/fm
fmMplsSgmntRtg sys/fm/mplssgmntrtg


fmMplsSgmntRtg Properties

The following table contains information about the fmMplsSgmntRtg 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
adminStfm:AdminState
(scalar:Enum8)		Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Disabling MPLS Segment Routing

Disabling MPLS Segment Routing

POST http://<IP_Address>/api/mo/sys/fm.json

{
"fmEntity": {
  "children": [
    {
      "fmMplsSgmntRtg": {
        "attributes": {
          "adminSt": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <mplssgmntrtg-items>
      <adminSt>disabled</adminSt>
    </mplssgmntrtg-items>
  </fm-items>
</System>


CLI Commands

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

no feature mpls segment-routing

Note: The property information for this example was added in Release 9.3(3).


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
fmEntity sys/fm
fmMplsSgmntRtg sys/fm/mplssgmntrtg


fmMplsSgmntRtg Properties

The following table contains information about the fmMplsSgmntRtg 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
adminStfm:AdminState
(scalar:Enum8)		Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Reserving Labels for Static Assignment

Reserving Labels for Static Assignment

POST http://<IP_Address>/api/mo/sys/labeltable.json

{
"ulibLabelTable": {
  "children": [
    {
      "ulibLblRange": {
        "attributes": {
          "dynLblMax": "99",
          "dynLblMin": "17",
          "staticLblMax": "1000",
          "staticLblMin": "100"
}}}]}}

<System>
  <labeltable-items>
    <lblrange-items>
      <dynLblMax>99</dynLblMax>
      <dynLblMin>17</dynLblMin>
      <staticLblMax>1000</staticLblMax>
      <staticLblMin>100</staticLblMin>
    </lblrange-items>
  </labeltable-items>
</System>

There are three partitions (ranges) in ULIB: the dynamic label range, the static label range, and the segment routing global block (SRGB) range. The dynamic and static label ranges must be non-overlapping, while the SRGB range must be a contiguous subset of the dynamic range.

This example configures labels for static assignment.


CLI Commands

The CLI commands and options listed below are used to create the payload example displayed in the pane on the right.

mpls label range 17 99 static 100 1000

Note: The property information for this example was added in Release 9.3(3).


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
ulibLabelTable sys/labeltable
ulibLblRange sys/labeltable/lblrange


ulibLblRange Properties

The following table contains information about the ulibLblRange 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
dynLblMaxulib:DynLblMax
(scalar:Uint32)		Maximum dynamic label, configured value
Must be between 16 and 471804, and must be greater than or equal to dynLblMin, and the range [staticLblMin, staticLblMax] must be disjoint from the range [dynLblMin, dynLblMax]
RANGE: [16 , 471804]
DEFAULT: 471804
dynLblMinulib:DynLblMin
(scalar:Uint32)		Minimum dynamic label, configured value
Must be between 16 and 471804, must be less than or equal to dynLblMax, and the range [staticLblMin, staticLblMax] must be disjoint from the range [dynLblMin, dynLblMax]
RANGE: [16 , 471804]
DEFAULT: 16
staticLblMaxulib:LabelVal
(scalar:Uint32)		Maximum Static Label, configured value
Must be EITHER: (1) set to 0 as long as staticLblMin is also set to 0 OR (2) between 16 and 471804, be greater than or equal to staticLblMin, and the range [staticLblMin, staticLblMax] must be disjoint from the range [dynLblMin, dynLblMax]
RANGE: [0 , 471804]
staticLblMinulib:LabelVal
(scalar:Uint32)		Minimum Static Label, configured value
Must be EITHER: (1) set to 0 as long as staticLblMax is also set to 0 OR (2) between 16 and 471804, be less than to staticLblMax, and the range [staticLblMin, staticLblMax] must be disjoint from the range [dynLblMin, dynLblMax]
RANGE: [0 , 471804]


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 Static Label and Prefix Binding

Configuring Static Label and Prefix Binding

POST http://<IP_Address>/api/mo/sys.json

{
"topSystem": {
"children": [
  {
    "mplsEntity": {
      "children": [
        {
          "mplsIf": {
            "attributes": {
              "id": "eth2/2"
}}}]}},{
"mplsstaticEntity": {
  "attributes": {
    "adminSt": "enabled"
},
"children": [
{
  "mplsstaticAf": {
    "attributes": {
      "type": "ipv4-ucast"
    },
    "children": [
      {
        "mplsstaticPfxLclLbl": {
          "attributes": {
            "label": "2000",
            "pfx": "1.255.200.0/32"
}}}]}}]}}]}}

<System>
  <mpls-items>
    <If-items>
      <If-list>
        <id>eth2/2</id>
      </If-list>
    </If-items>
  </mpls-items>
  <mplsstatic-items>
    <adminSt>enabled</adminSt>
    <af-items>
      <Af-list>
        <type>ipv4-ucast</type>
        <pfxlabel-items>
          <PfxLclLbl-list>
            <label>2000</label>
            <pfx>1.255.200.0/32</pfx>
          </PfxLclLbl-list>
        </pfxlabel-items>
      </Af-list>
    </af-items>
  </mplsstatic-items>
</System>

This example specifies static binding of incoming labels to IPv4 prefixes.


CLI Commands

The CLI commands listed below are used to create the payload example displayed in the pane on the right.

interface ethernet 2/2
 mpls ip forwarding
  mpls static configuration
   address-family ipv4 unicast
    local-label 2000 prefix 1.255.200.0/32

Note: The property information for this example was added in Release 9.3(3).


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
mplsEntity sys/mpls
mplsIf sys/mpls/If-{[id]}
mplsstaticEntity sys/mplsstatic
mplsstaticAf sys/mplsstatic/af-{type}
mplsstaticPfxLclLbl sys/mplsstatic/af-{type}/pfxlabel-{label}


mplsIf Properties

The following table contains information about the mplsIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


mplsstaticEntity Properties

The following table contains information about the mplsstaticEntity 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


mplsstaticAf Properties

The following table contains information about the mplsstaticAf 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
typemplsstatic:AfT
(scalar:Enum8)		Type of Address Family (IPv4, IPv6, etc.)SELECTION:
1 - ipv4-ucast
2 - ipv6-ucast
DEFAULT: ipv4-ucast


mplsstaticPfxLclLbl Properties

The following table contains information about the mplsstaticPfxLclLbl 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
labelmplsstatic:InLabelVal
(scalar:Uint32)		Local In Label Value
RANGE: [16 , 471804]
DEFAULT: 16
pfxaddress:Ip
Local Label Prefix/Subnet
Must be a valid IP prefix, and may not be a reserved, loopback, or multicast address, or the zero address
Value 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 the Next Hop

Configuring the Next Hop

POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "mplsEntity": {
          "children": [
            {
              "mplsIf": {
                "attributes": {
                  "id": "eth2/2"
}}}]}},{
"mplsstaticEntity": {
  "attributes": {
    "adminSt": "enabled"
},
"children": [
{
  "mplsstaticAf": {
    "attributes": {
      "type": "ipv4-ucast"
},
"children": [
  {
    "mplsstaticPfxLclLbl": {
      "attributes": {
        "label": "2000",
        "pfx": "1.255.200.0/32"
      },
      "children": [
        {
          "mplsstaticNh": {
            "attributes": {
              "nhAddr": "1.31.1.1",
              "outLbl": "2000"
}}}]}}]}}]}}]}}

<System>
  <mpls-items>
    <If-items>
      <If-list>
        <id>eth2/2</id>
      </If-list>
    </If-items>
  </mpls-items>
  <mplsstatic-items>
    <adminSt>enabled</adminSt>
    <af-items>
      <Af-list>
        <type>ipv4-ucast</type>
        <pfxlabel-items>
          <PfxLclLbl-list>
            <label>2000</label>
            <pfx>1.255.200.0/32</pfx>
            <nh-items>
              <nhAddr>1.31.1.1</nhAddr>
              <outLbl>2000</outLbl>
            </nh-items>
          </PfxLclLbl-list>
        </pfxlabel-items>
      </Af-list>
    </af-items>
  </mplsstatic-items>
</System>

This example specifies the next hop.

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

interface ethernet 2/2
 mpls ip forwarding
  mpls static configuration
   address-family ipv4 unicast
    local-label 2000 prefix 1.255.200.0/32
    next-hop 1.31.1.1 out-label 2000

Note: The property information for this example was added in Release 9.3(3).


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
mplsEntity sys/mpls
mplsIf sys/mpls/If-{[id]}
mplsstaticEntity sys/mplsstatic
mplsstaticAf sys/mplsstatic/af-{type}
mplsstaticPfxLclLbl sys/mplsstatic/af-{type}/pfxlabel-{label}
mplsstaticNh sys/mplsstatic/af-{type}/pfxlabel-{label}/nh


mplsIf Properties

The following table contains information about the mplsIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


mplsstaticEntity Properties

The following table contains information about the mplsstaticEntity 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


mplsstaticAf Properties

The following table contains information about the mplsstaticAf 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
typemplsstatic:AfT
(scalar:Enum8)		Type of Address Family (IPv4, IPv6, etc.)SELECTION:
1 - ipv4-ucast
2 - ipv6-ucast
DEFAULT: ipv4-ucast


mplsstaticPfxLclLbl Properties

The following table contains information about the mplsstaticPfxLclLbl 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
labelmplsstatic:InLabelVal
(scalar:Uint32)		Local In Label Value
RANGE: [16 , 471804]
DEFAULT: 16
pfxaddress:Ip
Local Label Prefix/Subnet
Must be a valid IP prefix, and may not be a reserved, loopback, or multicast address, or the zero address
Value must match ipv4 or ipv6 known format


mplsstaticNh Properties

The following table contains information about the mplsstaticNh 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
nhAddraddress:Ip
Next Hop - IP Address
Must be a valid IP address and may not be a multicast address or the zero address
Value must match ipv4 or ipv6 known format
outLblmplsstatic:OutLabelVal
(scalar:Uint32)		Outgoing Label Value
RANGE: [0 , 1048575]


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

Next Hop Backup

Next Hop Backup

POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "mplsEntity": {
          "children": [
            {
              "mplsIf": {
                "attributes": {
                  "id": "eth2/2"
}}}]}},{
"mplsstaticEntity": {
  "attributes": {
    "adminSt": "enabled"
  },
  "children": [
    {
      "mplsstaticAf": {
        "attributes": {
          "type": "ipv4-ucast"
        },
        "children": [
          {
            "mplsstaticPfxLclLbl": {
              "attributes": {
                "label": "2000",
                "pfx": "1.255.200.0/32"
              },
              "children": [
                {
                  "mplsstaticBackupNh": {
                    "attributes": {
                      "if": "po34",
                      "nhAddr": "1.34.1.1",
                      "outLbl": "2000"
}}}]}}]}}]}}]}}

<System>
  <mpls-items>
    <If-items>
      <If-list>
        <id>eth2/2</id>
      </If-list>
    </If-items>
  </mpls-items>
  <mplsstatic-items>
    <adminSt>enabled</adminSt>
    <af-items>
      <Af-list>
        <type>ipv4-ucast</type>
        <pfxlabel-items>
          <PfxLclLbl-list>
            <label>2000</label>
            <pfx>1.255.200.0/32</pfx>
            <backupnh-items>
              <if>po34</if>
              <nhAddr>1.34.1.1</nhAddr>
              <outLbl>2000</outLbl>
            </backupnh-items>
          </PfxLclLbl-list>
        </pfxlabel-items>
      </Af-list>
    </af-items>
  </mplsstatic-items>
</System>

This example specifies the next-hop backup path.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

interface ethernet 2/2
 mpls ip forwarding
  mpls static configuration
   address-family ipv4 unicast
    local-label 2000 prefix 1.255.200.0/32
    next-hop backup Po34 1.34.1.1 out-label 2000

Note: The property information for this example was added in Release 9.3(3).


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
mplsEntity sys/mpls
mplsIf sys/mpls/If-{[id]}
mplsstaticEntity sys/mplsstatic
mplsstaticAf sys/mplsstatic/af-{type}
mplsstaticPfxLclLbl sys/mplsstatic/af-{type}/pfxlabel-{label}
mplsstaticBackupNh sys/mplsstatic/af-{type}/pfxlabel-{label}/backupnh


mplsIf Properties

The following table contains information about the mplsIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


mplsstaticEntity Properties

The following table contains information about the mplsstaticEntity 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


mplsstaticAf Properties

The following table contains information about the mplsstaticAf 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
typemplsstatic:AfT
(scalar:Enum8)		Type of Address Family (IPv4, IPv6, etc.)SELECTION:
1 - ipv4-ucast
2 - ipv6-ucast
DEFAULT: ipv4-ucast


mplsstaticPfxLclLbl Properties

The following table contains information about the mplsstaticPfxLclLbl 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
labelmplsstatic:InLabelVal
(scalar:Uint32)		Local In Label Value
RANGE: [16 , 471804]
DEFAULT: 16
pfxaddress:Ip
Local Label Prefix/Subnet
Must be a valid IP prefix, and may not be a reserved, loopback, or multicast address, or the zero address
Value must match ipv4 or ipv6 known format


mplsstaticBackupNh Properties

The following table contains information about the mplsstaticBackupNh 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
ifnw:IfId
(base:IfIndex)		Backup Next Hop InterfaceMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
nhAddraddress:Ip
Backup Next Hop IP AddressValue must match ipv4 or ipv6 known format
outLblmplsstatic:OutLabelVal
(scalar:Uint32)		Outgoing Label Value
RANGE: [0 , 1048575]


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

Next Hop Auto-Resolve

Next Hop Auto-Resolve

POST http://<IP_Address>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "mplsEntity": {
          "children": [
            {
              "mplsIf": {
                "attributes": {
                  "id": "eth2/2"
}}}]}},{
"mplsstaticEntity": {
  "attributes": {
    "adminSt": "enabled"
},
"children": [
{
  "mplsstaticAf": {
    "attributes": {
      "type": "ipv4-ucast"
    },
    "children": [
      {
        "mplsstaticPfxLclLbl": {
          "attributes": {
            "label": "2000",
            "pfx": "1.255.200.0/32"
          },
          "children": [
            {
              "mplsstaticAutoResolveNh": {
                "attributes": {
                  "outLbl": "3001"
}}}]}}]}}]}}]}}

<System>
  <mpls-items>
    <If-items>
      <If-list>
        <id>eth2/2</id>
      </If-list>
    </If-items>
  </mpls-items>
  <mplsstatic-items>
    <adminSt>enabled</adminSt>
    <af-items>
      <Af-list>
        <type>ipv4-ucast</type>
        <pfxlabel-items>
          <PfxLclLbl-list>
            <label>2000</label>
            <pfx>1.255.200.0/32</pfx>
            <autoresolvenh-items>
              <outLbl>3001</outLbl>
            </autoresolvenh-items>
          </PfxLclLbl-list>
        </pfxlabel-items>
      </Af-list>
    </af-items>
  </mplsstatic-items>
</System>

This example specifies next-hop auto-resolve.


CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

interface ethernet 2/2
 mpls ip forwarding
  mpls static configuration
   address-family ipv4 unicast
    local-label 2000 prefix 1.255.200.0/32
    next-hop auto-resolve out-label 3001

Note: The property information for this example was added in Release 9.3(3).


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
mplsEntity sys/mpls
mplsIf sys/mpls/If-{[id]}
mplsstaticEntity sys/mplsstatic
mplsstaticAf sys/mplsstatic/af-{type}
mplsstaticPfxLclLbl sys/mplsstatic/af-{type}/pfxlabel-{label}
mplsstaticAutoResolveNh sys/mplsstatic/af-{type}/pfxlabel-{label}/autoresolvenh


mplsIf Properties

The following table contains information about the mplsIf 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
idnw:IfId
(base:IfIndex)		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


mplsstaticEntity Properties

The following table contains information about the mplsstaticEntity 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


mplsstaticAf Properties

The following table contains information about the mplsstaticAf 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
typemplsstatic:AfT
(scalar:Enum8)		Type of Address Family (IPv4, IPv6, etc.)SELECTION:
1 - ipv4-ucast
2 - ipv6-ucast
DEFAULT: ipv4-ucast


mplsstaticPfxLclLbl Properties

The following table contains information about the mplsstaticPfxLclLbl 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
labelmplsstatic:InLabelVal
(scalar:Uint32)		Local In Label Value
RANGE: [16 , 471804]
DEFAULT: 16
pfxaddress:Ip
Local Label Prefix/Subnet
Must be a valid IP prefix, and may not be a reserved, loopback, or multicast address, or the zero address
Value must match ipv4 or ipv6 known format


mplsstaticAutoResolveNh Properties

The following table contains information about the mplsstaticAutoResolveNh 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
outLblmplsstatic:OutLabelVal
(scalar:Uint32)		Outgoing Label Value
RANGE: [0 , 1048575]


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