Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling MPLS EVPN

DME

YANG

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

{
"fmEntity": {
  "children": [
    {
      "fmMplsEvpn": {
        "attributes": {
          "adminSt": "enabled"
}}}]}}
Response
{
    imdata:[]
}

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

Configuring Segment Routing

Segment routing is a technique by which the path followed by a packet is encoded in the packet itself, similar to source routing. A node steers a packet through a controlled set of instructions, called segments, by prepending the packet with a segment routing header. Each segment is identified by a segment ID (SID) consisting of a flat unsigned 32-bit integer.

For more information, see the Cisco Nexus 9000 Series NX-OS 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 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

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.

MO	DN
fmEntity	sys/fm
fmMplsEvpn	sys/fm/mplsevpn

fmMplsEvpn Properties

The following table contains information about the fmMplsEvpn properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 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 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

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

MO	DN
fmEntity	sys/fm
fmMplsEvpn	sys/fm/mplsevpn

fmMplsEvpn Properties

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 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

Configuring Shutdown Segment Routing

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

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

MO	DN
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtInst Properties

The following table contains information about the segrtInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

segrtConfigSrgb Properties

The following table contains information about the segrtConfigSrgb properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

The following table contains information about the segrtLblBlock properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

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 a Configured Shutdown Segment Routing

CLI Commands

segment-routing mpls
no shutdown

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

MO	DN
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtInst Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

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 Global Block Range for Segment Routing Bindings

CLI Commands

segment-routing mpls
global-block 16000 470000

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

MO	DN
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63
srLblMax	ulib:LabelVal (scalar:Uint32)	SRGB minimum label	RANGE: [16000 , 471804] DEFAULT: 23999
srLblMin	ulib:LabelVal (scalar:Uint32)	SRGB minimum label	RANGE: [16000 , 471804] DEFAULT: 16000

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting the Global Block Range for Segment Routing Bindings

CLI Commands

segment-routing mpls
no global-block

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

MO	DN
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63
srLblMax	ulib:LabelVal (scalar:Uint32)	SRGB minimum label	RANGE: [16000 , 471804] DEFAULT: 23999
srLblMin	ulib:LabelVal (scalar:Uint32)	SRGB minimum label	RANGE: [16000 , 471804] DEFAULT: 16000

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 Interval for which SR will Wait for SRGB Cleanup ACK from Clients

CLI Commands

segment-routing mpls
timers srgb cleanup 12

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

MO	DN
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtInst Properties

Property Name	Data Type	Description	Values
srgbCleanupIntvl	segrt:SrgbCleanupIntvl (scalar:Uint16)	SRGB cleanup interval	RANGE: [1 , 65535] DEFAULT: 60

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting the Interval for which SR will Wait for SRGB Cleanup ACK from Clients

CLI Commands

segment-routing mpls
no timers srgb cleanup 12

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

MO	DN
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtInst Properties

Property Name	Data Type	Description	Values
srgbCleanupIntvl	segrt:SrgbCleanupIntvl (scalar:Uint16)	SRGB cleanup interval	RANGE: [1 , 65535] DEFAULT: 60

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

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 Interval for which SR will Retry SRGB Allocation With ULIB

CLI Commands

segment-routing mpls
timers srgb retry 12

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

MO	DN
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtInst Properties

Property Name	Data Type	Description	Values
srgbAllocRetryIntvl	segrt:SrgbAllocRetryIntvl (scalar:Uint16)	SRGB allocation retry interval	RANGE: [1 , 65535] DEFAULT: 180

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting the Interval for which SR will Retry SRGB Allocation With ULIB

CLI Commands

segment-routing mpls
no timers srgb retry 12

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

MO	DN
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}

segrtInst Properties

Property Name	Data Type	Description	Values
srgbAllocRetryIntvl	segrt:SrgbAllocRetryIntvl (scalar:Uint16)	SRGB allocation retry interval	RANGE: [1 , 65535] DEFAULT: 180

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

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

Specifying a Global Block Range for Segment Routing Bindings

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.

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

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

