Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x

NX-OS 7(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling Static MPLS

DME

YANG

Copy
POST http://<IP_Address>/api/mo/sys/fm.json
{
"fmEntity": {
  "children": [
    {
      "fmMplsStatic": {
        "attributes": {
          "adminSt": "enabled"
}}}]}}
Response
{
    imdata:[]
}

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

Configuring Static MPLS and Segment Routing

Enabling Static MPLS

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

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

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

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/

Enabling MPLS EVPN

CLI Commands

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

feature mpls evpn

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/

Disabling MPLS EVPN

CLI Commands

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

no feature mpls evpn

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/

Enabling MPLS OAM

CLI Commands

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

feature mpls oam

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/

Disabling MPLS OAM

CLI Commands

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

no feature mpls oam

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/

Enabling MPLS Segment Routing

CLI Commands

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

feature mpls segment-routing

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/

Disabling MPLS Segment Routing

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

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/

Enabling MPLS on an Interface

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

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/

Disabling MPLS on an Interface

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

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/

Reserving Labels for Static Assignment

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

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/

Configuring Shutdown Segment Routing

Note: This example was added in Release 7.0(3)I7(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.

segment-routing mpls
shutdown

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/media/dme/index.html

Deleting A Configured Shutdown Segment Routing

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

CLI Commands

segment-routing mpls
no shutdown

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/media/dme/index.html

Configuring The Global Block Range For Segment Routing Bindings

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

CLI Commands

segment-routing mpls
global-block 16000 470000

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/media/dme/index.html

Deleting The Global Block Range For Segment Routing Bindings

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

CLI Commands

segment-routing mpls
no global-block

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/media/dme/index.html

Configuring The Interval For Which SR Will Wait For SRGB Cleanup ACK From Clients

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

CLI Commands

segment-routing mpls
timers srgb cleanup 12

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/media/dme/index.html

Deleting The Interval For Which SR Will Wait For SRGB Cleanup ACK From Clients

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

CLI Commands

segment-routing mpls
no timers srgb cleanup 12

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/media/dme/index.html

Configuring The Interval For Which SR Will Retry SRGB Allocation With ULIB

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

CLI Commands

segment-routing mpls
timers srgb retry 12

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/media/dme/index.html

Deleting The Interval For Which SR Will Retry SRGB Allocation With ULIB

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

CLI Commands

segment-routing mpls
no timers srgb retry 12

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/media/dme/index.html

Specifying a Global Block Range for Segment Routing Bindings

CLI Commands

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

segment-routing mpls
global-block 17 19

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/

Deleting a Global Block Range for Segment Routing Bindings

CLI Commands

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

segment-routing mpls
no global-block 17 19

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/

Configuring Static Label and Prefix Binding

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

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/

Configuring the Next Hop

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

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/

Next Hop Backup

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

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/

Next Hop Auto-Resolve

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

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/

Configuring the Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map

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/media/dme/index.html

Deleting the Connected Prefix Segment Identifier Mappings

Deleting The Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
no connected-prefix-sid-map

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/media/dme/index.html

Configuring An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map
address-family ipv4

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/media/dme/index.html

Deleting An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map
no address-family ipv4dress-family ipv4

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/media/dme/index.html

Configuring An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map
address-family ipv6

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/media/dme/index.html

Deleting An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map
no address-family ipv6

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/media/dme/index.html

Configuring An IP Address For An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map
address-family ipv4
1.2.3.4/2 123

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/media/dme/index.html

Deleting An IP Address For An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

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

CLI Commands

segment-routing mpls
connected-prefix-sid-map
address-family ipv4
no 1.2.3.4/2 123

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/media/dme/index.html