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:
Enabling MPLS EVPN
Enabling MPLS EVPN
POST http://<IP_Address>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmMplsEvpn": {
"attributes": {
"adminSt": "enabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<mplsevpn-items>
<adminSt>enabled</adminSt>
</mplsevpn-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 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:
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:
Disabling MPLS EVPN
Disabling MPLS EVPN
POST http://<IP_Address>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmMplsEvpn": {
"attributes": {
"adminSt": "disabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<mplsevpn-items>
<adminSt>disabled</adminSt>
</mplsevpn-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 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:
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:
Configuring Shutdown Segment Routing
Configuring Shutdown Segment Routing
POST http://<mgmt0_IP>/api/mo/sys/segrt.json
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"adminSt": "disabled"
},
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<adminSt>disabled</adminSt>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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).
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 |
---|---|
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:
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:
Deleting a Configured Shutdown Segment Routing
Deleting a Configured Shutdown Segment Routing
POST http://<mgmt0_IP>/api/mo/sys/segrt.json
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<adminSt>enabled</adminSt>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
no shutdown
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 |
---|---|
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:
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:
Configuring the Global Block Range for Segment Routing Bindings
Configuring the Global Block Range for Segment Routing Bindings
POST http://<mgmt0_IP>/api/mo/sys/segrt/inst/srgb.json
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1",
"srLblMax": "470000",
"srLblMin": "16000"
}}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
<srLblMax>470000</srLblMax>
<srLblMin>16000</srLblMin>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
global-block 16000 470000
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 |
---|---|
segrtSrgb | sys/segrt/inst/srgb |
segrtConfigSrgb | sys/segrt/inst/srgb/cfgsrgb-{type} |
segrtLblBlock | sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId} |
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 |
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:
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:
Deleting the Global Block Range for Segment Routing Bindings
Deleting the Global Block Range for Segment Routing Bindings
POST http://<mgmt0_IP>/api/mo/sys/segrt/inst/srgb.json
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1",
"srLblMax": "23999",
"srLblMin": "16000"
}}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
<srLblMax>23999</srLblMax>
<srLblMin>16000</srLblMin>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
no global-block
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 |
---|---|
segrtSrgb | sys/segrt/inst/srgb |
segrtConfigSrgb | sys/segrt/inst/srgb/cfgsrgb-{type} |
segrtLblBlock | sys/segrt/inst/srgb/cfgsrgb-{type}/lblblock-{localId} |
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 |
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:
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:
Configuring the Interval for which SR will Wait for SRGB Cleanup ACK from Clients
Configuring the Interval for which SR will Wait for SRGB Cleanup ACK from Clients
POST http://<mgmt0_IP>/api/mo/sys/segrt.json
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"srgbCleanupIntvl": "12"
},
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgbCleanupIntvl>12</srgbCleanupIntvl>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
timers srgb cleanup 12
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 |
---|---|
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 |
---|---|---|---|
srgbCleanupIntvl | segrt:SrgbCleanupIntvl (scalar:Uint16) | SRGB cleanup interval | RANGE: [1 , 65535] DEFAULT: 60 |
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:
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:
Deleting the Interval for which SR will Wait for SRGB Cleanup ACK from Clients
Deleting the Interval for which SR will Wait for SRGB Cleanup ACK from Clients
POST http://<mgmt0_IP>/api/mo/sys/segrt.json
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"srgbCleanupIntvl": "60"
},
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgbCleanupIntvl>60</srgbCleanupIntvl>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
no timers srgb cleanup 12
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 |
---|---|
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 |
---|---|---|---|
srgbCleanupIntvl | segrt:SrgbCleanupIntvl (scalar:Uint16) | SRGB cleanup interval | RANGE: [1 , 65535] DEFAULT: 60 |
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:
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:
Configuring the Interval for which SR will Retry SRGB Allocation With ULIB
Configuring the Interval for which SR will Retry SRGB Allocation With ULIB
POST http://<mgmt0_IP>/api/mo/sys/segrt.json
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"srgbAllocRetryIntvl": "12"
},
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgbAllocRetryIntvl>12</srgbAllocRetryIntvl>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
timers srgb retry 12
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 |
---|---|
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 |
---|---|---|---|
srgbAllocRetryIntvl | segrt:SrgbAllocRetryIntvl (scalar:Uint16) | SRGB allocation retry interval | RANGE: [1 , 65535] DEFAULT: 180 |
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:
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:
Deleting the Interval for which SR will Retry SRGB Allocation With ULIB
Deleting the Interval for which SR will Retry SRGB Allocation With ULIB
POST http://<mgmt0_IP>/api/mo/sys/segrt.json
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"srgbAllocRetryIntvl": "180"
},
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgbAllocRetryIntvl>180</srgbAllocRetryIntvl>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
</inst-items>
</segrt-items>
</System>
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
no timers srgb retry 12
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 |
---|---|
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 |
---|---|---|---|
srgbAllocRetryIntvl | segrt:SrgbAllocRetryIntvl (scalar:Uint16) | SRGB allocation retry interval | RANGE: [1 , 65535] DEFAULT: 180 |
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:
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:
Specifying a Global Block Range for Segment Routing Bindings
Specifying a Global Block Range for Segment Routing Bindings
POST http://<IP_Address>/api/mo/sys/labeltable.json
{
"ulibLabelTable": {
"children": [
{
"ulibLblRange": {
"attributes": {
"srLblMax": "19",
"srLblMin": "17"
}}}]}}
<System>
<labeltable-items>
<lblrange-items>
<srLblMax>19</srLblMax>
<srLblMin>17</srLblMin>
</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.
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).
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 |
---|---|
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 |
srLblMin | ulib:LabelVal scalar:Uint32 | Config : Segment Routing Label Range | RANGE:
Min: (long)16l
Max: (long)471804l
Config : Segment Routing Label RANGE |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Global Block Range for Segment Routing Bindings
Deleting a Global Block Range for Segment Routing Bindings
POST http://<IP_Address>/api/mo/sys/labeltable.json
{
"ulibLabelTable": {
"children": [
{
"ulibLblRange": {
"attributes": {
"srLblMax": "23999",
"srLblMin": "16000"
}}}]}}
<System>
<labeltable-items>
<lblrange-items>
<srLblMax>23999</srLblMax>
<srLblMin>16000</srLblMin>
</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.
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).
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 |
---|---|
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 |
srLblMin | ulib:LabelVal scalar:Uint32 | Config : Segment Routing Label Range | RANGE:
Min: (long)16l
Max: (long)471804l
Config : Segment Routing Label RANGE |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Connected Prefix Segment Identifier Mappings
Configuring the Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
}}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
connected-prefix-sid-map
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 |
---|---|
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
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 |
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:
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:
Deleting the Connected Prefix Segment Identifier Mappings
Deleting the Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv4"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"status": "deleted",
"type": "mpls"
}}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv4</afType>
<pfxsid-items>
<PrefixSid-list xc:operation="delete">
<type>mpls</type>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
no connected-prefix-sid-map
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 |
---|---|
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
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 |
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 |
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:
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:
Configuring An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
Configuring An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv4"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"type": "mpls"
}}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv4</afType>
<pfxsid-items>
<PrefixSid-list>
<type>mpls</type>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
connected-prefix-sid-map
address-family ipv4
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 |
---|---|
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
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 |
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 |
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 |
---|---|---|---|
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:
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:
Deleting An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
Deleting An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv4"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"status": "deleted",
"type": "mpls"
}}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv4</afType>
<pfxsid-items>
<PrefixSid-list xc:operation="delete">
<type>mpls</type>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
connected-prefix-sid-map
no address-family ipv4dress-family ipv4
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 |
---|---|
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
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 |
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 |
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:
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:
Configuring An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings
Configuring An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv6"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"type": "mpls"
}}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv6</afType>
<pfxsid-items>
<PrefixSid-list>
<type>mpls</type>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
connected-prefix-sid-map
address-family ipv6
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 |
---|---|
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
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 |
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 |
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 |
---|---|---|---|
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:
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:
Deleting An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings
Deleting An IPv6 Address-Family Under Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv6"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"status": "deleted",
"type": "mpls"
}}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv6</afType>
<pfxsid-items>
<PrefixSid-list xc:operation="delete">
<type>mpls</type>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
connected-prefix-sid-map
no address-family ipv6
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 |
---|---|
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
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 |
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 |
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:
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:
Configuring An IP Address for An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
Configuring An IP Address for An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv4"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtMplsPrefixSid": {
"attributes": {
"pfx": "0.0.0.0/2",
"sidValue": "123",
"sidValueType": "index"
}}}]}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv4</afType>
<pfxsid-items>
<PrefixSid-list>
<type>mpls</type>
<mplspfxsid-items>
<MplsPrefixSid-list>
<pfx>0.0.0.0/2</pfx>
<sidValue>123</sidValue>
<sidValueType>index</sidValueType>
</MplsPrefixSid-list>
</mplspfxsid-items>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
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).
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 |
---|---|
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
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 |
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 |
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 |
---|---|---|---|
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:
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:
Deleting An IP Address for An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
Deleting An IP Address for An IPv4 Address-Family Under Connected Prefix Segment Identifier Mappings
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"children": [
{
"segrtSrgb": {
"children": [
{
"segrtConfigSrgb": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtLblBlock": {
"attributes": {
"localId": "srgb-1"
}}}]}}]}},{
"segrtDom": {
"attributes": {
"name": "default"
},
"children": [
{
"segrtDomAf": {
"attributes": {
"afType": "ipv4"
},
"children": [
{
"segrtPrefixSid": {
"attributes": {
"type": "mpls"
},
"children": [
{
"segrtMplsPrefixSid": {
"attributes": {
"pfx": "0.0.0.0/2",
"status": "deleted"
}}}]}}]}}]}}]}}]}}]}}
{
"imdata": []
}
POST: http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
<segrt-items>
<inst-items>
<srgb-items>
<cfgsrgb-items>
<ConfigSrgb-list>
<type>mpls</type>
<lblblock-items>
<LblBlock-list>
<localId>srgb-1</localId>
</LblBlock-list>
</lblblock-items>
</ConfigSrgb-list>
</cfgsrgb-items>
</srgb-items>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<afType>ipv4</afType>
<pfxsid-items>
<PrefixSid-list>
<type>mpls</type>
<mplspfxsid-items>
<MplsPrefixSid-list xc:operation="delete">
<pfx>0.0.0.0/2</pfx>
</MplsPrefixSid-list>
</mplspfxsid-items>
</PrefixSid-list>
</pfxsid-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</segrt-items>
</System>
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
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).
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 |
---|---|
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
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 |
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 |
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 |
---|---|---|---|
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 |
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:
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:
Configuring Bytes-Only Adjacency Stats
Configuring Bytes-Only Adjacency Stats
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"platformEntity": {
"attributes": {
"mplsAdjStatsMode": "BYTES"
}}}]}}
{
imdata:[]
}
<System>
<pltfm-items>
<mplsAdjStatsMode>BYTES</mplsAdjStatsMode>
</pltfm-items>
</System>
Note: This example was added in Release 9.3(1).
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.
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:
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:
Deleting Bytes-Only Adjacency Stats
Deleting Bytes-Only Adjacency Stats
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"platformEntity": {
"attributes": {
"mplsAdjStatsMode": "PACKETS"
}}}]}}
{
imdata:[]
}
<System>
<pltfm-items>
<mplsAdjStatsMode>PACKETS</mplsAdjStatsMode>
</pltfm-items>
</System>
Note: This example was added in Release 9.3(1).
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.
no 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:
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: