Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Querying IS-IS Adjacency
YANG
Copy
http://ip/api/mo/sys/isis/inst-200/dom-default/oper.json?rsp-subtree=full
{
  "totalCount": "1",
  "imdata": [
    {
      "isisOperIsis": {
        "attributes": {
          "dn": "sys/isis/inst-200/dom-default/oper",
          "modTs": "2020-03-10T19:59:27.058+00:00"
        },
        "children": [
          {
            "isisAdj": {
              "attributes": {
                "modTs": "2020-03-10T19:59:27.058+00:00",
                "rn": "adj"
              },
              "children": [
                {
                  "isisLevel": {
                    "attributes": {
                      "cktType": "l2",
                      "modTs": "2020-03-10T19:59:27.107+00:00",
                      "rn": "level-[l2]"
                    },
                    "children": [
                      {
                        "isisAdjIf": {
                          "attributes": {
                            "cktId": "",
                            "holdTimer": "00:00:30",
                            "id": "eth1/35",
                            "level": "l12",
                            "modTs": "2020-03-12T11:18:17.436+00:00",
                            "operSt": "up",
                            "peerIpv4": "",
                            "peerIpv6": "",
                            "priority": "0",
                            "rn": "adjif-[eth1/35]",
                            "snpa": "N/A",
                            "sysName": "n9k-5"
                          }
                        }
                      }
                    ]
                  }
                },
                {
                  "isisLevel": {
                    "attributes": {
                      "cktType": "l1",
                      "modTs": "2020-03-10T19:59:27.058+00:00",
                      "rn": "level-[l1]"
                    },
                    "children": [
                      {
                        "isisAdjIf": {
                          "attributes": {
                            "cktId": "",
                            "holdTimer": "00:00:30",
                            "id": "eth1/35",
                            "level": "l12",
                            "modTs": "2020-03-12T11:18:17.436+00:00",
                            "operSt": "up",
                            "peerIpv4": "",
                            "peerIpv6": "",
                            "priority": "0",
                            "rn": "adjif-[eth1/35]",
                            "snpa": "N/A",
                            "sysName": "n9k-5"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

Querying IS-IS Configurations

Querying IS-IS Adjacency

Querying IS-IS Adjacency

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

CLI Output
Switch# show isis adjacency
IS-IS process: 200 VRF: default
IS-IS adjacency database:
Legend: '!': No AF level connectivity in given topology
System ID SNPA Level State Hold Time Interface
n9k-3 N/A 1 UP 00:00:30 Ethernet1/17.1
n9k-5 N/A 2 UP 00:00:26 Ethernet1/35

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


isisOperIsis Properties

The following table contains information about the isisOperIsis properties in the DME 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
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never


isisAdj Properties

The following table contains information about the isisAdj properties in the DME 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
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never


isisLevel Properties

The following table contains information about the isisLevel properties in the DME 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
cktTypeisis:IsT
(scalar:Enum8)		LevelSELECTION:
1 - l1
2 - l2
3 - l12
DEFAULT: l12
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never


isisAdjIf Properties

The following table contains information about the isisAdjIf properties in the DME 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
cktIdstring:Basic
Circuit TypeA sequence of characters
holdTimerstring:Basic
Hold Timer timestampA sequence of characters
idbase:IfIndex
Adjacency interface nameMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
levelisis:IsT
(scalar:Enum8)		Level TypeSELECTION:
1 - l1
2 - l2
3 - l12
DEFAULT: l12
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never
operStisis:AdjOperSt
(scalar:Enum8)		Operational State for adjacencySELECTION:
0 - up
1 - init
2 - down
3 - 3waystate
4 - lost
5 - delete
6 - maxState
peerIpv4string:Basic
Adjacency peer IP addressA sequence of characters
peerIpv6string:Basic
Adjacency peer IPv6 AddressA sequence of characters
priorityscalar:Uint32
Priority valueRANGE: [0, 4294967295]
snpastring:Basic
SNPA holderA sequence of characters
sysNamestring:Basic
System name of the neighborA sequence of characters


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

Querying IS-IS Adjacency Ethernet Interfaces

Querying IS-IS Adjacency Ethernet Interfaces

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

CLI Output
Switch# show isis adjacency ethernet 1/17
IS-IS process: 200 VRF: urib_test
IS-IS adjacency database for Ethernet1/17:
Legend: '!': No AF level connectivity in given topology
System ID SNPA Level State Hold Time Interface
n9k-3 N/A 1-2 UP 00:00:22 Ethernet1/17

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


isisAdjIf Properties

The following table contains information about the isisAdjIf properties in the DME 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
cktIdstring:Basic
Circuit TypeA sequence of characters
holdTimerstring:Basic
Hold Timer timestampA sequence of characters
idbase:IfIndex
Adjacency interface nameMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
levelisis:IsT
(scalar:Enum8)		Level TypeSELECTION:
1 - l1
2 - l2
3 - l12
DEFAULT: l12
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never
operStisis:AdjOperSt
(scalar:Enum8)		Operational State for adjacencySELECTION:
0 - up
1 - init
2 - down
3 - 3waystate
4 - lost
5 - delete
6 - maxState
peerIpv4string:Basic
Adjacency peer IP addressA sequence of characters
peerIpv6string:Basic
Adjacency peer IPv6 AddressA sequence of characters
priorityscalar:Uint32
Priority valueRANGE: [0, 4294967295]
snpastring:Basic
SNPA holderA sequence of characters
sysNamestring:Basic
System name of the neighborA sequence of characters


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

Querying IS-IS Adjacency VRF

Querying IS-IS Adjacency VRF

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

CLI Output
Switch# show isis adjacency vrf urib_test
IS-IS process: 200 VRF: urib_test
IS-IS adjacency database:
Legend: '!': No AF level connectivity in given topology
System ID SNPA Level State Hold Time Interface
n9k-3 N/A 1-2 UP 00:00:27 Ethernet1/17

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


isisOperIsis Properties

The following table contains information about the isisOperIsis properties in the DME 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
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never


isisAdj Properties

The following table contains information about the isisAdj properties in the DME 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
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never


isisLevel Properties

The following table contains information about the isisLevel properties in the DME 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
cktTypeisis:IsT
(scalar:Enum8)		LevelSELECTION:
1 - l1
2 - l2
3 - l12
DEFAULT: l12
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never


isisAdjIf Properties

The following table contains information about the isisAdjIf properties in the DME 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
cktIdstring:Basic
Circuit TypeA sequence of characters
holdTimerstring:Basic
Hold Timer timestampA sequence of characters
idbase:IfIndex
Adjacency interface nameMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
levelisis:IsT
(scalar:Enum8)		Level TypeSELECTION:
1 - l1
2 - l2
3 - l12
DEFAULT: l12
modTsmo:TStamp
(scalar:Date)		The time when this object was last modified.SELECTION:
0 - never
DEFAULT: never
operStisis:AdjOperSt
(scalar:Enum8)		Operational State for adjacencySELECTION:
0 - up
1 - init
2 - down
3 - 3waystate
4 - lost
5 - delete
6 - maxState
peerIpv4string:Basic
Adjacency peer IP addressA sequence of characters
peerIpv6string:Basic
Adjacency peer IPv6 AddressA sequence of characters
priorityscalar:Uint32
Priority valueRANGE: [0, 4294967295]
snpastring:Basic
SNPA holderA sequence of characters
sysNamestring:Basic
System name of the neighborA sequence of characters


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

Next