MO	DN
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 Name	Data Type	Description	Values
srLblMax	ulib:LabelVal scalar:Uint32	NO COMMENTS	RANGE: Min: (long)16l Max: (long)471804l DEFAULT: unspecified(0u)
srLblMin	ulib:LabelVal scalar:Uint32	Config : Segment Routing Label Range	RANGE: Min: (long)16l Max: (long)471804l Config : Segment Routing Label RANGE DEFAULT: unspecified(0u)

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

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

MO	DN
ulibLabelTable	sys/labeltable
ulibLblRange	sys/labeltable/lblrange

ulibLblRange Properties

Property Name	Data Type	Description	Values
srLblMax	ulib:LabelVal scalar:Uint32	NO COMMENTS	RANGE: Min: (long)16l Max: (long)471804l DEFAULT: unspecified(0u)
srLblMin	ulib:LabelVal scalar:Uint32	Config : Segment Routing Label Range	RANGE: Min: (long)16l Max: (long)471804l Config : Segment Routing Label RANGE DEFAULT: unspecified(0u)

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 Connected Prefix Segment Identifier Mappings

CLI Commands

segment-routing mpls
connected-prefix-sid-map

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

The following table contains information about the segrtDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting the Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

The following table contains information about the segrtDomAf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

The following table contains information about the segrtPrefixSid properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

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 An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

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 An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

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 An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

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 An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

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 An IP Address for An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}
segrtMplsPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}/mplspfxsid-{[pfx]}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtMplsPrefixSid Properties

The following table contains information about the segrtMplsPrefixSid properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
pfx	address:Ip	Prefix	Value must match ipv4 or ipv6 known format
sidValue	scalar:Uint32	Value of SID	RANGE: [0 , 471804]
sidValueType	segrt:SidValueType (scalar:Enum8)	Type of Segment Identifier Value	SELECTION: 1 - index 2 - absolute DEFAULT: index

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 An IP Address for An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings

CLI Commands

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

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

MO	DN
topSystem	sys
segrtEntity	sys/segrt
segrtInst	sys/segrt/inst
segrtSrgb	sys/segrt/inst/srgb
segrtConfigSrgb	sys/segrt/inst/srgb/cfgsrgb-{type}
segrtLblBlock	sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId}
segrtDom	sys/segrt/inst/dom-{name}
segrtDomAf	sys/segrt/inst/dom-{name}/af-{afType}
segrtPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}
segrtMplsPrefixSid	sys/segrt/inst/dom-{name}/af-{afType}/pfxsid-{type}/mplspfxsid-{[pfx]}

segrtConfigSrgb Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	SRGB type	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtLblBlock Properties

Property Name	Data Type	Description	Values
localId	string:Basic	SRGB identifier	MAX SIZE: 63

segrtDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

segrtDomAf Properties

Property Name	Data Type	Description	Values
afType	segrt:AfType (scalar:Enum8)	Address family type	SELECTION: 1 - ipv4 2 - ipv6 DEFAULT: ipv4

segrtPrefixSid Properties

Property Name	Data Type	Description	Values
type	segrt:SrDpType (scalar:Enum8)	Type of Segment Identifier	SELECTION: 1 - mpls 2 - ipv6 DEFAULT: mpls

segrtMplsPrefixSid Properties

Property Name	Data Type	Description	Values
pfx	address:Ip	Prefix	Value must match ipv4 or ipv6 known format
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring Bytes-Only Adjacency Stats

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

CLI Commands

hardware profile mpls adjacency-stats bytes

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
platformEntity	sys/pltfm
topSystem	sys

platformEntity Properties

The following table contains information about the platformEntity properties in the DME payload. for more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
mplsAdjStatsMode	platform:MplsStatsType (scalar:Enum8)	Corresponds to MPLS Adjacency stats type	SELECTION: 0 - PACKETS 1 - BYTES DEFAULT: PACKETS

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 Bytes-Only Adjacency Stats

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

CLI Commands

no hardware profile mpls adjacency-stats bytes

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
topSystem	sys

platformEntity Properties

Property Name	Data Type	Description	Values
mplsAdjStatsMode	platform:MplsStatsType (scalar:Enum8)	Corresponds to MPLS Adjacency stats type	SELECTION: 0 - PACKETS 1 - BYTES DEFAULT: PACKETS

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