Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Disabling Segment Routing in an Area

DME

YANG

Copy
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"
}}}]}}]}}]}}
Response
{
    imdata:[]
}

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

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

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.

MO	DN
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 Name	Data Type	Description	Values
name	naming: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 Name	Data Type	Description	Values
name	naming: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 Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1
sgmntRtgMpls	ospf:SegRtControl (scalar:Enum8)	Segment routing mpls control	SELECTION: 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

CLI Commands

router ospf Test_1
no area 12345 segment-routing disable

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

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

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

ospfDom Properties

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

ospfArea Properties

Property Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1
sgmntRtgMpls	ospf:SegRtControl (scalar:Enum8)	Segment routing mpls control	SELECTION: 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

CLI Commands

router ospf Test_1
area 12345 segment-routing mpls

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

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

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

ospfDom Properties

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

ospfArea Properties

Property Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1
sgmntRtgMpls	ospf:SegRtControl (scalar:Enum8)	Segment routing mpls control	SELECTION: 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

CLI Commands

router ospf Test_1
no area 12345 segment-routing mpls

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

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

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

ospfDom Properties

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

ospfArea Properties

Property Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1
sgmntRtgMpls	ospf:SegRtControl (scalar:Enum8)	Segment routing mpls control	SELECTION: 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

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

router ospf Test_1
segment-routing mpls

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

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

ospfInst Properties

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

ospfDom Properties

Property Name	Data Type	Description	Values
ctrl	ospf:DomControl (scalar:Bitmask8)	Holds the controls bfd, name-lookup, default-passive and Segment Routing	SELECTION: 0 - unspecified 1 - bfd 2 - name-lookup 4 - default-passive 8 - segrt DEFAULT: unspecified
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

Related Documentation

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

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

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

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

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

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

Disabling Segment Routing MPLS

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

router ospf Test_1
no segment-routing mpls

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

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

ospfInst Properties

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

ospfDom Properties

Property Name	Data Type	Description	Values
ctrl	ospf:DomControl (scalar:Bitmask8)	Holds the controls bfd, name-lookup, default-passive and Segment Routing	SELECTION: 0 - unspecified 1 - bfd 2 - name-lookup 4 - default-passive 8 - segrt DEFAULT: unspecified
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

Related Documentation

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

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

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

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

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

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

Enabling MPLS Traffic Engineering Capability for a Given Area

Code section - 7

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

CLI Commands

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.

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

Property Name	Data Type	Description	Values
name	naming: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 Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1
teCap	scalar:Bool	MPLS TE capability flag per Area	SELECTION: true or false

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Disabling MPLS Traffic Engineering Capability for a Given Area

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

CLI Commands

router ospf Test_1
no mpls traffic-eng area 1.2.3.4

Verifying a DME Configuration

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

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

ospfMplsOspfArea Properties

Property Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1
teCap	scalar:Bool	MPLS TE capability flag per Area	SELECTION: true or false

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Configuring an MPLS TE Multicast

Configuring an MPLS TE Router ID

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

CLI Commands

router ospf Test_1
mpls traffic-eng multicast-intact

Verifying a DME Configuration

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

Property Name	Data Type	Description	Values
name	naming: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 Name	Data Type	Description	Values
teMcast	scalar:Bool	MPLS TE multicast support.	SELECTION: true or false

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Deleting an MPLS TE Multicast

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

CLI Commands

router ospf Test_1
no mpls traffic-eng multicast-intact

Verifying a DME Configuration

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

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

ospfMpls Properties

Property Name	Data Type	Description	Values
teMcast	scalar:Bool	MPLS TE multicast support.	SELECTION: true or false

ospfDom Properties

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

Related Documentation

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

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

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

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

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

[https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html](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

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

CLI Commands

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

Verifying a DME Configuration

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

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

ospfMpls Properties

Property Name	Data Type	Description	Values
teRtrId	nw: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

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

Related Documentation

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

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

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

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

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

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

Deleting MPLS TE Router ID

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

CLI Commands

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

Verifying a DME Configuration

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

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

ospfMpls Properties

Property Name	Data Type	Description	Values
teRtrId	nw: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

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

Related Documentation

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

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

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

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

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

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

Configuring Sham-Link Properties

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

CLI Commands

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

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

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

ospfDom Properties

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

ospfArea Properties

Property Name	Data Type	Description	Values
id	ospf: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 Name	Data Type	Description	Values
cost	ospf:IfCost (scalar:Uint16)	Specifies the cost of interface	RANGE: [0 , 65535] DEFAULT: unspecified
deadIntvl	ospf:DeadIntvl (scalar:Uint16)	Dead interval, interval after which router declares that neighbor as down	RANGE: [0 , 65535] DEFAULT: unspecified
demandCkt	scalar:Bool	Specifies whether a OSPF sham-link interface is a demand circuit or not	SELECTION: true or false
dstAddr	address:IPv4	Sham-link destination IP address	Value must match ipv4 format
helloIntvl	ospf:HelloIntvl (scalar:Uint16)	Hello interval, interval between hello packets that OSPF sends on the interface	RANGE: [1 , 65535] DEFAULT: 10
rexmitIntvl	ospf:RexmitIntvl (scalar:Uint16)	Retransmit interval, time between LSA retransmissions	RANGE: [1 , 65535] DEFAULT: 5
srcAddr	address:IPv4	Sham-link source IP address	Value must match ipv4 format
xmitDelay	ospf: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 Name	Data Type	Description	Values
type	ospf:AuthT (scalar:Enum8)	Authentication types can be simple, md5 or none.	SELECTION: 0 - none 1 - simple 2 - md5 3 - unspecified DEFAULT: unspecified

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Deleting the Sham-Link Properties

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

CLI Commands

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

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

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

ospfDom Properties

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

ospfArea Properties

Property Name	Data Type	Description	Values
id	ospf:AreaId (address:IPv4)	Area identifier to which a network or interface belongs	RANGE: [0 , 4294967295] DEFAULT: 1

ospfSLink Properties

Property Name	Data Type	Description	Values
cost	ospf:IfCost (scalar:Uint16)	Specifies the cost of interface	RANGE: [0 , 65535] DEFAULT: unspecified
deadIntvl	ospf:DeadIntvl (scalar:Uint16)	Dead interval, interval after which router declares that neighbor as down	RANGE: [0 , 65535] DEFAULT: unspecified
demandCkt	scalar:Bool	Specifies whether a OSPF sham-link interface is a demand circuit or not	SELECTION: true or false
dstAddr	address:IPv4	Sham-link destination IP address	Value must match ipv4 format
helloIntvl	ospf:HelloIntvl (scalar:Uint16)	Hello interval, interval between hello packets that OSPF sends on the interface	RANGE: [1 , 65535] DEFAULT: 10
rexmitIntvl	ospf:RexmitIntvl (scalar:Uint16)	Retransmit interval, time between LSA retransmissions	RANGE: [1 , 65535] DEFAULT: 5
srcAddr	address:IPv4	Sham-link source IP address	Value must match ipv4 format
xmitDelay	ospf:XmitDelay (scalar:Uint16)	Transmit delay, estimated time needed to send an LSA update packet	RANGE: [1 , 450] DEFAULT: 1

ospfAuthNewP Properties

Property Name	Data Type	Description	Values
type	ospf:AuthT (scalar:Enum8)	Authentication types can be simple, md5 or none.	SELECTION: 0 - none 1 - simple 2 - md5 3 - unspecified DEFAULT: unspecified

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Configuration of Authentication-key and Authentication key-chain under Sham Link

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

CLI Commands

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

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

CLI Commands

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

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

CLI Commands

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

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

CLI Commands

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

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

CLI Commands

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

Deleting LDP IGP sync

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

CLI Commands

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

Configuring a Domain Id and Domain Tag

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

CLI Commands

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

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

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

ospfDom Properties

Property Name	Data Type	Description	Values
name	naming: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 Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000

ospfL3vpnDomainSecondary Properties

Property Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000

ospfL3vpnDomainSecondary Properties

Property Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 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 Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainTag	ospf:DomainTag (scalar:Uint32)	L3VPN Domain Tag (AS number) in the range of 0-2147483647	RANGE: [0 , 2147483648] DEFAULT: unspecified
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Deleting a Domain Id and Domain Tag

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

CLI Commands

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

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

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

ospfDom Properties

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

ospfL3vpnDomainSecondary Properties

Property Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

ospfL3vpnDomainSecondary Properties

Property Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

ospfL3vpnDomainSecondary Properties

Property Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

ospfL3vpnDomainPrimary Properties

Property Name	Data Type	Description	Values
domainTag	ospf:DomainTag (scalar:Uint32)	L3VPN Domain Tag (AS number) in the range of 0-2147483647	RANGE: [0 , 2147483648] DEFAULT: unspecified

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Configuring a Domain Id Type

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

CLI Commands

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

Verifying a DME Configuration

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

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

ospfDom Properties

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

ospfL3vpnDomainPrimary Properties

Property Name	Data Type	Description	Values
domainId	ospf:DomainId (string:Basic)	L3VPN Domain Identifier which can be ipv4 addr or 12 Hex Char or Null	A sequence of characters
domainType	ospf:DomainType (scalar:Enum16)	L3VPN Domain Type 0x0005/0x0105/0x0205/0x8005	SELECTION: 0x0000 - 0000 0x0005 - 0005 0x0105 - 0105 0x0205 - 0205 0x8005 - 8005 DEFAULT: 0000

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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

Deleting a Domain Id Type

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

CLI Commands

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

Verifying a DME Configuration

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

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

ospfDom Properties

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

ospfL3vpnDomainPrimary Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

ospfDom Properties

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

Related Documentation

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

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

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

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

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

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