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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Routing Update Supression on the Interface

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfv3Entity": {
          "children": [
            {
              "ospfv3If": {
                "attributes": {
                  "advSecondary": "yes",
                  "area": "0.0.0.0",
                  "id": "eth1/2",
                  "instance": "201",
                  "nwT": "bcast",
                  "passive": "enabled"
                }
              }
            }
          ]
        }
      },
      {
        "ipv6Entity": {
          "children": [
            {
              "ipv6Inst": {
                "children": [
                  {
                    "ipv6Dom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "ipv6If": {
                            "attributes": {
                              "id": "eth1/2"
                            },
                            "children": [
                              {
                                "ipv6Addr": {
                                  "attributes": {
                                    "addr": "1:2::3:4/24",
                                    "aggregatePrefixLength": "unspecified",
                                    "pref": "0",
                                    "tag": "0"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <ospfv3-items>
    <if-items>
      <If-list>
        <id>eth1/2</id>
        <advSecondary>true</advSecondary>
        <area>0.0.0.0</area>
        <instance>201</instance>
        <nwT>bcast</nwT>
        <passive>enabled</passive>
      </If-list>
    </if-items>
  </ospfv3-items>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/2</id>
              <addr-items>
                <Addr-list>
                  <addr>1:2::3:4/24</addr>
                  <aggregatePrefixLength>0</aggregatePrefixLength>
                  <pref>0</pref>
                  <tag>0</tag>
                </Addr-list>
              </addr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring OSPFv3 Broadcast Network Type

Configuring Routing Update Supression on the Interface

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

CLI Commands

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

interface ethernet 1/2
ipv6 address 1:2::3:4/24
  ipv6 router ospfv3 201 area 0
  ospfv3 network broadcast
  ospfv3 passive-interface

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
ipv6Addr	sys/ipv6/inst/dom-default/if-[eth1/2]/addr-[1:2::3:4/24]
ipv6Dom	sys/ipv6/inst/dom-default
ipv6If	sys/ipv6/inst/dom-default/if-[eth1/2]
l1PhysIf	sys/intf/phys-[eth1/2]
ospfv3If	sys/ospfv3/if-[eth1/2]

ipv6Addr Properties

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

Property Name	Data Type	Description	Values
addr	address:Ip	Address	Value must match ipv4 or ipv6 known format
aggregatePrefixLength	scalar:Uint16	Prefix-Length for AM Route Aggregation	RANGE: [0 , 127]
pref	ip:Preference (scalar:UByte)	Preference	RANGE: [0 , 255] DEFAULT: 0
tag	rt:Tag (scalar:Uint32)	Route Tag	RANGE: [0 , 0xffffffff] DEFAULT: 0

ipv6Dom Properties

The following table contains information about the ipv6Dom properties in the DME payload. For more information about 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.	RANGE: Min: "1" Max: "128"

ipv6If Properties

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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ospfv3If Properties

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

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20
nwT	ospfv3:NwT (scalar:Enum8)	Network Type, can be Point-to-point or Broadcast	SELECTION: 0 - none 1 - p2p 2 - bcast DEFAULT: none
passive	ospfv3:PassiveControl (scalar:Enum8)	Suppress routing updates on the interface	SELECTION: 0 - none 1 - enabled 2 - disabled DEFAULT: none

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 Routing Update Supression on the Interface

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

CLI Commands

interface ethernet 1/2
ipv6 address 1:2::3:4/24
  ipv6 router ospfv3 201 area 0
  ospfv3 network broadcast
  no ospfv3 passive-interface

MO	DN
ipv6Addr	sys/ipv6/inst/dom-default/if-[eth1/2]/addr-[1:2::3:4/24]
ipv6Dom	sys/ipv6/inst/dom-default
ipv6If	sys/ipv6/inst/dom-default/if-[eth1/2]
l1PhysIf	sys/intf/phys-[eth1/2]
ospfv3If	sys/ospfv3/if-[eth1/2]

ipv6Addr Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Address	Value must match ipv4 or ipv6 known format
aggregatePrefixLength	scalar:Uint16	Prefix-Length for AM Route Aggregation	RANGE: [0 , 127]
pref	ip:Preference (scalar:UByte)	Preference	RANGE: [0 , 255] DEFAULT: 0
tag	rt:Tag (scalar:Uint32)	Route Tag	RANGE: [0 , 0xffffffff] DEFAULT: 0

ipv6Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "1" Max: "128"

ipv6If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20
nwT	ospfv3:NwT (scalar:Enum8)	Network Type, can be Point-to-point or Broadcast	SELECTION: 0 - none 1 - p2p 2 - bcast DEFAULT: none
passive	ospfv3:PassiveControl (scalar:Enum8)	Suppress routing updates on the interface	SELECTION: 0 - none 1 - enabled 2 - disabled DEFAULT: none

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 OSPF Point-to-Point Network

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

CLI Commands

interface ethernet 1/2
ipv6 address 1:2::3:4/24
  ipv6 router ospfv3 201 area 0
  ospfv3 network broadcast
  ospfv3 network point-to-point

MO	DN
ipv6Addr	sys/ipv6/inst/dom-default/if-[eth1/2]/addr-[1:2::3:4/24]
ipv6Dom	sys/ipv6/inst/dom-default
ipv6If	sys/ipv6/inst/dom-default/if-[eth1/2]
l1PhysIf	sys/intf/phys-[eth1/2]
ospfv3If	sys/ospfv3/if-[eth1/2]

ipv6Addr Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Address	Value must match ipv4 or ipv6 known format
aggregatePrefixLength	scalar:Uint16	Prefix-Length for AM Route Aggregation	RANGE: [0 , 127]
pref	ip:Preference (scalar:UByte)	Preference	RANGE: [0 , 255] DEFAULT: 0
tag	rt:Tag (scalar:Uint32)	Route Tag	RANGE: [0 , 0xffffffff] DEFAULT: 0

ipv6Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "1" Max: "128"

ipv6If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20
nwT	ospfv3:NwT (scalar:Enum8)	Network Type, can be Point-to-point or Broadcast	SELECTION: 0 - none 1 - p2p 2 - bcast DEFAULT: none

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 OSPF Point-to-Point Network

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

CLI Commands

interface ethernet 1/2
ipv6 address 1:2::3:4/24
  ipv6 router ospfv3 201 area 0
  ospfv3 network broadcast
  no ospfv3 network point-to-point

MO	DN
ipv6Addr	sys/ipv6/inst/dom-default/if-[eth1/2]/addr-[1:2::3:4/24]
ipv6Dom	sys/ipv6/inst/dom-default
ipv6If	sys/ipv6/inst/dom-default/if-[eth1/2]
l1PhysIf	sys/intf/phys-[eth1/2]
ospfv3If	sys/ospfv3/if-[eth1/2]

ipv6Addr Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Address	Value must match ipv4 or ipv6 known format
aggregatePrefixLength	scalar:Uint16	Prefix-Length for AM Route Aggregation	RANGE: [0 , 127]
pref	ip:Preference (scalar:UByte)	Preference	RANGE: [0 , 255] DEFAULT: 0
tag	rt:Tag (scalar:Uint32)	Route Tag	RANGE: [0 , 0xffffffff] DEFAULT: 0

ipv6Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "1" Max: "128"

ipv6If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20
nwT	ospfv3:NwT (scalar:Enum8)	Network Type, can be Point-to-point or Broadcast	SELECTION: 0 - none 1 - p2p 2 - bcast DEFAULT: none

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