Configuring OSPF

The Open Shortest Path First (OSPF) protocol is a link-state routing protocol used to exchange network reachability information within an autonomous system. Each OSPF router advertises information about its active links to its neighbor routers. Link information consists of the link type, the link metric, and the neighbor router that is connected to the link. The advertisements that contain this link information are called link-state advertisements.

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

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

This section contains payload examples to demonstrate how to use the NX-API REST API to configure OSPF on the Cisco Nexus 3000 and 9000 Series switches.

Disabling Segment Routing in an Area

Disabling Segment Routing in an Area
POST http://<mgmt0_IP>/api/mo/sys/ospf.json
{
  "ospfEntity": {
    "children": [
      {
        "ospfInst": {
          "attributes": {
            "name": "Test_1"
          },
          "children": [
            {
              "ospfDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "ospfArea": {
                      "attributes": {
                        "id": "0.0.48.57",
                        "sgmntRtgMpls": "disable"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>default</name>
            <area-items>
              <Area-list>
                <id>0.0.48.57</id>
                <sgmntRtgMpls>disable</sgmntRtgMpls>
              </Area-list>
            </area-items>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

router ospf Test_1
 area 12345 segment-routing disable

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


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

MODN
ospfEntity sys/ospf
ospfInst sys/ospf/inst-{name}
ospfDom sys/ospf/inst-{name}/dom-{name}
ospfArea sys/ospf/inst-{name}/dom-{name}/area-{id}


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfArea Properties

The following table contains information about the ospfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1
sgmntRtgMplsospf:SegRtControl
(scalar:Enum8)
Segment routing mpls controlSELECTION:
0 - unspecified
1 - mpls
2 - disable
DEFAULT: unspecified


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

Unconfiguring Disabled Segment Routing in an Area

Unconfiguring Disabled Segment Routing in an Area
POST http://<mgmt0_IP>/api/mo/sys/ospf.json
{
  "ospfEntity": {
    "children": [
      {
        "ospfInst": {
          "attributes": {
            "name": "Test_1"
          },
          "children": [
            {
              "ospfDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "ospfArea": {
                      "attributes": {
                        "id": "0.0.48.57",
                        "sgmntRtgMpls": "unspecified"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>default</name>
            <area-items>
              <Area-list>
                <id>0.0.48.57</id>
                <sgmntRtgMpls>unspecified</sgmntRtgMpls>
              </Area-list>
            </area-items>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

router ospf Test_1
 no area 12345 segment-routing disable

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


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

MODN
ospfEntity sys/ospf
ospfInst sys/ospf/inst-{name}
ospfDom sys/ospf/inst-{name}/dom-{name}
ospfArea sys/ospf/inst-{name}/dom-{name}/area-{id}


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfArea Properties

The following table contains information about the ospfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1
sgmntRtgMplsospf:SegRtControl
(scalar:Enum8)
Segment routing mpls controlSELECTION:
0 - unspecified
1 - mpls
2 - disable
DEFAULT: unspecified


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 Segment Routing MPLS in an Area

Enabling Segment Routing MPLS in an Area
POST http://<mgmt0_IP>/api/mo/sys/ospf.json
{
  "ospfEntity": {
    "children": [
      {
        "ospfInst": {
          "attributes": {
            "name": "Test_1"
          },
          "children": [
            {
              "ospfDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "ospfArea": {
                      "attributes": {
                        "id": "0.0.48.57",
                        "sgmntRtgMpls": "mpls"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>default</name>
            <area-items>
              <Area-list>
                <id>0.0.48.57</id>
                <sgmntRtgMpls>mpls</sgmntRtgMpls>
              </Area-list>
            </area-items>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

router ospf Test_1
 area 12345 segment-routing mpls

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


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

MODN
ospfEntity sys/ospf
ospfInst sys/ospf/inst-{name}
ospfDom sys/ospf/inst-{name}/dom-{name}
ospfArea sys/ospf/inst-{name}/dom-{name}/area-{id}


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfArea Properties

The following table contains information about the ospfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1
sgmntRtgMplsospf:SegRtControl
(scalar:Enum8)
Segment routing mpls controlSELECTION:
0 - unspecified
1 - mpls
2 - disable
DEFAULT: unspecified


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 Segment Routing MPLS in an Area

Disabling Segment Routing MPLS in an Area
POST http://<mgmt0_IP>/api/mo/sys/ospf.json
{
  "ospfEntity": {
    "children": [
      {
        "ospfInst": {
          "attributes": {
            "name": "Test_1"
          },
          "children": [
            {
              "ospfDom": {
                "attributes": {
                  "name": "default"
                },
                "children": [
                  {
                    "ospfArea": {
                      "attributes": {
                        "id": "0.0.48.57",
                        "sgmntRtgMpls": "unspecified"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>default</name>
            <area-items>
              <Area-list>
                <id>0.0.48.57</id>
                <sgmntRtgMpls>unspecified</sgmntRtgMpls>
              </Area-list>
            </area-items>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

router ospf Test_1
 no area 12345 segment-routing mpls

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


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

MODN
ospfEntity sys/ospf
ospfInst sys/ospf/inst-{name}
ospfDom sys/ospf/inst-{name}/dom-{name}
ospfArea sys/ospf/inst-{name}/dom-{name}/area-{id}


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfArea Properties

The following table contains information about the ospfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1
sgmntRtgMplsospf:SegRtControl
(scalar:Enum8)
Segment routing mpls controlSELECTION:
0 - unspecified
1 - mpls
2 - disable
DEFAULT: unspecified


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 Segment Routing MPLS

Enabling Segment Routing MPLS
POST http://<mgmt0_IP>/api/mo/sys/ospf.json
{
  "ospfEntity": {
    "children": [
      {
        "ospfInst": {
          "attributes": {
            "name": "Test_1"
          },
          "children": [
            {
              "ospfDom": {
                "attributes": {
                  "ctrl": "segrt",
                  "name": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>default</name>
            <ctrl>segrt</ctrl>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-items>
</System>

To configure segment routing under the OSPF process using REST or resconf, submit a GET request for the dom-default MO under the OSPF process instance. Check the value in the ctrl field of the response payload and apply the configurations given here so that the value of the ctrl field obtained in the GET is kept in addition to the segrt value that is getting applied.

For example, if the value for the ctrl field is empty, then the POST for configuring segment routing under the OSPF process should assign 'ctrl': 'segrt.' If the value for the ctrl field is bfd, then REST post for configuring segment-routing under process OSPF should assign 'ctrl':'segrt, bfd'


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.

router ospf Test_1
 segment-routing mpls

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


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

MODN
ospfEntity sys/ospf
ospfInst sys/ospf/inst-{name}
ospfDom sys/ospf/inst-{name}/dom-{name}


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
ctrlospf:DomControl
(scalar:Bitmask8)
Holds the controls bfd, name-lookup, default-passive and Segment RoutingSELECTION:
0 - unspecified
1 - bfd
2 - name-lookup
4 - default-passive
8 - segrt
DEFAULT: unspecified
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Disabling Segment Routing MPLS

Disabling Segment Routing MPLS
POST http://<mgmt0_IP>/api/mo/sys/ospf.json
{
  "ospfEntity": {
    "children": [
      {
        "ospfInst": {
          "attributes": {
            "name": "Test_1"
          },
          "children": [
            {
              "ospfDom": {
                "attributes": {
                  "ctrl": "",
                  "name": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>default</name>
            <ctrl></ctrl>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-items>
</System>

To remove segment routing under the OSPF process using REST or resconf, submit a GET request for the dom-default MO under the OSPF process instance. Check the value in the ctrl field of the response payload and apply the configurations given here so that the value of the ctrl field obtained from the GET request is kept and only the segrt value is removed.

For example, if the value of the ctrl field in the GET request is segrt, disable SR under the OSPF process by assigning an empty value in the REST POST (example: "ctrl": ""). If the value of the ctrl field in the GET request is segrt, bfd, disable SR under the OSPF process by removing segrt (example: "ctrl": "bfd").


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.

router ospf Test_1
 no segment-routing mpls

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


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

MODN
ospfEntity sys/ospf
ospfInst sys/ospf/inst-{name}
ospfDom sys/ospf/inst-{name}/dom-{name}


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
ctrlospf:DomControl
(scalar:Bitmask8)
Holds the controls bfd, name-lookup, default-passive and Segment RoutingSELECTION:
0 - unspecified
1 - bfd
2 - name-lookup
4 - default-passive
8 - segrt
DEFAULT: unspecified
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Enabling MPLS Traffic Engineering Capability for a Given Area

POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "children": [
                        {
                          "ospfMplsOspfArea": {
                            "attributes": {
                              "id": "1.2.3.4",
                              "teCap": "yes"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <mpls-items>
          <area-items>
            <MplsOspfArea-list>
              <id>1.2.3.4</id>
              <teCap>true</teCap>
            </MplsOspfArea-list>
          </area-items>
        </mpls-items>
        <dom-items>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf Test_1
  mpls traffic-eng area 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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-Test_1
ospfMpls sys/ospf/inst-Test_1/mpls
ospfMplsOspfArea sys/ospf/inst-Test_1/mpls/area-1.2.3.4
ospfDom sys/ospf/inst-Test_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfMplsOspfArea Properties

The following table contains information about the ospfMplsOspfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1
teCapscalar:Bool
MPLS TE capability flag per AreaSELECTION: true or false


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Disabling MPLS Traffic Engineering Capability for a Given Area

Disabling MPLS Traffic Engineering Capability for a Given Area
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "children": [
                        {
                          "ospfMplsOspfArea": {
                            "attributes": {
                              "id": "1.2.3.4",
                              "teCap": "no"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <mpls-items>
          <area-items>
            <MplsOspfArea-list>
              <id>1.2.3.4</id>
              <teCap>false</teCap>
            </MplsOspfArea-list>
          </area-items>
        </mpls-items>
        <dom-items>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf Test_1
  no mpls traffic-eng area 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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-Test_1
ospfMpls sys/ospf/inst-Test_1/mpls
ospfMplsOspfArea sys/ospf/inst-Test_1/mpls/area-1.2.3.4
ospfDom sys/ospf/inst-Test_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfMplsOspfArea Properties

The following table contains information about the ospfMplsOspfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1
teCapscalar:Bool
MPLS TE capability flag per AreaSELECTION: true or false


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring an MPLS TE Multicast

Configuring an MPLS TE Router ID
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "teMcast": "yes"
                      }
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <mpls-items>
          <teMcast>true</teMcast>
        </mpls-items>
        <dom-items>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf Test_1
  mpls traffic-eng multicast-intact


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-Test_1
ospfMpls sys/ospf/inst-Test_1/mpls
ospfDom sys/ospf/inst-Test_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfMpls Properties

The following table contains information about the ospfMpls properties in the DME 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
teMcastscalar:Bool
MPLS TE multicast support.SELECTION: true or false


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Deleting an MPLS TE Multicast

Deleting an MPLS TE Multicast
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "teMcast": "no"
                      }
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <mpls-items>
          <teMcast>false</teMcast>
        </mpls-items>
        <dom-items>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf Test_1
  no mpls traffic-eng multicast-intact


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-Test_1
ospfMpls sys/ospf/inst-Test_1/mpls
ospfDom sys/ospf/inst-Test_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfMpls Properties

The following table contains information about the ospfMpls properties in the DME 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
teMcastscalar:Bool
MPLS TE multicast support.SELECTION: true or false


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

[https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html](https://www.cisco.com/c/en/us/Router ID/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html)

Configuring MPLS TE Router ID

Configuring MPLS TE Router ID
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "teRtrId": "eth1/2"
                      }
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <mpls-items>
          <teRtrId>eth1/2</teRtrId>
        </mpls-items>
        <dom-items>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf Test_1
  mpls traffic-eng router-id ethernet 1/2


Verifying a DME Configuration

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

MODN
topSystem sys
ospfEntity sys/ospf
ospfInst sys/ospf/inst-Test_1
ospfMpls sys/ospf/inst-Test_1/mpls
ospfDom sys/ospf/inst-Test_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfMpls Properties

The following table contains information about the ospfMpls properties in the DME 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
teRtrIdnw:IfId
(base:IfIndex)
Routable Interface ID associated with MPLS TE. Supported interfaces include Ethernet-like, port/channel, loopback and vlan interfaces.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Deleting MPLS TE Router ID

Deleting MPLS TE Router ID
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "teRtrId": "unspecified"
                      }
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <mpls-items>
          <teRtrId>unspecified</teRtrId>
        </mpls-items>
        <dom-items>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf Test_1
  no mpls traffic-eng router-id ethernet 1/2


Verifying a DME Configuration

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

MODN
topSystem sys
ospfEntity sys/ospf
ospfInst sys/ospf/inst-Test_1
ospfMpls sys/ospf/inst-Test_1/mpls
ospfDom sys/ospf/inst-Test_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfMpls Properties

The following table contains information about the ospfMpls properties in the DME 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
teRtrIdnw:IfId
(base:IfIndex)
Routable Interface ID associated with MPLS TE. Supported interfaces include Ethernet-like, port/channel, loopback and vlan interfaces.Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring Sham-Link Properties
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "TEST_1"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST100"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSLink": {
                                  "attributes": {
                                    "cost": "65535",
                                    "deadIntvl": "65535",
                                    "demandCkt": "yes",
                                    "dstAddr": "200.200.200.200",
                                    "helloIntvl": "65535",
                                    "rexmitIntvl": "65535",
                                    "srcAddr": "100.100.100.100",
                                    "xmitDelay": "450"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "type": "simple"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>TEST_1</name>
        <dom-items>
          <Dom-list>
            <name>CUST100</name>
            <area-items>
              <Area-list>
                <id>0.0.3.232</id>
                <slink-items>
                  <SLink-list>
                    <srcAddr>100.100.100.100</srcAddr>
                    <dstAddr>200.200.200.200</dstAddr>
                    <cost>65535</cost>
                    <deadIntvl>65535</deadIntvl>
                    <demandCkt>true</demandCkt>
                    <helloIntvl>65535</helloIntvl>
                    <rexmitIntvl>65535</rexmitIntvl>
                    <xmitDelay>450</xmitDelay>
                    <authnew-items>
                      <type>simple</type>
                    </authnew-items>
                  </SLink-list>
                </slink-items>
              </Area-list>
            </area-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf TEST_1
  vrf CUST100
   area 0.0.3.232 sham-link 100.100.100.100 200.200.200.200
    authentication
     cost 65535
      demand-circuit
       dead-interval 65535
       hello-interval 65535
       retransmit-interval 65535
       transmit-delay 450


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-TEST_1
ospfDom sys/ospf/inst-TEST_1/dom-CUST100
ospfArea sys/ospf/inst-TEST_1/dom-CUST100/area-0.0.3.232
ospfSLink sys/ospf/inst-TEST_1/dom-CUST100/area-0.0.3.232/slink-s-100.100.100.100-d-200.200.200.200
ospfAuthNewP sys/ospf/inst-TEST_1/dom-CUST100/area-0.0.3.232/slink-s-100.100.100.100-d-200.200.200.200/authnew
ospfDom sys/ospf/inst-TEST_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfArea Properties

The following table contains information about the ospfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1


ospfSLink Properties

The following table contains information about the ospfSLink properties in the DME 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
costospf:IfCost
(scalar:Uint16)
Specifies the cost of interface
RANGE: [0 , 65535]
DEFAULT: unspecified
deadIntvlospf:DeadIntvl
(scalar:Uint16)
Dead interval, interval after which router declares that neighbor as down
RANGE: [0 , 65535]
DEFAULT: unspecified
demandCktscalar:Bool
Specifies whether a OSPF sham-link interface is a demand circuit or notSELECTION: true or false
dstAddraddress:IPv4
Sham-link destination IP addressValue must match ipv4 format
helloIntvlospf:HelloIntvl
(scalar:Uint16)
Hello interval, interval between hello packets that OSPF sends on the interface
RANGE: [1 , 65535]
DEFAULT: 10
rexmitIntvlospf:RexmitIntvl
(scalar:Uint16)
Retransmit interval, time between LSA retransmissions
RANGE: [1 , 65535]
DEFAULT: 5
srcAddraddress:IPv4
Sham-link source IP addressValue must match ipv4 format
xmitDelayospf:XmitDelay
(scalar:Uint16)
Transmit delay, estimated time needed to send an LSA update packet
RANGE: [1 , 450]
DEFAULT: 1


ospfAuthNewP Properties

The following table contains information about the ospfAuthNewP properties in the DME 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
typeospf:AuthT
(scalar:Enum8)
Authentication types can be simple, md5 or none.SELECTION:
0 - none
1 - simple
2 - md5
3 - unspecified
DEFAULT: unspecified


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Deleting the Sham-Link Properties
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "TEST_1"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST100"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSLink": {
                                  "attributes": {
                                    "cost": "65535",
                                    "deadIntvl": "unspecified",
                                    "demandCkt": "yes",
                                    "dstAddr": "200.200.200.200",
                                    "helloIntvl": "10",
                                    "rexmitIntvl": "5",
                                    "srcAddr": "100.100.100.100",
                                    "xmitDelay": "1"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "type": "simple"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>TEST_1</name>
        <dom-items>
          <Dom-list>
            <name>CUST100</name>
            <area-items>
              <Area-list>
                <id>0.0.3.232</id>
                <slink-items>
                  <SLink-list>
                    <srcAddr>100.100.100.100</srcAddr>
                    <dstAddr>200.200.200.200</dstAddr>
                    <cost>65535</cost>
                    <deadIntvl>0</deadIntvl>
                    <demandCkt>true</demandCkt>
                    <helloIntvl>10</helloIntvl>
                    <rexmitIntvl>5</rexmitIntvl>
                    <xmitDelay>1</xmitDelay>
                    <authnew-items>
                      <type>simple</type>
                    </authnew-items>
                  </SLink-list>
                </slink-items>
              </Area-list>
            </area-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf TEST_1
  vrf CUST100
   area 0.0.3.232 sham-link 100.100.100.100 200.200.200.200
    authentication
     cost 65535
      demand-circuit
       no dead-interval 65535
no hello-interval 65535
no retransmit-interval 65535
no transmit-delay 450


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-TEST_1
ospfDom sys/ospf/inst-TEST_1/dom-CUST100
ospfArea sys/ospf/inst-TEST_1/dom-CUST100/area-0.0.3.232
ospfSLink sys/ospf/inst-TEST_1/dom-CUST100/area-0.0.3.232/slink-s-100.100.100.100-d-200.200.200.200
ospfAuthNewP sys/ospf/inst-TEST_1/dom-CUST100/area-0.0.3.232/slink-s-100.100.100.100-d-200.200.200.200/authnew
ospfDom sys/ospf/inst-TEST_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfArea Properties

The following table contains information about the ospfArea properties in the DME 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
idospf:AreaId
(address:IPv4)
Area identifier to which a network or interface belongs
RANGE: [0 , 4294967295]
DEFAULT: 1


ospfSLink Properties

The following table contains information about the ospfSLink properties in the DME 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
costospf:IfCost
(scalar:Uint16)
Specifies the cost of interface
RANGE: [0 , 65535]
DEFAULT: unspecified
deadIntvlospf:DeadIntvl
(scalar:Uint16)
Dead interval, interval after which router declares that neighbor as down
RANGE: [0 , 65535]
DEFAULT: unspecified
demandCktscalar:Bool
Specifies whether a OSPF sham-link interface is a demand circuit or notSELECTION: true or false
dstAddraddress:IPv4
Sham-link destination IP addressValue must match ipv4 format
helloIntvlospf:HelloIntvl
(scalar:Uint16)
Hello interval, interval between hello packets that OSPF sends on the interface
RANGE: [1 , 65535]
DEFAULT: 10
rexmitIntvlospf:RexmitIntvl
(scalar:Uint16)
Retransmit interval, time between LSA retransmissions
RANGE: [1 , 65535]
DEFAULT: 5
srcAddraddress:IPv4
Sham-link source IP addressValue must match ipv4 format
xmitDelayospf:XmitDelay
(scalar:Uint16)
Transmit delay, estimated time needed to send an LSA update packet
RANGE: [1 , 450]
DEFAULT: 1


ospfAuthNewP Properties

The following table contains information about the ospfAuthNewP properties in the DME 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
typeospf:AuthT
(scalar:Enum8)
Authentication types can be simple, md5 or none.SELECTION:
0 - none
1 - simple
2 - md5
3 - unspecified
DEFAULT: unspecified


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuration of Authentication-key and Authentication key-chain under Sham Link
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "100"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST100"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSlinkNew": {
                                  "attributes": {
                                    "dstAddr": "200.200.200.200",
                                    "srcAddr": "100.100.100.100"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "key": "3 d61b092808270c7e",
                                          "keySecureMode": "yes",
                                          "keychain": "cisco"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{

}
<System>
     <ospf-items>
          <inst-items>
            <Inst-list>
              <name>100</name>
              <dom-items>
                <Dom-list>
                  <name>CUST100</name>
                  <area-items>
                    <Area-list>
                      <id>0.0.3.232 </id>
                      <slink-items>
                        <SLink-list>
                          <srcAddr>100.100.100.100 </srcAddr>
                          <dstAddr>200.200.200.200</dstAddr>
                          <authnew-items>
                            <key>3 d61b092808270c7e</key>
                            <keySecureMode>true</keySecureMode>
                            <keychain>cisco</keychain>
                          </authnew-items>
                        </SLink-list>
                      </slink-items>
                    </Area-list>
                  </area-items>
                </Dom-list>
              </dom-items>
            </Inst-list>
          </inst-items>
        </ospf-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.

router ospf 100
  vrf CUST100
   area 0.0.3.232 sham-link 100.100.100.100 200.200.200.200
    authentication key-chain cisco
     authentication-key 3 d61b092808270c7e
`

Deletion of Authentication-key and Authentication key-chain under Sham Link
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "100"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST100"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSlinkNew": {
                                  "attributes": {
                                    "dstAddr": "200.200.200.200",
                                    "srcAddr": "100.100.100.100"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "key": "",
                                          "keySecureMode": "no",
                                          "keychain": ""
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{

}
<System>
     <ospf-items>
          <inst-items>
            <Inst-list>
              <name>100</name>
              <dom-items>
                <Dom-list>
                  <name>CUST100</name>
                  <area-items>
                    <Area-list>
                      <id>0.0.3.232 </id>
                      <slink-items>
                        <SLink-list>
                          <srcAddr>100.100.100.100 </srcAddr>
                          <dstAddr>200.200.200.200</dstAddr>
                          <authnew-items xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="delete">
                            <key>3 d61b092808270c7e</key>
                            <keySecureMode>true</keySecureMode>
                            <keychain>cisco</keychain>
                          </authnew-items>
                        </SLink-list>
                      </slink-items>
                    </Area-list>
                  </area-items>
                </Dom-list>
              </dom-items>
            </Inst-list>
          </inst-items>
        </ospf-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.

router ospf 100
  vrf CUST100
   area 0.0.3.232 sham-link 100.100.100.100 200.200.200.200
    no authentication key-chain cisco
     no authentication-key 3 d61b092808270c7e

Configuration of Authentication md5 key-chain under Sham Link
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "101"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST104"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSlinkNew": {
                                  "attributes": {
                                    "dstAddr": "200.200.200.110",
                                    "srcAddr": "100.100.100.100"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "keyId": "255",
                                          "md5key": "3 d61b092808270c7e",
                                          "md5keySecureMode": "yes",
                                          "type": "md5"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{

}
<System>
     <ospf-items>
          <inst-items>
            <Inst-list>
              <name>100</name>
              <dom-items>
                <Dom-list>
                  <name>CUST100</name>
                  <area-items>
                    <Area-list>
                      <id>0.0.3.232 </id>
                      <slink-items>
                        <SLink-list>
                          <srcAddr>100.100.100.100 </srcAddr>
                          <dstAddr>200.200.200.200</dstAddr>
                          <authnew-items>
                            <keyId>255</keyId>
                            <md5key>3 d61b092808270c7e</md5key>
                            <md5keySecureMode>true</md5keySecureMode>
                          </authnew-items>
                        </SLink-list>
                      </slink-items>
                    </Area-list>
                  </area-items>
                </Dom-list>
              </dom-items>
            </Inst-list>
          </inst-items>
        </ospf-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.

router ospf 101
  vrf CUST104
   area 0.0.3.232 sham-link 100.100.100.100 200.200.200.110
    authentication message-digest
     message-digest-key 255 md5 3 d61b092808270c7e

Deletion of Authentication md5 key-chain under Sham Link
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "101"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST104"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSlinkNew": {
                                  "attributes": {
                                    "dstAddr": "200.200.200.110",
                                    "srcAddr": "100.100.100.100"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "keyId": "unspecified",
                                          "md5key": "",
                                          "md5keySecureMode": "no",
                                          "type": "unspecified"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{

}
<System>
      <ospf-items>
          <inst-items>
            <Inst-list>
              <name>100</name>
              <dom-items>
                <Dom-list>
                  <name>CUST100</name>
                  <area-items>
                    <Area-list>
                      <id>0.0.3.232 </id>
                      <slink-items>
                        <SLink-list>
                          <srcAddr>100.100.100.100 </srcAddr>
                          <dstAddr>200.200.200.200</dstAddr>
                          <authnew-items xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="delete">
                            <keyId>255</keyId>
                            <md5key>3 d61b092808270c7e</md5key>
                            <md5keySecureMode>true</md5keySecureMode>
                          </authnew-items>
                        </SLink-list>
                      </slink-items>
                    </Area-list>
                  </area-items>
                </Dom-list>
              </dom-items>
            </Inst-list>
          </inst-items>
        </ospf-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.

router ospf 101
  vrf CUST104
   area 0.0.3.232 sham-link 100.100.100.100 200.200.200.110
    no authentication message-digest
     no message-digest-key 255 md5 3 d61b092808270c7e

Enabling LDP IGP sync

Enabling LDP IGP sync
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "101"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST104"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSlinkNew": {
                                  "attributes": {
                                    "dstAddr": "200.200.200.110",
                                    "srcAddr": "100.100.100.100"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "keyId": "unspecified",
                                          "md5key": "",
                                          "md5keySecureMode": "no",
                                          "type": "unspecified"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "60"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "ldpSend": "yes",
                        "ldpSync": "yes"
                      },
                      "children": [
                        {
                          "ospfMplsOspfArea": {
                            "attributes": {
                              "id": "0.0.0.3",
                              "ldp": "yes"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{

}
<System>
      <ospf-items>
          <inst-items>
            <Inst-list>
              <name>60</name>
              <mpls-items>
                <ldpSync>true</ldpSync>
                <ldpSend>true</ldpSend>
                <area-items>
                  <MplsOspfArea-list>
                    <id>0.0.0.3</id>
                    <ldp>true</ldp>
                  </MplsOspfArea-list>
                </area-items>
              </mpls-items>
            </Inst-list>
          </inst-items>
        </ospf-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.

router ospf 60
  mpls ldp autoconfig area 0.0.0.3
   mpls ldp sync send

Deleting LDP IGP sync

Deleting LDP IGP sync
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "101"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST104"
                      },
                      "children": [
                        {
                          "ospfArea": {
                            "attributes": {
                              "id": "0.0.3.232"
                            },
                            "children": [
                              {
                                "ospfSlinkNew": {
                                  "attributes": {
                                    "dstAddr": "200.200.200.110",
                                    "srcAddr": "100.100.100.100"
                                  },
                                  "children": [
                                    {
                                      "ospfAuthNewP": {
                                        "attributes": {
                                          "keyId": "unspecified",
                                          "md5key": "",
                                          "md5keySecureMode": "no",
                                          "type": "unspecified"
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "60"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "ldpSend": "yes",
                        "ldpSync": "yes"
                      },
                      "children": [
                        {
                          "ospfMplsOspfArea": {
                            "attributes": {
                              "id": "0.0.0.3",
                              "ldp": "yes"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "60"
                },
                "children": [
                  {
                    "ospfMpls": {
                      "attributes": {
                        "ldpSend": "no",
                        "ldpSync": "no"
                      },
                      "children": [
                        {
                          "ospfMplsOspfArea": {
                            "attributes": {
                              "id": "0.0.0.3",
                              "ldp": "no"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{

}
<System>
      <ospf-items>
          <inst-items>
            <Inst-list>
              <name>60</name>
              <mpls-items xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" nc:operation="delete">
                <ldpSync>true</ldpSync>
                <ldpSend>true</ldpSend>
                <area-items>
                  <MplsOspfArea-list>
                    <id>0.0.0.3</id>
                    <ldp>true</ldp>
                  </MplsOspfArea-list>
                </area-items>
              </mpls-items>
            </Inst-list>
          </inst-items>
        </ospf-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.

router ospf 60
  no mpls ldp autoconfig area 0.0.0.3
   no mpls ldp sync send

Configuring a Domain Id and Domain Tag

Configuring a Domain Id and Domain Tag
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "TEST_1"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST1"
                      },
                      "children": [
                        {
                          "ospfL3vpnDomainSecondary": {
                            "attributes": {
                              "domainId": "20.20.20.40",
                              "domainType": "0000"
                            }
                          }
                        },
                        {
                          "ospfL3vpnDomainSecondary": {
                            "attributes": {
                              "domainId": "20.20.20.30",
                              "domainType": "0000"
                            }
                          }
                        },
                        {
                          "ospfL3vpnDomainSecondary": {
                            "attributes": {
                              "domainId": "20.20.20.20",
                              "domainType": "0000"
                            }
                          }
                        },
                        {
                          "ospfL3vpnDomainPrimary": {
                            "attributes": {
                              "domainId": "10.10.10.10",
                              "domainTag": "2147483647",
                              "domainType": "0000"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>TEST_1</name>
        <dom-items>
          <Dom-list>
            <name>CUST1</name>
            <l3vpndomainsec-items>
              <L3vpnDomainSecondary-list>
                <domainType>0000</domainType>
                <domainId>20.20.20.40</domainId>
              </L3vpnDomainSecondary-list>
              <L3vpnDomainSecondary-list>
                <domainType>0000</domainType>
                <domainId>20.20.20.30</domainId>
              </L3vpnDomainSecondary-list>
              <L3vpnDomainSecondary-list>
                <domainType>0000</domainType>
                <domainId>20.20.20.20</domainId>
              </L3vpnDomainSecondary-list>
            </l3vpndomainsec-items>
            <l3vpndomainpri-items>
              <domainId>10.10.10.10</domainId>
              <domainTag>2147483647</domainTag>
              <domainType>0000</domainType>
            </l3vpndomainpri-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf TEST_1
  vrf CUST1
   domain-id 10.10.10.10
    domain-id 20.20.20.20 secondary
     domain-id 20.20.20.30 secondary
      domain-id 20.20.20.40 secondary
       domain-tag 2147483647


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-TEST_1
ospfDom sys/ospf/inst-TEST_1/dom-CUST1
ospfL3vpnDomainSecondary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainsec-t-0000-i-20.20.20.40
ospfL3vpnDomainSecondary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainsec-t-0000-i-20.20.20.30
ospfL3vpnDomainSecondary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainsec-t-0000-i-20.20.20.20
ospfL3vpnDomainPrimary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainpri
ospfDom sys/ospf/inst-TEST_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfL3vpnDomainSecondary Properties

The following table contains information about the ospfL3vpnDomainSecondary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000


ospfL3vpnDomainSecondary Properties

The following table contains information about the ospfL3vpnDomainSecondary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000


ospfL3vpnDomainSecondary Properties

The following table contains information about the ospfL3vpnDomainSecondary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000


ospfL3vpnDomainPrimary Properties

The following table contains information about the ospfL3vpnDomainPrimary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTagospf:DomainTag
(scalar:Uint32)
L3VPN Domain Tag (AS number) in the range of 0-2147483647
RANGE: [0 , 2147483648]
DEFAULT: unspecified
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Deleting a Domain Id and Domain Tag

Deleting a Domain Id and Domain Tag
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "TEST_1"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST1"
                      },
                      "children": [
                        {
                          "ospfL3vpnDomainSecondary": {
                            "attributes": {
                              "domainId": "20.20.20.40",
                              "domainType": "0000",
                              "status": "deleted"
                            }
                          }
                        },
                        {
                          "ospfL3vpnDomainSecondary": {
                            "attributes": {
                              "domainId": "20.20.20.30",
                              "domainType": "0000",
                              "status": "deleted"
                            }
                          }
                        },
                        {
                          "ospfL3vpnDomainSecondary": {
                            "attributes": {
                              "domainId": "20.20.20.20",
                              "domainType": "0000",
                              "status": "deleted"
                            }
                          }
                        },
                        {
                          "ospfL3vpnDomainPrimary": {
                            "attributes": {
                              "domainTag": "unspecified"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>TEST_1</name>
        <dom-items>
          <Dom-list>
            <name>CUST1</name>
            <l3vpndomainsec-items>
              <L3vpnDomainSecondary-list nc:operation="delete">
                <domainType>0000</domainType>
                <domainId>20.20.20.40</domainId>
              </L3vpnDomainSecondary-list>
              <L3vpnDomainSecondary-list nc:operation="delete">
                <domainType>0000</domainType>
                <domainId>20.20.20.30</domainId>
              </L3vpnDomainSecondary-list>
              <L3vpnDomainSecondary-list nc:operation="delete">
                <domainType>0000</domainType>
                <domainId>20.20.20.20</domainId>
              </L3vpnDomainSecondary-list>
            </l3vpndomainsec-items>
            <l3vpndomainpri-items>
              <domainTag>2147483648</domainTag>
            </l3vpndomainpri-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf TEST_1
  vrf CUST1
   no domain-id 10.10.10.10
    no domain-id 20.20.20.20 secondary
     no domain-id 20.20.20.30 secondary
      no domain-id 20.20.20.40 secondary
       no domain-tag 2147483647


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-TEST_1
ospfDom sys/ospf/inst-TEST_1/dom-CUST1
ospfL3vpnDomainSecondary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainsec-t-0000-i-20.20.20.40
ospfL3vpnDomainSecondary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainsec-t-0000-i-20.20.20.30
ospfL3vpnDomainSecondary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainsec-t-0000-i-20.20.20.20
ospfL3vpnDomainPrimary sys/ospf/inst-TEST_1/dom-CUST1/l3vpndomainpri
ospfDom sys/ospf/inst-TEST_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfL3vpnDomainSecondary Properties

The following table contains information about the ospfL3vpnDomainSecondary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


ospfL3vpnDomainSecondary Properties

The following table contains information about the ospfL3vpnDomainSecondary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


ospfL3vpnDomainSecondary Properties

The following table contains information about the ospfL3vpnDomainSecondary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


ospfL3vpnDomainPrimary Properties

The following table contains information about the ospfL3vpnDomainPrimary properties in the DME 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
domainTagospf:DomainTag
(scalar:Uint32)
L3VPN Domain Tag (AS number) in the range of 0-2147483647
RANGE: [0 , 2147483648]
DEFAULT: unspecified


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Configuring a Domain Id Type

Configuring a Domain Id Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "TEST_1"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST4"
                      },
                      "children": [
                        {
                          "ospfL3vpnDomainPrimary": {
                            "attributes": {
                              "domainId": "000000000309",
                              "domainType": "0005"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>TEST_1</name>
        <dom-items>
          <Dom-list>
            <name>CUST4</name>
            <l3vpndomainpri-items>
              <domainId>000000000309</domainId>
              <domainType>0005</domainType>
            </l3vpndomainpri-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf TEST_1
  vrf CUST4
   domain-id type 0005 value 000000000309


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-TEST_1
ospfDom sys/ospf/inst-TEST_1/dom-CUST4
ospfL3vpnDomainPrimary sys/ospf/inst-TEST_1/dom-CUST4/l3vpndomainpri
ospfDom sys/ospf/inst-TEST_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfL3vpnDomainPrimary Properties

The following table contains information about the ospfL3vpnDomainPrimary properties in the DME 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
domainIdospf:DomainId
(string:Basic)
L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or NullA sequence of characters
domainTypeospf:DomainType
(scalar:Enum16)
L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005SELECTION:
0x0000 - 0000
0x0005 - 0005
0x0105 - 0105
0x0205 - 0205
0x8005 - 8005
DEFAULT: 0000


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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

Deleting a Domain Id Type

Deleting a Domain Id Type
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfEntity": {
          "children": [
            {
              "ospfInst": {
                "attributes": {
                  "name": "TEST_1"
                },
                "children": [
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "CUST4"
                      },
                      "children": [
                        {
                          "ospfL3vpnDomainPrimary": {
                            "attributes": {
                              "status": "deleted"
                            }
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfDom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ospf-items>
    <inst-items>
      <Inst-list>
        <name>TEST_1</name>
        <dom-items>
          <Dom-list>
            <name>CUST4</name>
            <l3vpndomainpri-items nc:operation="delete">
            </l3vpndomainpri-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospf-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.

router ospf TEST_1
  vrf CUST4
   no domain-id type 0005 value 000000000309


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
ospfEntity sys/ospf
ospfInst sys/ospf/inst-TEST_1
ospfDom sys/ospf/inst-TEST_1/dom-CUST4
ospfL3vpnDomainPrimary sys/ospf/inst-TEST_1/dom-CUST4/l3vpndomainpri
ospfDom sys/ospf/inst-TEST_1/dom-default


ospfInst Properties

The following table contains information about the ospfInst properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 128


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ospfL3vpnDomainPrimary Properties

The following table contains information about the ospfL3vpnDomainPrimary properties in the DME 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


ospfDom Properties

The following table contains information about the ospfDom properties in the DME 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
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


Related Documentation

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

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

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

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

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

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