Configuring SRv6

Segment Routing (SR) can be applied on both MPLS and IPv6 data planes. In a SR-MPLS enabled network, an MPLS label is used as the Segment Identifier (SID) and the source router chooses a path to the destination and encodes the path in the packet header as a stack of labels. In a Segment Routing over IPv6 (SRv6) network, the IPv6 address serves as the SID. The source router encodes the path to destination as an ordered list of segments (list of IPv6 addresses) in the IPv6 packet. To encode an ordered list of IPv6 addresses in an IPv6 packet, a new routing header which is an extension header is used. This new header for SRv6 is called Segment Routing Header (SRH). In an SRv6 enabled network, the active segment is indicated by the destination address of the packet, and the next segment is indicated by a pointer in the SRH. SRv6 works on IPv6 data forwarding and is suitable for all data center deployments. SRv6 with SRH facilitates traffic engineering and path protection capabilities. Minus the SRH, SRv6 also supports traffic forwarding for multi-tenants with only the IPv6 packet header. In this case, the IPv6 destination address (128-bit) represents the reachability (locator) and the VPN function.

The forwarding methodology is such that if the destination address is within the locator space and is not in the SID table, it checks the standard routing table for a match.

For more information, see the Cisco Nexus 9000 Series NX-OS SRv6 Configuration Guide:

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

Configuring a Locator and Encapsulation Source

Configuring a Locator and Encapsulation Source
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srv6Entity": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srv6Encapsulation": {
                      "attributes": {
                        "adminSt": "enabled",
                        "srcAddress": "1::1"
                      }
                    }
                  },
                  {
                    "srv6Locators": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srv6Locator": {
                            "attributes": {
                              "name": "main-locator",
                              "prefix": "cafe:0:a:100::/64"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <srv6-items>
      <adminSt>enabled</adminSt>
      <encapsulation-items>
        <adminSt>enabled</adminSt>
        <srcAddress>1::1</srcAddress>
      </encapsulation-items>
      <locators-items>
        <adminSt>enabled</adminSt>
        <locator-items>
          <Locator-list>
            <name>main-locator</name>
            <prefix>cafe:0:a:100::/64</prefix>
          </Locator-list>
        </locator-items>
      </locators-items>
    </srv6-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>
</System>

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


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
  srv6
   locators
    locator main-locator
    prefix cafe:0:a:100::/64
    encapsulation
    source-address 1::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.

MODN
topSystem sys
segrtEntity sys/segrt
srv6Entity sys/segrt/srv6
srv6Encapsulation sys/segrt/srv6/encapsulation
srv6Locators sys/segrt/srv6/locators
srv6Locator sys/segrt/srv6/locators/locator-main-locator
segrtInst sys/segrt/inst


srv6Entity Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srv6Encapsulation Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
srcAddressaddress:Ip
IPv6 addressValue must match the ipv6 known format


srv6Locators Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srv6Locator Properties

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

Property NameData TypeDescriptionValues
namesrv6:LocName
(string:Basic)
Locator nameA sequence of characters
prefixaddress:Ip
Locator addressValue must match the ipv6 known format


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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Configuring Traffic Engineering

Configuring Traffic Engineering
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(5).


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.

MODN
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 NameData TypeDescriptionValues
adminStnw: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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Deleting Traffic Engineering

Deleting Traffic Engineering
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(5).


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.

MODN
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 NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Configuring a Policy

Configuring a Policy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srtePolicy": {
                      "attributes": {
                        "color": "1",
                        "endpoint": "1:2::3:4",
                        "name": "POL_1"
                      }
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <policy-items>
        <Policy-list>
          <name>POL_1</name>
          <color>1</color>
          <endpoint>1:2::3:4</endpoint>
        </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(5).


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 1 endpoint 1:2::3:4


Verifying a DME Configuration

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

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srtePolicy sys/segrt/te/policy-POL_1
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 NameData TypeDescriptionValues
adminStnw: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 NameData TypeDescriptionValues
colorsrte:ColorVal
(scalar:Uint64)
Segment Routing TE Policy Color
RANGE: [0 , 4294967295]
DEFAULT: 0
endpointaddress:Ip
Segment Routing TE Endpoint IPv4/v6 addressValue must match the ipv6 known format
namesrte:Name
(string:Basic)
Segment Routing TE 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


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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Deleting a Policy

Deleting a Policy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srtePolicy": {
                      "attributes": {
                        "name": "POL_1",
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <policy-items>
        <Policy-list nc:operation="delete">
          <name>POL_1</name>
        </Policy-list>
      </policy-items>
    </te-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>

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


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 policy POL_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.

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srtePolicy sys/segrt/te/policy-POL_1
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 NameData TypeDescriptionValues
adminStnw: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 NameData TypeDescriptionValues
namesrte:Name
(string:Basic)
Segment Routing TE 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
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Configuring SRv6 Under SRTE

Configuring SRv6 Under SRTE
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srteSR": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srteSRv6": {
                            "attributes": {
                              "adminSt": "enabled"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <sr-items>
        <adminSt>enabled</adminSt>
        <srv6-items>
          <adminSt>enabled</adminSt>
        </srv6-items>
      </sr-items>
    </te-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>
</System>

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


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


Verifying a DME Configuration

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

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srteSR sys/segrt/te/sr
srteSRv6 sys/segrt/te/sr/srv6
segrtInst sys/segrt/inst


srteTE, srteSR, srteSRv6, and segrtInst 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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Deleting SRv6 Under SRTE


Deleting SRv6 Under SRTE
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srteSR": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srteSRv6": {
                            "attributes": {
                              "adminSt": "disabled"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <sr-items>
        <adminSt>enabled</adminSt>
        <srv6-items>
          <adminSt>disabled</adminSt>
        </srv6-items>
      </sr-items>
    </te-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>
</System>

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


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-routing
    no srv6


Verifying a DME Configuration

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

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srteSR sys/segrt/te/sr
srteSRv6 sys/segrt/te/sr/srv6
segrtInst sys/segrt/inst


srteTE, srteSR, srteSRv6, and segrtInst 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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Configuring the SRv6 SRTE Locators Item

Configuring the SRv6 SRTE Locators Item
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srteSR": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srteSRv6": {
                            "attributes": {
                              "adminSt": "enabled"
                            },
                            "children": [
                              {
                                "srteLocators": {
                                  "attributes": {
                                    "adminSt": "enabled"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <sr-items>
        <adminSt>enabled</adminSt>
        <srv6-items>
          <adminSt>enabled</adminSt>
          <locs-items>
            <adminSt>enabled</adminSt>
          </locs-items>
        </srv6-items>
      </sr-items>
    </te-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>
</System>

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


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-routing
    srv6
     locators


Verifying a DME Configuration

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

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srteSR sys/segrt/te/sr
srteSRv6 sys/segrt/te/sr/srv6
srteLocators sys/segrt/te/sr/srv6/locs
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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSR Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSRv6 Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteLocators Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Deleting the SRv6 SRTE Locators Item

Deleting the SRv6 SRTE Locators Item
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srteSR": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srteSRv6": {
                            "attributes": {
                              "adminSt": "enabled"
                            },
                            "children": [
                              {
                                "srteLocators": {
                                  "attributes": {
                                    "adminSt": "disabled"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <sr-items>
        <adminSt>enabled</adminSt>
        <srv6-items>
          <adminSt>enabled</adminSt>
          <locs-items>
            <adminSt>disabled</adminSt>
          </locs-items>
        </srv6-items>
      </sr-items>
    </te-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>
</System>

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


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-routing
    srv6
     no locators


Verifying a DME Configuration

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

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srteSR sys/segrt/te/sr
srteSRv6 sys/segrt/te/sr/srv6
srteLocators sys/segrt/te/sr/srv6/locs
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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSR Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSRv6 Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteLocators Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Configuring the Default Locator Name

Configuring the Default Locator Name
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srteSR": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srteSRv6": {
                            "attributes": {
                              "adminSt": "enabled"
                            },
                            "children": [
                              {
                                "srteLocators": {
                                  "attributes": {
                                    "adminSt": "enabled"
                                  },
                                  "children": [
                                    {
                                      "srteLocator": {
                                        "attributes": {
                                          "name": "SampleString_123"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <sr-items>
        <adminSt>enabled</adminSt>
        <srv6-items>
          <adminSt>enabled</adminSt>
          <locs-items>
            <adminSt>enabled</adminSt>
            <loc-items>
              <Locator-list>
                <name>SampleString_123</name>
              </Locator-list>
            </loc-items>
          </locs-items>
        </srv6-items>
      </sr-items>
    </te-items>
    <inst-items>
      <adminSt>enabled</adminSt>
    </inst-items>
  </segrt-items>
</System>

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

The locator name element specifies the name of the locator that will be used for allocating policies. This is a reference by name to the global locator definition, and as such, the global locator must be separately defined under the top level segment-routing subitem srv6.


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-routing
    srv6
     locators
      locator 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.

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srteSR sys/segrt/te/sr
srteSRv6 sys/segrt/te/sr/srv6
srteLocators sys/segrt/te/sr/srv6/locs
srteLocator sys/segrt/te/sr/srv6/locs/loc-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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSR Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSRv6 Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteLocators Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteLocator Properties

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

Property NameData TypeDescriptionValues
namesrte:Name
(string:Basic)
Locator name for SRv6 Traffic Engineering
The name must only contain letters, digits, and the hyphen and underscore 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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Deleting the Default Locator Name

Deleting the Default Locator Name
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srteSR": {
                      "attributes": {
                        "adminSt": "enabled"
                      },
                      "children": [
                        {
                          "srteSRv6": {
                            "attributes": {
                              "adminSt": "enabled"
                            },
                            "children": [
                              {
                                "srteLocators": {
                                  "attributes": {
                                    "adminSt": "enabled"
                                  },
                                  "children": [
                                    {
                                      "srteLocator": {
                                        "attributes": {
                                          "name": "SampleString_123",
                                          "status": "deleted"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}

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


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-routing
    srv6
     locators
      no locator 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.

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srteSR sys/segrt/te/sr
srteSRv6 sys/segrt/te/sr/srv6
srteLocators sys/segrt/te/sr/srv6/locs
srteLocator sys/segrt/te/sr/srv6/locs/loc-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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSR Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteSRv6 Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteLocators Properties

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

Property NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


srteLocator Properties

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

Property NameData TypeDescriptionValues
namesrte:Name
(string:Basic)
Locator name for SRv6 Traffic Engineering
The name must only contain letters, digits, and the hyphen and underscore characters
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Configuring a Route with Complete SRv6 Encap (Without Traffic Engineering Policy)

Configuring a Route with Complete SRv6 Encap (Without Traffic Engineering Policy)
POST http://<mgmt0_IP>/api/mo/sys/ofm.json
{
  "ofmInst": {
    "children": [
      {
        "ofmTunnelProfile": {
          "attributes": {
            "encaptype": "srv6",
            "profName": "test"
          },
          "children": [
            {
              "ofmRouteSrv6": {
                "attributes": {
                  "function": "66",
                  "remoteLocator": "6000:0:6::",
                  "route": "13.0.0.0/24",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ofm-items>
    <tunnelprofile-items>
      <TunnelProfile-list>
        <profName>test</profName>
        <encaptype>srv6</encaptype>
        <routevrf-items>
          <RouteSrv6-list>
            <vrfName>default</vrfName>
            <route>13.0.0.0/24</route>
            <function>66</function>
            <remoteLocator>6000:0:6::</remoteLocator>
          </RouteSrv6-list>
        </routevrf-items>
      </TunnelProfile-list>
    </tunnelprofile-items>
  </ofm-items>
</System>

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


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.

tunnel-profile test
  encapsulation srv6
   route vrf default 13.0.0.0/24 remote-locator 6000:0:6:: function 66


Verifying a DME Configuration

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

MODN
ofmInst sys/ofm
ofmTunnelProfile sys/ofm/tunnelprofile-[test]
ofmRouteSrv6 sys/ofm/tunnelprofile-[test]/routevrf-[default]-routeip-[13.0.0.0/24]


ofmTunnelProfile Properties

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

Property NameData TypeDescriptionValues
encaptypeofm:encapType
(scalar:Enum8)
Encapsulation type for tunnel profile. The encapsulation type must be set to srv6 to configure SRv6 routes. VXLAN is not supported. SELECTION:
0 - none
1 - vxlan
2 - srv6
DEFAULT: none
profNameofm:profileName
(string:Basic)
Name of Tunnel Profile
MAX SIZE: 50


ofmRouteSrv6 Properties

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

Property NameData TypeDescriptionValues
functionscalar:Uint32
Function in the remote sid
RANGE: [0 , 65534]
remoteLocatoraddress:IPv6
Ipv6 locator of remote srv6 peerValue must match ipv6 format
routeaddress:Ip
IP address for Srv6Value must match ipv4 or ipv6 known format
vrfNamel3:VrfName
(string:Basic)
Vrf name for Srv6A sequence of characters
DEFAULT: default


Related Documentation

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

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

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

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

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

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

Configuring a Route with Complete SRv6 Encap with Traffic Engineering Policy

Configuring a Route with Complete SRv6 Encap with Traffic Engineering Policy
POST http://<mgmt0_IP>/api/mo/sys/ofm.json
{
  "ofmInst": {
    "children": [
      {
        "ofmTunnelProfile": {
          "attributes": {
            "encaptype": "srv6",
            "profName": "test"
          },
          "children": [
            {
              "ofmRouteSrv6": {
                "attributes": {
                  "function": "66",
                  "remoteLocator": "6000:0:6::",
                  "route": "14.0.0.0/24",
                  "tePolicyName": "POLICY1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ofm-items>
    <tunnelprofile-items>
      <TunnelProfile-list>
        <profName>test</profName>
        <encaptype>srv6</encaptype>
        <routevrf-items>
          <RouteSrv6-list>
            <vrfName>default</vrfName>
            <route>14.0.0.0/24</route>
            <function>66</function>
            <remoteLocator>6000:0:6::</remoteLocator>
            <tePolicyName>POLICY1</tePolicyName>
          </RouteSrv6-list>
        </routevrf-items>
      </TunnelProfile-list>
    </tunnelprofile-items>
  </ofm-items>
</System>

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


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.

tunnel-profile test
  encapsulation srv6
   route vrf default 14.0.0.0/24 remote-locator 6000:0:6:: function 66 via policy name POLICY1


Verifying a DME Configuration

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

MODN
ofmInst sys/ofm
ofmTunnelProfile sys/ofm/tunnelprofile-[test]
ofmRouteSrv6 sys/ofm/tunnelprofile-[test]/routevrf-[default]-routeip-[14.0.0.0/24]


ofmTunnelProfile Properties

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

Property NameData TypeDescriptionValues
encaptypeofm:encapType
(scalar:Enum8)
Encapsulation type for tunnel profile. The encapsulation type must be set to srv6 to configure SRv6 routes. VXLAN is not supported. SELECTION:
0 - none
1 - vxlan
2 - srv6
DEFAULT: none
profNameofm:profileName
(string:Basic)
Name of Tunnel Profile
MAX SIZE: 50


ofmRouteSrv6 Properties

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

Property NameData TypeDescriptionValues
functionscalar:Uint32
Function in the remote sid
RANGE: [0 , 65534]
remoteLocatoraddress:IPv6
Ipv6 locator of remote srv6 peerValue must match ipv6 format
routeaddress:Ip
IP address for Srv6Value must match ipv4 or ipv6 known format
tePolicyNameofm:TePolicyName
(string:Basic)
Name of the Te-policy
MAX SIZE: 64
vrfNamel3:VrfName
(string:Basic)
Vrf name for Srv6A sequence of characters
DEFAULT: default


Related Documentation

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

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

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

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

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

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

Configuring a Route with Complete SRv6 Encap with Traffic Engineering Policy via Color and Endpoint

Configuring a Route with Complete SRv6 Encap with Traffic Engineering Policy via Color and Endpoint
POST http://<mgmt0_IP>/api/mo/sys/ofm.json
{
  "ofmInst": {
    "children": [
      {
        "ofmTunnelProfile": {
          "attributes": {
            "encaptype": "srv6",
            "profName": "test"
          },
          "children": [
            {
              "ofmRouteSrv6": {
                "attributes": {
                  "color": "1",
                  "endpoint": "6000:0:6::",
                  "function": "66",
                  "remoteLocator": "6000:0:6::",
                  "route": "15.0.0.0/24",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ofm-items>
    <tunnelprofile-items>
      <TunnelProfile-list>
        <profName>test</profName>
        <encaptype>srv6</encaptype>
        <routevrf-items>
          <RouteSrv6-list>
            <vrfName>default</vrfName>
            <route>15.0.0.0/24</route>
            <color>1</color>
            <endpoint>6000:0:6::</endpoint>
            <function>66</function>
            <remoteLocator>6000:0:6::</remoteLocator>
          </RouteSrv6-list>
        </routevrf-items>
      </TunnelProfile-list>
    </tunnelprofile-items>
  </ofm-items>
</System>

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


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.

tunnel-profile test
  encapsulation srv6
   route vrf default 15.0.0.0/24 remote-locator 6000:0:6:: function 66 via policy color 1 endpoint 6000:0:6::


Verifying a DME Configuration

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

MODN
ofmInst sys/ofm
ofmTunnelProfile sys/ofm/tunnelprofile-[test]
ofmRouteSrv6 sys/ofm/tunnelprofile-[test]/routevrf-[default]-routeip-[15.0.0.0/24]


ofmTunnelProfile Properties

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

Property NameData TypeDescriptionValues
encaptypeofm:encapType
(scalar:Enum8)
Encapsulation type for tunnel profile. The encapsulation type must be set to srv6 to configure SRv6 routes. VXLAN is not supported. SELECTION:
0 - none
1 - vxlan
2 - srv6
DEFAULT: none
profNameofm:profileName
(string:Basic)
Name of Tunnel Profile
MAX SIZE: 50


ofmRouteSrv6 Properties

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

Property NameData TypeDescriptionValues
colorscalar:Uint32
Name of Te-policy color
RANGE: [0 , 4294967295]
endpointaddress:IPv6
Ipv6 address of SRv6 End-pointValue must match ipv6 format
functionscalar:Uint32
Function in the remote sid
RANGE: [0 , 65534]
remoteLocatoraddress:IPv6
Ipv6 locator of remote srv6 peerValue must match ipv6 format
routeaddress:Ip
IP address for Srv6Value must match ipv4 or ipv6 known format
vrfNamel3:VrfName
(string:Basic)
Vrf name for Srv6A sequence of characters
DEFAULT: default


Related Documentation

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

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

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

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

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

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

Configuring a Route with Traffic Engineering via a Policy Name

Configuring a Route with Traffic Engineering via a Policy Name
POST http://<mgmt0_IP>/api/mo/sys/ofm.json
{
  "ofmInst": {
    "children": [
      {
        "ofmTunnelProfile": {
          "attributes": {
            "encaptype": "srv6",
            "profName": "test"
          },
          "children": [
            {
              "ofmRouteSrv6": {
                "attributes": {
                  "route": "16.0.0.0/24",
                  "tePolicyName": "POLICY1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ofm-items>
    <tunnelprofile-items>
      <TunnelProfile-list>
        <profName>test</profName>
        <encaptype>srv6</encaptype>
        <routevrf-items>
          <RouteSrv6-list>
            <vrfName>default</vrfName>
            <route>16.0.0.0/24</route>
            <tePolicyName>POLICY1</tePolicyName>
          </RouteSrv6-list>
        </routevrf-items>
      </TunnelProfile-list>
    </tunnelprofile-items>
  </ofm-items>
</System>

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


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.

tunnel-profile test
  encapsulation srv6
   route vrf default 16.0.0.0/24 via policy name POLICY1


Verifying a DME Configuration

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

MODN
ofmInst sys/ofm
ofmTunnelProfile sys/ofm/tunnelprofile-[test]
ofmRouteSrv6 sys/ofm/tunnelprofile-[test]/routevrf-[default]-routeip-[16.0.0.0/24]


ofmTunnelProfile Properties

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

Property NameData TypeDescriptionValues
encaptypeofm:encapType
(scalar:Enum8)
Encapsulation type for tunnel profile. The encapsulation type must be set to srv6 to configure SRv6 routes. VXLAN is not supported. SELECTION:
0 - none
1 - vxlan
2 - srv6
DEFAULT: none
profNameofm:profileName
(string:Basic)
Name of Tunnel Profile
MAX SIZE: 50


ofmRouteSrv6 Properties

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

Property NameData TypeDescriptionValues
routeaddress:Ip
IP address for Srv6Value must match ipv4 or ipv6 known format
tePolicyNameofm:TePolicyName
(string:Basic)
Name of the Te-policy
MAX SIZE: 64
vrfNamel3:VrfName
(string:Basic)
Vrf name for Srv6A sequence of characters
DEFAULT: default


Related Documentation

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

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

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

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

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

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

Configuring a Route with Traffic Engineering via Color and Endpoint

Configuring a Route with Traffic Engineering via Color and Endpoint
POST http://<mgmt0_IP>/api/mo/sys/ofm.json
{
  "ofmInst": {
    "children": [
      {
        "ofmTunnelProfile": {
          "attributes": {
            "encaptype": "srv6",
            "profName": "test"
          },
          "children": [
            {
              "ofmRouteSrv6": {
                "attributes": {
                  "color": "1",
                  "endpoint": "6000:0:6::",
                  "route": "16.0.0.0/24",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ofm-items>
    <tunnelprofile-items>
      <TunnelProfile-list>
        <profName>test</profName>
        <encaptype>srv6</encaptype>
        <routevrf-items>
          <RouteSrv6-list>
            <vrfName>default</vrfName>
            <route>16.0.0.0/24</route>
            <color>1</color>
            <endpoint>6000:0:6::</endpoint>
          </RouteSrv6-list>
        </routevrf-items>
      </TunnelProfile-list>
    </tunnelprofile-items>
  </ofm-items>
</System>

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


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.

tunnel-profile test
  encapsulation srv6
   route vrf default 16.0.0.0/24 via policy color 1 endpoint 6000:0:6::


Verifying a DME Configuration

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

MODN
ofmInst sys/ofm
ofmTunnelProfile sys/ofm/tunnelprofile-[test]
ofmRouteSrv6 sys/ofm/tunnelprofile-[test]/routevrf-[default]-routeip-[16.0.0.0/24]


ofmTunnelProfile Properties

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

Property NameData TypeDescriptionValues
encaptypeofm:encapType
(scalar:Enum8)
Encapsulation type for tunnel profile. The encapsulation type must be set to srv6 to configure SRv6 routes. VXLAN is not supported. SELECTION:
0 - none
1 - vxlan
2 - srv6
DEFAULT: none
profNameofm:profileName
(string:Basic)
Name of Tunnel Profile
MAX SIZE: 50


ofmRouteSrv6 Properties

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

Property NameData TypeDescriptionValues
colorscalar:Uint32
Name of Te-policy color
RANGE: [0 , 4294967295]
endpointaddress:IPv6
Ipv6 address of SRv6 End-pointValue must match ipv6 format
routeaddress:Ip
IP address for Srv6Value must match ipv4 or ipv6 known format
vrfNamel3:VrfName
(string:Basic)
Vrf name for Srv6A sequence of characters
DEFAULT: default


Related Documentation

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

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

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

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

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

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

Enabling OFM

Enabling OFM
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
  "fmEntity": {
    "children": [
      {
        "fmOfm": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <fm-items>
    <ofm-items>
      <adminSt>enabled</adminSt>
    </ofm-items>
  </fm-items>
</System>

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


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.

feature ofm


Verifying a DME Configuration

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

MODN
fmEntity sys/fm
fmOfm sys/fm/ofm


fmOfm Properties

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

Property NameData TypeDescriptionValues
adminStfm:AdminState
(scalar:Enum8)
Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


Related Documentation

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

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

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

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

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

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

Disabling OFM

Disabling OFM
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
  "fmEntity": {
    "children": [
      {
        "fmOfm": {
          "attributes": {
            "adminSt": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <fm-items>
    <ofm-items>
      <adminSt>disabled</adminSt>
    </ofm-items>
  </fm-items>
</System>

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


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


Verifying a DME Configuration

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

MODN
fmEntity sys/fm
fmOfm sys/fm/ofm


fmOfm Properties

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

Property NameData TypeDescriptionValues
adminStfm:AdminState
(scalar:Enum8)
Admin statusSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


Related Documentation

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

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

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

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

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

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

Enabling an SRv6 Tunnel Profile

Enabling an SRv6 Tunnel Profile
POST http://<mgmt0_IP>/api/mo/sys/ofm.json
{
  "ofmInst": {
    "children": [
      {
        "ofmTunnelProfile": {
          "attributes": {
            "encaptype": "srv6",
            "profName": "PROFILE1"
}}}]}}
{
    imdata:[]
}
<System>
  <ofm-items>
    <tunnelprofile-items>
      <TunnelProfile-list>
        <profName>PROFILE1</profName>
        <encaptype>srv6</encaptype>
      </TunnelProfile-list>
    </tunnelprofile-items>
  </ofm-items>
</System>

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


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.

tunnel-profile PROFILE1
  encapsulation srv6


Verifying a DME Configuration

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

MODN
ofmInst sys/ofm
ofmTunnelProfile sys/ofm/tunnelprofile-[PROFILE1]


ofmTunnelProfile Properties

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

Property NameData TypeDescriptionValues
encaptypeofm:encapType
(scalar:Enum8)
Encapsulation type for tunnel profile. The encapsulation type must be set to srv6 to configure SRv6 routes. VXLAN is not supported. SELECTION:
0 - none
1 - vxlan
2 - srv6
DEFAULT: none
profNameofm:profileName
(string:Basic)
Name of Tunnel Profile
MAX SIZE: 50


Related Documentation

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

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

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

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

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

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

Configuring a Segment List

Configuring a Segment List
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "segrtEntity": {
          "children": [
            {
              "srteTE": {
                "attributes": {
                  "adminSt": "enabled"
                },
                "children": [
                  {
                    "srtePolicy": {
                      "attributes": {
                        "color": "1",
                        "endpoint": "5::5",
                        "name": "blue"
                      },
                      "children": [
                        {
                          "srteExpCndPaths": {
                            "attributes": {
                              "adminSt": "enabled"
                            },
                            "children": [
                              {
                                "srtePolPref": {
                                  "attributes": {
                                    "pref": "100"
                                  },
                                  "children": [
                                    {
                                      "srtePolExp": {
                                        "attributes": {
                                          "name": "high-bandwidth",
                                          "weight": "1"
                                        }
                                      }
                                    }
                                  ]
                                }
                              },
                              {
                                "srtePolPref": {
                                  "attributes": {
                                    "pref": "200"
                                  },
                                  "children": [
                                    {
                                      "srtePolExp": {
                                        "attributes": {
                                          "name": "low-latency",
                                          "weight": "1"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "srteSegList": {
                      "attributes": {
                        "name": "high-bandwidth"
                      },
                      "children": [
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "4",
                              "sid": "cafe:0:e:500:1::"
                            }
                          }
                        },
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "3",
                              "sid": "cafe:0:f:600:1::"
                            }
                          }
                        },
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "2",
                              "sid": "cafe:0:d:400:1::"
                            }
                          }
                        },
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "1",
                              "sid": "cafe:0:c:300:1::"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "srteSegList": {
                      "attributes": {
                        "name": "low-latency"
                      },
                      "children": [
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "4",
                              "sid": "cafe:0:e:500:1::"
                            }
                          }
                        },
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "3",
                              "sid": "cafe:0:c:300:1::"
                            }
                          }
                        },
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "2",
                              "sid": "cafe:0:d:400:1::"
                            }
                          }
                        },
                        {
                          "srteNxtSid": {
                            "attributes": {
                              "idx": "1",
                              "sid": "cafe:0:b:200:1::"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "segrtInst": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <segrt-items>
    <te-items>
      <adminSt>enabled</adminSt>
      <policy-items>
        <Policy-list>
          <name>blue</name>
          <color>1</color>
          <endpoint>5::5</endpoint>
          <expcndpaths-items>
            <adminSt>enabled</adminSt>
            <pref-items>
              <PolPref-list>
                <pref>100</pref>
                <exp-items>
                  <PolExp-list>
                    <name>high-bandwidth</name>
                    <weight>1</weight>
                  </PolExp-list>
                </exp-items>
              </PolPref-list>
              <PolPref-list>
                <pref>200</pref>
                <exp-items>
                  <PolExp-list>
                    <name>low-latency</name>
                    <weight>1</weight>
                  </PolExp-list>
                </exp-items>
              </PolPref-list>
            </pref-items>
          </expcndpaths-items>
        </Policy-list>
      </policy-items>
      <seglist-items>
        <SegList-list>
          <name>high-bandwidth</name>
          <nxtsid-items>
            <NxtSid-list>
              <idx>4</idx>
              <sid>cafe:0:e:500:1::</sid>
            </NxtSid-list>
            <NxtSid-list>
              <idx>3</idx>
              <sid>cafe:0:f:600:1::</sid>
            </NxtSid-list>
            <NxtSid-list>
              <idx>2</idx>
              <sid>cafe:0:d:400:1::</sid>
            </NxtSid-list>
            <NxtSid-list>
              <idx>1</idx>
              <sid>cafe:0:c:300:1::</sid>
            </NxtSid-list>
          </nxtsid-items>
        </SegList-list>
        <SegList-list>
          <name>low-latency</name>
          <nxtsid-items>
            <NxtSid-list>
              <idx>4</idx>
              <sid>cafe:0:e:500:1::</sid>
            </NxtSid-list>
            <NxtSid-list>
              <idx>3</idx>
              <sid>cafe:0:c:300:1::</sid>
            </NxtSid-list>
            <NxtSid-list>
              <idx>2</idx>
              <sid>cafe:0:d:400:1::</sid>
            </NxtSid-list>
            <NxtSid-list>
              <idx>1</idx>
              <sid>cafe:0:b:200:1::</sid>
            </NxtSid-list>
          </nxtsid-items>
        </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(5).


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 low-latency
   index 1 segment-routing srv6 cafe:0:b:200:1::
   index 2 segment-routing srv6 cafe:0:d:400:1::
   index 3 segment-routing srv6 cafe:0:c:300:1::
   index 4 segment-routing srv6 cafe:0:e:500:1::
  segment-list name high-bandwidth
   index 1 segment-routing srv6 cafe:0:c:300:1::
   index 2 segment-routing srv6 cafe:0:d:400:1::
   index 3 segment-routing srv6 cafe:0:f:600:1::
   index 4 segment-routing srv6 cafe:0:e:500:1::
  policy blue
   color 1 endpoint 5::5
   candidate-paths
    preference 200
     explicit segment-list low-latency
    preference 100
     explicit segment-list high-bandwidth


Verifying a DME Configuration

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

MODN
topSystem sys
segrtEntity sys/segrt
srteTE sys/segrt/te
srtePolicy sys/segrt/te/policy-blue
srteExpCndPaths sys/segrt/te/policy-blue/expcndpaths
srtePolPref sys/segrt/te/policy-blue/expcndpaths/pref-100
srtePolExp sys/segrt/te/policy-blue/expcndpaths/pref-100/exp-high-bandwidth
srtePolPref sys/segrt/te/policy-blue/expcndpaths/pref-200
srtePolExp sys/segrt/te/policy-blue/expcndpaths/pref-200/exp-low-latency
srteSegList sys/segrt/te/seglist-high-bandwidth
srteNxtSid sys/segrt/te/seglist-high-bandwidth/nxtsid-4
srteNxtSid sys/segrt/te/seglist-high-bandwidth/nxtsid-3
srteNxtSid sys/segrt/te/seglist-high-bandwidth/nxtsid-2
srteNxtSid sys/segrt/te/seglist-high-bandwidth/nxtsid-1
srteSegList sys/segrt/te/seglist-low-latency
srteNxtSid sys/segrt/te/seglist-low-latency/nxtsid-4
srteNxtSid sys/segrt/te/seglist-low-latency/nxtsid-3
srteNxtSid sys/segrt/te/seglist-low-latency/nxtsid-2
srteNxtSid sys/segrt/te/seglist-low-latency/nxtsid-1
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 NameData TypeDescriptionValues
adminStnw: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 NameData TypeDescriptionValues
colorsrte:ColorVal
(scalar:Uint64)
Segment Routing TE Policy Color
RANGE: [0 , 4294967295]
DEFAULT: 0
endpointaddress:Ip
Segment Routing TE Endpoint IPv4/v6 addressValue must match the ipv6 known format
namesrte:Name
(string:Basic)
Segment Routing TE 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 NameData TypeDescriptionValues
adminStnw: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 NameData TypeDescriptionValues
prefsrte:OptNum
(scalar:Uint32)
The preference value for the group of explicit paths
RANGE: [1 , 65535]


srtePolExp Properties

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

Property NameData TypeDescriptionValues
namesrte:Name
(string:Basic)
Explicit path name. Must be the name of an existing ExpPath MO
Must be the name of an existing ExpPath MO
A sequence of characters


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 NameData TypeDescriptionValues
namesrte:Name
(string:Basic)
SRTE Explicit 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


srteNxtSid Properties

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

Property NameData TypeDescriptionValues
idxsrte:OptNum
(scalar:Uint32)
SRTE Segment List Next Label Index
RANGE: [1 , 65535]
sidaddress:Ip
SRTE Segment List Next SID ValueValue must match ipv6 known format


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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)
The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled


Related Documentation

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

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

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

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

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

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

Show IPv6 Route Detail

Show IPv6 Route Detail 
http://localhost:8003/api/node/mo/sys/u6rib/table6-default.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-context=1&batch-size=100&batch-id=1

{
    "totalCount": "1",
    "imdata": [
        {
            "uribTable6": {
                "attributes": {
                    "dn": "sys/u6rib/table6-[default]",
                    "modTs": "2020-05-01T11:18:28.643+00:00",
                    "routeCount": "7",
                    "vrfName": "default"
                },
                "children": [
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "fe80::/10",
                                "rn": "route6-[fe80::/10]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "0.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "sup-eth1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "local",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:34:13",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "2000::1/128",
                                "rn": "route6-[2000::1/128]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "2000::1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "local",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:05:43",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "::/127",
                                "rn": "route6-[::/127]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "0.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Null0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "discard",
                                            "preference": "220",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "discard",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:34:52",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "ff00::/8",
                                "rn": "route6-[ff00::/8]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "0.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Null0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "discard",
                                            "preference": "220",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "discard",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:34:52",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "1::1/128",
                                "rn": "route6-[1::1/128]",
                                "sortKey": "0",
                                "uBestNextHopCount": "2"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "1::1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "1",
                                            "interfaceName": "Lo0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "direct",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-1",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:12:08",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                },
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "1::1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Lo0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "local",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:12:08",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "2::2/128",
                                "rn": "route6-[2::2/128]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "2000::2",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "static",
                                            "preference": "1",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:05:43",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute6": {
                            "attributes": {
                                "flags": "0",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "2000::/64",
                                "rn": "route6-[2000::/64]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop6": {
                                        "attributes": {
                                            "address": "2000::1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "direct",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh6-0",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:05:43",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRecursiveNextHop6": {
                            "attributes": {
                                "mpathEpoch": "0",
                                "mpathResolvedClients": "",
                                "multipath": "no",
                                "owner": "static ",
                                "pendingCC": "no",
                                "pendingUfdm": "no",
                                "prefix": "2000::2/128",
                                "refCount": "1",
                                "restricted": "no",
                                "rn": "recursivenexthop6-[2000::2/128]",
                                "staleOwner": "",
                                "upathEpoch": "1",
                                "upathResolvedClients": "static ",
                                "uptime": "00:11:49"
                            },
                            "children": [
                                {
                                    "uribRecursiveNextHopPath6": {
                                        "attributes": {
                                            "address": "2000::2",
                                            "bindinglabel": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "labelStack": "",
                                            "labelType": "",
                                            "pathType": "upath",
                                            "rn": "rnhpath6-0",
                                            "segmentId": "0",
                                            "tunnelId": "0",
                                            "vrf": "",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "warning": {
                "attributes": {
                    "text": "backend rv=43700005, Dumped entries into ephemeral object store"
                }
            }
        }
    ]
}

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

CLI Output
switch# show ipv6 route detail 
IPv6 Routing Table for VRF "default"
'*' denotes best ucast next-hop
'**' denotes best mcast next-hop
'[x/y]' denotes [preference/metric]

ff00::/8, ubest/mbest: 1/0
       cand ubest/mbest: 1/0, ufdm in/update: 1/0
    *via Null0, [220/0], 00:33:43, discard, discard
0::/127, ubest/mbest: 1/0
       cand ubest/mbest: 1/0, ufdm in/update: 1/0
    *via Null0, [220/0], 00:33:43, discard, discard
fe80::/10, ubest/mbest: 1/0
       cand ubest/mbest: 1/0, ufdm in/update: 1/0
    *via sup-eth1, [0/0], 00:33:04, local
1::1/128, ubest/mbest: 2/0, attached
       cand ubest/mbest: 2/0, ufdm in/update: 1/0
    *via 1::1, Lo0, [0/0], 00:10:59, direct, 
    *via 1::1, Lo0, [0/0], 00:10:59, local
2::2/128, ubest/mbest: 1/0
       cand ubest/mbest: 1/0, ufdm in/update: 1/0
    *via 2000::2/128, [1/0], 00:04:34, static
         recursive next hop: 2000::2/128
2000::/64, ubest/mbest: 1/0, attached
       cand ubest/mbest: 1/0, ufdm in/update: 1/0
    *via 2000::1, Eth1/1, [0/0], 00:04:34, direct, 
2000::1/128, ubest/mbest: 1/0, attached
       cand ubest/mbest: 1/0, ufdm in/update: 1/0
    *via 2000::1, Eth1/1, [0/0], 00:04:34, local

Show IP Route Detail

Show IP Route Detail 
http://<IP_Address>/api/node/mo/sys/urib/table4-default.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-context=1&batch-size=100&batch-id=1

{
    "totalCount": "1",
    "imdata": [
        {
            "uribTable4": {
                "attributes": {
                    "dn": "sys/urib/table4-[default]",
                    "modTs": "2020-05-01T11:18:26.633+00:00",
                    "routeCount": "10",
                    "vrfName": "default"
                },
                "children": [
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "255.255.255.255/32",
                                "rn": "route4-[255.255.255.255/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "0.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "sup-eth1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "broadcast",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:29:14",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "10.0.0.255/32",
                                "rn": "route4-[10.0.0.255/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "10.0.0.255",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "broadcast",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:00:46",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "10.0.0.2/32",
                                "rn": "route4-[10.0.0.2/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "10.0.0.2",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "am",
                                            "preference": "250",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:00:39",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "10.0.0.1/32",
                                "rn": "route4-[10.0.0.1/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "10.0.0.1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "local",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:00:46",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "10.0.0.0/32",
                                "rn": "route4-[10.0.0.0/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "10.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Null0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "broadcast",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:00:46",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "0.0.0.0/32",
                                "rn": "route4-[0.0.0.0/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "0.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Null0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "broadcast",
                                            "preference": "220",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "discard",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:29:53",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "127.0.0.0/8",
                                "rn": "route4-[127.0.0.0/8]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "0.0.0.0",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Null0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "broadcast",
                                            "preference": "220",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "discard",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:29:53",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "1.1.1.1/32",
                                "rn": "route4-[1.1.1.1/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "2"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "1.1.1.1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "1",
                                            "interfaceName": "Lo0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "local",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-1",
                                            "routeType": "unknown",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:09:36",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                },
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "1.1.1.1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Lo0",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "direct",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:09:36",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "2.2.2.2/32",
                                "rn": "route4-[2.2.2.2/32]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "10.0.0.2",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "N/A",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "static",
                                            "preference": "1",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:00:39",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRoute4": {
                            "attributes": {
                                "flags": "65",
                                "mBestNextHopCount": "0",
                                "pendingHw": "no",
                                "pendingUfdm": "no",
                                "prefix": "10.0.0.0/24",
                                "rn": "route4-[10.0.0.0/24]",
                                "sortKey": "0",
                                "uBestNextHopCount": "1"
                            },
                            "children": [
                                {
                                    "uribNextHop4": {
                                        "attributes": {
                                            "address": "10.0.0.1",
                                            "bindinglabel": "0",
                                            "clientData": "No",
                                            "encapType": "none",
                                            "flags": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "isBest": "yes",
                                            "labelStack": "",
                                            "metric": "0",
                                            "nhlfeFlags": "0",
                                            "nhlfeOwner": "",
                                            "owner": "direct",
                                            "preference": "0",
                                            "recursiveNextHopPrefix": "0.0.0.0",
                                            "rn": "nh4-0",
                                            "routeType": "",
                                            "segidType": "null",
                                            "segmentId": "0",
                                            "sourceId": "0",
                                            "tag": "0",
                                            "tlv": "",
                                            "tlvAttachExport": "",
                                            "tlvExtentedCommunity": "",
                                            "tlvType": "0",
                                            "tunnelId": "0",
                                            "uptime": "00:00:46",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0",
                                            "xriBgpOrigin": "",
                                            "xriBgpPeer": ""
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "uribRecursiveNextHop4": {
                            "attributes": {
                                "mpathEpoch": "0",
                                "mpathResolvedClients": "",
                                "multipath": "no",
                                "owner": "static ",
                                "pendingCC": "no",
                                "pendingUfdm": "no",
                                "prefix": "10.0.0.2/32",
                                "refCount": "1",
                                "restricted": "no",
                                "rn": "recursivenexthop4-[10.0.0.2/32]",
                                "staleOwner": "",
                                "upathEpoch": "2",
                                "upathResolvedClients": "static ",
                                "uptime": "00:09:25"
                            },
                            "children": [
                                {
                                    "uribRecursiveNextHopPath4": {
                                        "attributes": {
                                            "address": "10.0.0.2",
                                            "bindinglabel": "0",
                                            "id": "0",
                                            "interfaceName": "Eth1/1",
                                            "labelStack": "",
                                            "labelType": "",
                                            "pathType": "upath",
                                            "rn": "rnhpath4-0",
                                            "segmentId": "0",
                                            "tunnelId": "0",
                                            "vrf": "default",
                                            "vtepIpAddress": "0.0.0.0",
                                            "vtepUnderlayVrfId": "0"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "warning": {
                "attributes": {
                    "text": "backend rv=43700005, Dumped entries into ephemeral object store"
                }
            }
        }
    ]
}

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

CLI Output
switch# show ip route detail 
IP Route Table for VRF "default"
'*' denotes best ucast next-hop
'**' denotes best mcast next-hop
'[x/y]' denotes [preference/metric]
'%' in via output denotes VRF 

0.0.0.0/32, ubest/mbest: 1/0
    *via Null0, [220/0], 00:30:09, broadcast, discard
127.0.0.0/8, ubest/mbest: 1/0
    *via Null0, [220/0], 00:30:09, broadcast, discard
255.255.255.255/32, ubest/mbest: 1/0
    *via sup-eth1, [0/0], 00:29:30, broadcast
1.1.1.1/32, ubest/mbest: 2/0, attached
    *via 1.1.1.1, Lo0, [0/0], 00:09:52, local
    *via 1.1.1.1, Lo0, [0/0], 00:09:52, direct
2.2.2.2/32, ubest/mbest: 1/0
    *via 10.0.0.2, [1/0], 00:00:55, static
         recursive next hop: 10.0.0.2/32
10.0.0.0/24, ubest/mbest: 1/0, attached
    *via 10.0.0.1, Eth1/1, [0/0], 00:01:02, direct
10.0.0.0/32, ubest/mbest: 1/0, attached
    *via 10.0.0.0, Null0, [0/0], 00:01:02, broadcast
10.0.0.1/32, ubest/mbest: 1/0, attached
    *via 10.0.0.1, Eth1/1, [0/0], 00:01:02, local
10.0.0.2/32, ubest/mbest: 1/0, attached
    *via 10.0.0.2, Eth1/1, [250/0], 00:00:55, am
10.0.0.255/32, ubest/mbest: 1/0, attached
    *via 10.0.0.255, Eth1/1, [0/0], 00:01:02, broadcast