Configuring Segment Routing for Traffic Engineering
Segment routing for traffic engineering (SR-TE) takes place through a tunnel between a source and destination pair. Segment routing for traffic engineering uses the concept of source routing, where the source calculates the path and encodes it in the packet header as a segment. A Traffic Engineered (TE) tunnel is a container of TE LSPs instantiated between the tunnel ingress and the tunnel destination. A TE tunnel can instantiate one or more SR-TE LSPs that are associated with the same tunnel.
With segment routing for traffic engineering (SR-TE), the network no longer needs to maintain a per-application and per-flow state. Instead, it simply obeys the forwarding instructions provided in the packet. SR-TE utilizes network bandwidth more effectively than traditional MPLS-TE networks by using ECMP at every segment level. It uses a single intelligent source and relieves remaining routers from the task of calculating the required path through the network.
For more information, see the Cisco Nexus 9000 Series NX-OS Label Switching Configuration Guide:
Configuring an Affinity Map
Configuring an Affinity Map
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffMap": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<affmap-items>
<adminSt>enabled</adminSt>
</affmap-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
affinity-map
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 |
srteTE | sys/segrt/te |
srteAffMap | sys/segrt/te/affmap |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteAffMap Properties
The following table contains information about the srteAffMap 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 |
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:
|
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 Affinity Map
Deleting an Affinity Map
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffMap": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<affmap-items>
<adminSt>disabled</adminSt>
</affmap-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
no affinity-map
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 |
srteTE | sys/segrt/te |
srteAffMap | sys/segrt/te/affmap |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteAffMap Properties
The following table contains information about the srteAffMap 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 |
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:
|
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 Candidate Paths
Configuring Candidate Paths
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
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:
|
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 Candidate Paths
Deleting Candidate Paths
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>disabled</adminSt>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
no candidate-paths
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
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:
|
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 Candidate Path-Option Constraints
Configuring Candidate Path-Option Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
}
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Path-Option Constraints
Deleting Candidate Path-Option Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "disabled"
}
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>disabled</adminSt>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
no constraints
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Affinity Constraints
Configuring Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Affinity Constraints
Deleting Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>disabled</adminSt>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
no affinity
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Exclude-Any Affinity Constraints
Configuring Exclude-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteExcludeany": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<exclany-items>
<adminSt>enabled</adminSt>
</exclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
exclude-any
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteExcludeany | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity/exclany |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteExcludeany Properties
The following table contains information about the srteExcludeany 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Exclude-Any Affinity Constraints
Deleting Exclude-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteExcludeany": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<exclany-items>
<adminSt>disabled</adminSt>
</exclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
no exclude-any
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteExcludeany | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity/exclany |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteExcludeany Properties
The following table contains information about the srteExcludeany 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Include-All Affinity Constraints
Configuring Include-All Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteIncludeall": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclall-items>
<adminSt>enabled</adminSt>
</inclall-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
include-all
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteIncludeall | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity/inclall |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteIncludeall Properties
The following table contains information about the srteIncludeall 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Include-All Affinity Constraints
Deleting Include-All Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteIncludeall": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclall-items>
<adminSt>disabled</adminSt>
</inclall-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
no include-all
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteIncludeall | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity/inclall |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteIncludeall Properties
The following table contains information about the srteIncludeall 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Include-Any Affinity Constraints
Configuring Include-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteIncludeany": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclany-items>
<adminSt>enabled</adminSt>
</inclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
include-any
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteIncludeany | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity/inclany |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteIncludeany Properties
The following table contains information about the srteIncludeany 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Include-Any Affinity Constraints
Deleting Include-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteIncludeany": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclany-items>
<adminSt>disabled</adminSt>
</inclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
no include-any
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteIncludeany | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity/inclany |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteIncludeany Properties
The following table contains information about the srteIncludeany 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Path Association Group
Configuring Candidate Path Association Group
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Path Association Group
Deleting Candidate Path Association Group
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>disabled</adminSt>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
no association-group
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 a Disjointness Association Type
Configuring a Disjointness Association Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Disjointness Association Type
Deleting a Disjointness Association Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>disabled</adminSt>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
no disjoint
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Link Disjointness
Configuring Link Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "link"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>link</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
type link
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Link Disjointness
Deleting Link Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "none"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>none</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
no type link
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Node Disjointness
Configuring Node Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "node"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>node</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
type node
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Node Disjointness
Deleting Node Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "none"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>none</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
no type node
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Path-Option Segments
Configuring Candidate Path-Option Segments
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteSegments": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<segment-items>
<adminSt>enabled</adminSt>
</segment-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
segments
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteSegments | sys/segrt/te/color-123/cndpaths/pref-123/constraints/segment |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteSegments Properties
The following table contains information about the srteSegments 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Path-Option Segments
Deleting Candidate Path-Option Segments
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteSegments": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<segment-items>
<adminSt>disabled</adminSt>
</segment-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
no segments
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteSegments | sys/segrt/te/color-123/cndpaths/pref-123/constraints/segment |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteSegments Properties
The following table contains information about the srteSegments 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Dynamic Path Option
Configuring the Dynamic Path Option
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<dyn-items>
<adminSt>enabled</adminSt>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
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:
|
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 Dynamic Path Option
Deleting the Dynamic Path Option
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteDynamic": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<dyn-items>
<adminSt>disabled</adminSt>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
no dynamic
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
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:
|
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 Dynamic Path-Option Metric Type
Configuring Dynamic Path-Option Metric Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteMetric": {
"attributes": {
"adminSt": "enabled",
"metricType": "igp"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<dyn-items>
<adminSt>enabled</adminSt>
<metric-items>
<adminSt>enabled</adminSt>
<metricType>igp</metricType>
</metric-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
metric
type IGP
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteMetric | sys/segrt/te/color-123/cndpaths/pref-123/dyn/metric |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteMetric Properties
The following table contains information about the srteMetric 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 |
metricType | srte:Metric (scalar:Enum8) | Metric Type | SELECTION: 0 - none 1 - te 2 - igp DEFAULT: none |
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:
|
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 Dynamic Path-Option Metric Type
Deleting Dynamic Path-Option Metric Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteMetric": {
"attributes": {
"adminSt": "enabled",
"metricType": "igp"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<dyn-items>
<adminSt>enabled</adminSt>
<metric-items>
<adminSt>enabled</adminSt>
<metricType>igp</metricType>
</metric-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
metric
no type IGP
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteMetric | sys/segrt/te/color-123/cndpaths/pref-123/dyn/metric |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteMetric Properties
The following table contains information about the srteMetric 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 |
metricType | srte:Metric (scalar:Enum8) | Metric Type | SELECTION: 0 - none 1 - te 2 - igp DEFAULT: none |
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:
|
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 Dynamic Path Needs to be Computed Externally Via PCEP
Configuring Dynamic Path Needs to be Computed Externally Via PCEP
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Dynamic Path Needs to be Computed Externally Via PCEP
Deleting Dynamic Path Needs to be Computed Externally Via PCEP
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>disabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
no pcep
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Paths
Configuring Candidate Paths
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
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:
|
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 Candidate Paths
Deleting Candidate Paths
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<expcndpaths-items>
<adminSt>disabled</adminSt>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
no candidate-paths
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
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:
|
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 Candidate Path-Option Constraints
Configuring Candidate Path-Option Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
}
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Candidate Path-Option Constraints
Deleting Candidate Path-Option Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "disabled"
}
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>disabled</adminSt>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
no constraints
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Affinity Constraints
Configuring Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Affinity Constraints
Deleting Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>disabled</adminSt>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
no affinity
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Exclude-Any Affinity Constraints
Configuring Exclude-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolExcludeany": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<exclany-items>
<adminSt>enabled</adminSt>
</exclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
exclude-any
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolExcludeany | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity/exclany |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolExcludeany Properties
The following table contains information about the srtePolExcludeany 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Exclude-Any Affinity Constraints
Deleting Exclude-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolExcludeany": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<exclany-items>
<adminSt>disabled</adminSt>
</exclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
no exclude-any
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolExcludeany | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity/exclany |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolExcludeany Properties
The following table contains information about the srtePolExcludeany 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Include-All Affinity Constraints
Configuring Include-All Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolIncludeall": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclall-items>
<adminSt>enabled</adminSt>
</inclall-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
include-all
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolIncludeall | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity/inclall |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolIncludeall Properties
The following table contains information about the srtePolIncludeall 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Include-All Affinity Constraints
Deleting Include-All Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolIncludeall": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclall-items>
<adminSt>disabled</adminSt>
</inclall-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
no include-all
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolIncludeall | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity/inclall |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolIncludeall Properties
The following table contains information about the srtePolIncludeall 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Include-Any Affinity Constraints
Configuring Include-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolIncludeany": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclany-items>
<adminSt>enabled</adminSt>
</inclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
include-any
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolIncludeany | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity/inclany |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolIncludeany Properties
The following table contains information about the srtePolIncludeany 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Include-Any Affinity Constraints
Deleting Include-Any Affinity Constraints
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAffinity": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolIncludeany": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
<inclany-items>
<adminSt>disabled</adminSt>
</inclany-items>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
no include-any
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAffinity | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity |
srtePolIncludeany | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/affinity/inclany |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAffinity Properties
The following table contains information about the srtePolAffinity 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 |
srtePolIncludeany Properties
The following table contains information about the srtePolIncludeany 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Candidate Path Association Group
Configuring Candidate Path Association Group
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Candidate Path Association Group
Deleting Candidate Path Association Group
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>disabled</adminSt>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
no association-group
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 a Disjointness Association Type
Configuring a Disjointness Association Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Disjointness Association Type
Deleting a Disjointness Association Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>disabled</adminSt>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
no disjoint
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Link Disjointness
Configuring Link Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "link"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>link</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
type link
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Link Disjointness
Deleting Link Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "none"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>none</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
no type link
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Node Disjointness
Configuring Node Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "node"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>node</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
type node
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Node Disjointness
Deleting Node Disjointness
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled",
"disjType": "none"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<disjType>none</disjType>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
no type node
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
disjType | srte:DisjointType (scalar:Enum8) | Specifies the type of disjointness this path needs to be. | SELECTION: 0 - none 1 - node 2 - link DEFAULT: none |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Candidate Path-Option Segments
Configuring Candidate Path-Option Segments
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolSegments": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<segment-items>
<adminSt>enabled</adminSt>
</segment-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
segments
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolSegments | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/segment |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolSegments Properties
The following table contains information about the srtePolSegments 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Candidate Path-Option Segments
Deleting Candidate Path-Option Segments
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolSegments": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<segment-items>
<adminSt>disabled</adminSt>
</segment-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
no segments
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolSegments | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/segment |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolSegments Properties
The following table contains information about the srtePolSegments 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 |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Dynamic Path Option
Configuring the Dynamic Path Option
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<dyn-items>
<adminSt>enabled</adminSt>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
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:
|
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 Dynamic Path Option
Deleting the Dynamic Path Option
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolDynamic": {
"attributes": {
"adminSt": "disabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<dyn-items>
<adminSt>disabled</adminSt>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
no dynamic
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
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:
|
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 Dynamic Path-Option Metric Type
Configuring Dynamic Path-Option Metric Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolMetric": {
"attributes": {
"adminSt": "enabled",
"metricType": "igp"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<dyn-items>
<adminSt>enabled</adminSt>
<metric-items>
<adminSt>enabled</adminSt>
<metricType>igp</metricType>
</metric-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
metric
type IGP
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolMetric | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/metric |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolMetric Properties
The following table contains information about the srtePolMetric 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 |
metricType | srte:Metric (scalar:Enum8) | Metric Type | SELECTION: 0 - none 1 - te 2 - igp DEFAULT: none |
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:
|
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 Dynamic Path-Option Metric Type
Deleting Dynamic Path-Option Metric Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolMetric": {
"attributes": {
"adminSt": "enabled",
"metricType": "igp"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<dyn-items>
<adminSt>enabled</adminSt>
<metric-items>
<adminSt>enabled</adminSt>
<metricType>igp</metricType>
</metric-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
metric
no type IGP
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolMetric | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/metric |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolMetric Properties
The following table contains information about the srtePolMetric 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 |
metricType | srte:Metric (scalar:Enum8) | Metric Type | SELECTION: 0 - none 1 - te 2 - igp DEFAULT: none |
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:
|
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 Dynamic Path Needs to be Computed Externally Via PCEP
Configuring Dynamic Path Needs to be Computed Externally Via PCEP
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
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 |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Traffic Engineering Related Configurations
Configuring Traffic Engineering Related Configurations
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
}
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
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 |
srteTE | sys/segrt/te |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
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:
|
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 Traffic Engineering Related Configurations
Deleting Traffic Engineering Related Configurations
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"status": "deleted"
}
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items nc:operation="delete">
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
no traffic-engineering
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 |
srteTE | sys/segrt/te |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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:
|
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 Segment Routing Parameters
Configuring Segment Routing Parameters
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
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 |
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:
|
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 Segment Routing Parameters
Deleting Segment Routing Parameters
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"status": "deleted"
}
}
},
{
"segrtInst": {
"attributes": {
"status": "deleted"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items nc:operation="delete">
</te-items>
<inst-items nc:operation="delete">
</inst-items>
</segrt-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 segment-routing
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 |
srteTE | sys/segrt/te |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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 Candidate Path-Option Preference Entry
Configuring Candidate Path-Option Preference Entry
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "35594"
}
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>35594</prefVal>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 35594
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-35594 |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
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:
|
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 Candidate Path-Option Preference Entry
Deleting Candidate Path-Option Preference Entry
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "35594",
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list nc:operation="delete">
<prefVal>35594</prefVal>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
no preference 35594
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 |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-35594 |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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:
|
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 Affinity Map Color
Deleting an Affinity Map Color
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffMap": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffColor": {
"attributes": {
"name": "SampleString_123",
"status": "deleted"
}
}
}
]
}
},
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAffinity": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<affmap-items>
<adminSt>enabled</adminSt>
<affcol-items>
<AffColor-list nc:operation="delete">
<name>SampleString_123</name>
</AffColor-list>
</affcol-items>
</affmap-items>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<affinity-items>
<adminSt>enabled</adminSt>
</affinity-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
affinity
affinity-map
no color SampleString_123
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 |
srteTE | sys/segrt/te |
srteAffMap | sys/segrt/te/affmap |
srteAffColor | sys/segrt/te/affmap/affcol-SampleString_123 |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAffinity | sys/segrt/te/color-123/cndpaths/pref-123/constraints/affinity |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteAffMap Properties
The following table contains information about the srteAffMap 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 |
srteAffColor Properties
The following table contains information about the srteAffColor 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 | srte:Name (string:Basic) | User defined named of the affinity Color Affinity Name | A sequence of characters |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAffinity Properties
The following table contains information about the srteAffinity 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 |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 a Candidate Path Association Group Id
Configuring a Candidate Path Association Group Id
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled",
"id": "1"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<id>1</id>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
id 1
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
segrtEntity | sys/segrt |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
id | scalar:Uint32 | Association group Identifier | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 Candidate Path Association Group Id
Deleting a Candidate Path Association Group Id
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteColor": {
"attributes": {
"color": "123"
},
"children": [
{
"srteCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePref": {
"attributes": {
"prefVal": "123"
},
"children": [
{
"srteConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDisjointness": {
"attributes": {
"adminSt": "enabled",
"id": "0"
}
}
}
]
}
}
]
}
},
{
"srteDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<color-items>
<Color-list>
<color>123</color>
<cndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<Pref-list>
<prefVal>123</prefVal>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<id>0</id>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</Pref-list>
</pref-items>
</cndpaths-items>
</Color-list>
</color-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
on-demand color 123
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
no id 1
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
segrtEntity | sys/segrt |
srteTE | sys/segrt/te |
srteColor | sys/segrt/te/color-123 |
srteCndPaths | sys/segrt/te/color-123/cndpaths |
srtePref | sys/segrt/te/color-123/cndpaths/pref-123 |
srteConstraint | sys/segrt/te/color-123/cndpaths/pref-123/constraints |
srteAssoc | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc |
srteDisjointness | sys/segrt/te/color-123/cndpaths/pref-123/constraints/assoc/disj |
srteDynamic | sys/segrt/te/color-123/cndpaths/pref-123/dyn |
srteDynPce | sys/segrt/te/color-123/cndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteColor Properties
The following table contains information about the srteColor 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Color | RANGE: [0 , 4294967295] DEFAULT: 0 |
srteCndPaths Properties
The following table contains information about the srteCndPaths 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 |
srtePref Properties
The following table contains information about the srtePref 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 |
---|---|---|---|
prefVal | scalar:Uint32 | Preference Value of the Candidate path. Higher preference value is preferred | RANGE: [0, 4294967295] |
srteConstraint Properties
The following table contains information about the srteConstraint 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 |
srteAssoc Properties
The following table contains information about the srteAssoc 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 |
srteDisjointness Properties
The following table contains information about the srteDisjointness 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 |
id | scalar:Uint32 | Association group Identifier | RANGE: [0, 4294967295] |
srteDynamic Properties
The following table contains information about the srteDynamic 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 |
srteDynPce Properties
The following table contains information about the srteDynPce 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 |
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:
|
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 a Candidate Path Association Group Id
Configuring a Candidate Path Association Group Id
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled",
"id": "1"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<id>1</id>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
id 1
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
segrtEntity | sys/segrt |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
id | scalar:Uint32 | Association group Identifier | RANGE: [0, 4294967295] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 Candidate Path Association Group Id
Deleting a Candidate Path Association Group Id
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolicy": {
"attributes": {
"color": "211",
"endpoint": "2.2.2.2",
"name": "POL_1"
},
"children": [
{
"srteExpCndPaths": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolPref": {
"attributes": {
"pref": "123"
},
"children": [
{
"srtePolConstraint": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolAssoc": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDisjointness": {
"attributes": {
"adminSt": "enabled",
"id": "0"
}
}
}
]
}
}
]
}
},
{
"srtePolDynamic": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srtePolDynPce": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<policy-items>
<Policy-list>
<name>POL_1</name>
<color>211</color>
<endpoint>2.2.2.2</endpoint>
<expcndpaths-items>
<adminSt>enabled</adminSt>
<pref-items>
<PolPref-list>
<pref>123</pref>
<constraints-items>
<adminSt>enabled</adminSt>
<assoc-items>
<adminSt>enabled</adminSt>
<disj-items>
<adminSt>enabled</adminSt>
<id>0</id>
</disj-items>
</assoc-items>
</constraints-items>
<dyn-items>
<adminSt>enabled</adminSt>
<pce-items>
<adminSt>enabled</adminSt>
</pce-items>
</dyn-items>
</PolPref-list>
</pref-items>
</expcndpaths-items>
</Policy-list>
</policy-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
policy POL_1
color 211 endpoint 2.2.2.2
candidate-paths
preference 123
dynamic
pcep
constraints
association-group
disjoint
no id 1
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
segrtEntity | sys/segrt |
srteTE | sys/segrt/te |
srtePolicy | sys/segrt/te/policy-POL_1 |
srteExpCndPaths | sys/segrt/te/policy-POL_1/expcndpaths |
srtePolPref | sys/segrt/te/policy-POL_1/expcndpaths/pref-123 |
srtePolConstraint | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints |
srtePolAssoc | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc |
srtePolDisjointness | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/constraints/assoc/disj |
srtePolDynamic | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn |
srtePolDynPce | sys/segrt/te/policy-POL_1/expcndpaths/pref-123/dyn/pce |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srtePolicy Properties
The following table contains information about the srtePolicy 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 |
---|---|---|---|
color | srte:ColorVal (scalar:Uint64) | Policy color | RANGE: [0 , 4294967295] DEFAULT: 0 |
endpoint | address:Ip | Endpoint IP address | Value must match ipv4 or ipv6 known format |
name | srte:Name (string:Basic) | Policy name | Must be unique for each policy. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
srteExpCndPaths Properties
The following table contains information about the srteExpCndPaths 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 |
srtePolPref Properties
The following table contains information about the srtePolPref 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 |
---|---|---|---|
pref | srte:OptNum (scalar:Uint32) | The preference value for the group of explicit paths | RANGE: [1 , 65535] |
srtePolConstraint Properties
The following table contains information about the srtePolConstraint 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 |
srtePolAssoc Properties
The following table contains information about the srtePolAssoc 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 |
srtePolDisjointness Properties
The following table contains information about the srtePolDisjointness 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 |
id | scalar:Uint32 | Association group Identifier | RANGE: [0, 4294967295] |
srtePolDynamic Properties
The following table contains information about the srtePolDynamic 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 |
srtePolDynPce Properties
The following table contains information about the srtePolDynPce 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 |
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:
|
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 a Segment List Name
Configuring a Segment List Name
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteSegList": {
"attributes": {
"name": "SampleString_123"
}
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<seglist-items>
<SegList-list>
<name>SampleString_123</name>
</SegList-list>
</seglist-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
segment-list name SampleString_123
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 |
srteTE | sys/segrt/te |
srteSegList | sys/segrt/te/seglist-SampleString_123 |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteSegList Properties
The following table contains information about the srteSegList 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 | srte:Name (string:Basic) | Segment list name | Must be unique for each explicit path. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
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:
|
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 Segment List Name
Deleting a Segment List Name
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteSegList": {
"attributes": {
"name": "SampleString_123",
"status": "deleted"
}
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<seglist-items>
<SegList-list nc:operation="delete">
<name>SampleString_123</name>
</SegList-list>
</seglist-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
no segment-list name SampleString_123
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 |
srteTE | sys/segrt/te |
srteSegList | sys/segrt/te/seglist-SampleString_123 |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteSegList Properties
The following table contains information about the srteSegList 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 | srte:Name (string:Basic) | Segment list name | Must be unique for each explicit path. The name must only contain letters, digits, and the hyphen and underscore characters A sequence of characters |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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:
|
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 Ethernet Interface
Configuring an Ethernet Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteIf": {
"attributes": {
"id": "eth1/2"
}
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<if-items>
<If-list>
<id>eth1/2</id>
</If-list>
</if-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
interface ethernet 1/2
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 |
srteTE | sys/segrt/te |
srteIf | sys/segrt/te/if-[eth1/2] |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteIf Properties
The following table contains information about the srteIf 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 |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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:
|
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 Ethernet Interface
Deleting an Ethernet Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"segrtEntity": {
"children": [
{
"srteTE": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"srteIf": {
"attributes": {
"id": "eth1/2",
"status": "deleted"
}
}
}
]
}
},
{
"segrtInst": {
"attributes": {
"adminSt": "enabled"
}
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<segrt-items>
<te-items>
<adminSt>enabled</adminSt>
<if-items>
<If-list nc:operation="delete">
<id>eth1/2</id>
</If-list>
</if-items>
</te-items>
<inst-items>
<adminSt>enabled</adminSt>
</inst-items>
</segrt-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.
segment-routing
traffic-engineering
no interface ethernet 1/2
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 |
srteTE | sys/segrt/te |
srteIf | sys/segrt/te/if-[eth1/2] |
segrtInst | sys/segrt/inst |
srteTE Properties
The following table contains information about the srteTE 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 |
srteIf Properties
The following table contains information about the srteIf 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 |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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:
|
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: