Executing Ping NVE, Traceroute NVE, and Path Trace NVE

An oDN must be created before executing ping NVE, traceroute NVE, or path trace NVE.

Creating an oDn

Creating an oDn

POST http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json

{
 "actionLSubj": {
    "attributes": {
        "oDn": ""
   }
}

This example demonstrates how to create an oDn to enable executing ping NVE, traceroute NVE, or path trace NVE.

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
actionLSubj sys/action/lsubj-{[oDn]}


actionLSubj Properties

The following table contains information about the actionLSubj 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
oDnreference:BinRef
Target Object's Subject DN


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

Executing Ping NVE

Executing Ping NVE

POST http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json


{
  "ngoamPingNve": {
    "attributes": {
            "session": "12.0.22.1-2"
            "dstIp": "12.0.22.1"
            "vni": "31000"
            "profileId": "1"
            "adminSt": "1"
            "count": "10000"
        }
    }
}

The following NGOAM commands are the executable commands; these actions will start once POST request is issued. Results for these executable commands are stored as children objects and can be retrieved by a GET request. To start an executable command, a POST must be issued with these mandatory fields:

  • session - A character string to identify the unique execution.
  • adminSt - Set to 1 to activate the session and specify one of the destination fields such as dstIp, dstIpv6, and dstMAC.

The rest of the fields are optional and need to be specified for a given use case. Different session names create a different instance of the objects with result objects as children. If any other property is changed, it creates new exec request in the backend and results are appended to the the same exec object.

Note: The POST fields are optional. See the GET request for all available fields.


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

ping nve ip 12.0.22.1 profile 1 vni 31000 count 10000

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
ngoamPingNve sys/action/lsubj-{[oDn]}/pingnve-{session}


ngoamPingNve Properties

The following table contains information about the ngoamPingNve 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
sessionstring:Basic
sessionA sequence of characters
dstIpaddress:IPv4
Destination Node IDValue must match ipv4 format
vningoam:Vnid
(scalar:Uint32)		VNI
RANGE: [1 , 16777215]
profileIdngoam:ProfId
(scalar:Uint16)		Ngoam profile ID
RANGE: [1 , 1023]
adminStaction:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
0 - unknown
1 - start
2 - stop
3 - suspend
DEFAULT: unknown
countngoam:NumPkt
(scalar:Uint16)		Number of packets
RANGE: [1 , 0xffff]
DEFAULT: 5


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 the Ping NVE

Querying the Ping NVE

GET http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json?rsp-subtree=full

{
    "ngoamPingNveRslt": {
                    "attributes": {
                      "ack": "no",
                      "avgRtt": "4",
                      "descr": "",
                      "endTs": "never",
                      "errorCode": "",
                      "failReason": "",
                      "maxRtt": "4",
                      "minRtt": "4",
                      "notSentPkts": "0",
                      "operSt": "scheduled",
                      "packetSz": "46",
                      "peerClassId": "unspecified",
                      "qual": "",
                      "rSz": "0",
                      "rTm": "00:00:00:00.000",
                      "rcvdPkts": "1",
                      "replyIp": "12.0.22.1",
                      "replyIpv6": "",
                      "rn": "pingnverslt-[8]",
                      "sPort": "54123",
                      "sentPkts": "1",
                      "sessionId": "8",
                      "startTs": "never",
                      "totalRtt": "5",
                      "type": "0"
}

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


ngoamPingNveRslt Properties

The following table contains information about the ngoamPingNveRslt 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
ackscalar:Bool
The acknowledgement status of the fault. If a fault is acknowledged and cleared, it is immediately deleted. If a fault is not acknowledged and cleared, it is deleted after the retention interval.SELECTION: true or false
avgRttngoam:Rtt
(scalar:Uint32)		Average Round Trip TimeRANGE: [0, 4294967295]
descraction:Descr
(naming:Descr)		Description
RANGE: [0 , 128]
endTsmo:TStamp
(scalar:Date)		The date and time when the task ended.SELECTION:
0 - never
DEFAULT: never
errorCodestring:CharBuffer
Error Code String
failReasonstring:CharBuffer
Failure Reason
maxRttngoam:Rtt
(scalar:Uint32)		Maximum Round Trip TimeRANGE: [0, 4294967295]
minRttngoam:Rtt
(scalar:Uint32)		Minimum Round Trip TimeRANGE: [0, 4294967295]
notSentPktsngoam:Counter
(scalar:Uint32)		Not Sent PacketsRANGE: [0, 4294967295]
operStaction:OperSt
(scalar:Enum8)		The runtime state of the object or policy.SELECTION:
0 - scheduled
1 - processing
2 - completed
3 - cancelled
4 - failed
5 - indeterminate
6 - suspended
7 - crashsuspect
DEFAULT: scheduled
packetSzngoam:PktSz
(scalar:Uint16)		Packet Size
RANGE: [1 , 9500]
DEFAULT: 56
peerClassIdmo:MoClassId
The BGP neighbor.DEFAULT: unspecified
qualaction:Qual
(string:Basic)		The qualifier for the component status.A sequence of characters
rSzaction:RetentionSize
(scalar:Uint16)		The retention size of the task results.
RANGE: [1 , 1024]
DEFAULT: 100
rTmaction:RetentionTime
(scalar:Time)		The retention time of the task results.TIME FORMAT: %H:%M:%S 54:05:07:26.000
rcvdPktsngoam:Counter
(scalar:Uint32)		Received PacketsRANGE: [0, 4294967295]
replyIpaddress:IPv4
IPv4 AddressValue must match ipv4 format
replyIpv6address:IPv6
IPv6 AddressValue must match ipv6 format
rn
reference:BinRN		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
sPortngoam:SrcPort
(scalar:Uint16)		VxLAN outer UDP Source Port -- Will be deprecated. Please use verbose
RANGE: [0 , 0xffff]
DEFAULT: 0
sentPktsngoam:Counter
(scalar:Uint32)		Sent PacketsRANGE: [0, 4294967295]
sessionIdngoam:SessionId
(scalar:Uint16)		Name
RANGE: [0 , 0xffff]
startTsmo:TStamp
(scalar:Date)		The date and time when the task began.SELECTION:
0 - never
DEFAULT: never
totalRttngoam:Rtt
(scalar:Uint32)		Total Round Trip TimeRANGE: [0, 4294967295]
typeaction:Type
(scalar:Enum8)		The specific type of the object or component.SELECTION:
1 - clear
2 - reset
3 - reload
4 - locate
5 - install
6 - test
7 - collect
8 - interface-in-service
DEFAULT: clear


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

Executing Traceroute NVE

Executing Traceroute NVE

POST http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json


{
  "ngoamTraceRtNve": {
    "attributes": {
            "session": "33.33.33.2-2"
            "dstIp": "33.33.33.2"
            "srcIp": "33.33.33.3"
            "vrf": "vni-31000"
            "adminSt": "1"
        }
    }
}

The POST fields are optional. See the GET request for all available fields.


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

traceroute nve ip 33.33.33.2 vrf vni-31000 src 33.33.33.3

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
ngoamTraceRtNve sys/action/lsubj-{[oDn]}/tracertnve-{session}


ngoamTraceRtNve Properties

The following table contains information about the ngoamTraceRtNve 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
sessionstring:Basic
sessionA sequence of characters
dstIpaddress:IPv4
Destination Node IDValue must match ipv4 format
srcIpaddress:IPv4
Source IPValue must match ipv4 format
vrfngoam:Vrf
(l3:VrfName)		VRF
adminStaction:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
0 - unknown
1 - start
2 - stop
3 - suspend
DEFAULT: unknown


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 the Traceroute NVE

Querying the Traceroute NVE

GET http://<mgmt0_IP>//api/node/mo/sys/action/lsubj-[].json?rsp-subtree=full

{
    "ngoamTraceRtNveRslt": {
                        "attributes": {
                          "ack": "no",
                          "descr": "",
                          "dstIp": "12.0.22.1",
                          "dstIpv6": "",
                          "endTs": "never",
                          "errorCode": "",
                          "failReason": "",
                          "maxHops": "3",
                          "operSt": "scheduled",
                          "peerClassId": "unspecified",
                          "qual": "",
                          "rSz": "0",
                          "rTm": "00:00:00:00.000",
                          "rn": "trnverslt-[4]",
                          "sessionId": "4",
                          "startTs": "never",
                          "type": "0"
    },
    "children": [
    {
    "ngoamPathTr": {
      "attributes": {
        "id": "1",
        "rn": "pathtr-1"
    },
    "children": [
    { "ngoamNodeTr": {
        "attributes": {
          "addr": "55.55.55.2",
            "elapsedTime": "00:00:00:00.006",                                                  
            "order": "1",
          "rn": "nodetr-1",
          "v6addr": "::"
    }}},{
      "ngoamNodeTr": {
        "attributes": {
          "addr": "33.33.33.2",
          "elapsedTime": "00:00:00:00.002",
          "order": "3",
          "rn": "nodetr-3",
          "v6addr": "::"
    }}},{
      "ngoamNodeTr": {
        "attributes": {
          "addr": "12.0.22.1",
          "elapsedTime": "00:00:00:00.002",
          "order": "2",
          "rn": "nodetr-2",
          "v6addr": "::"
}}}]

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


ngoamTraceRtNveRslt Properties

The following table contains information about the ngoamTraceRtNveRslt 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
ackscalar:Bool
The acknowledgement status of the fault. If a fault is acknowledged and cleared, it is immediately deleted. If a fault is not acknowledged and cleared, it is deleted after the retention interval.SELECTION: true or false
descraction:Descr
(naming:Descr)		Description
RANGE: [0 , 128]
dstIpaddress:IPv4
Destination Node IDValue must match ipv4 format
dstIpv6
address:IPv6		Destination Ipv6 addr
endTsmo:TStamp
(scalar:Date)		The date and time when the task ended.SELECTION:
0 - never
DEFAULT: never
errorCodestring:CharBuffer
Error Code String
failReasonstring:CharBuffer
Failure Reason
maxHopsngoam:Hops
(scalar:UByte)		Max Hops
RANGE: [1 , 255]
DEFAULT: 32
operStaction:OperSt
(scalar:Enum8)		The runtime state of the object or policy.SELECTION:
0 - scheduled
1 - processing
2 - completed
3 - cancelled
4 - failed
5 - indeterminate
6 - suspended
7 - crashsuspect
DEFAULT: scheduled
peerClassIdmo:MoClassId
The BGP neighbor.DEFAULT: unspecified
qualaction:Qual
(string:Basic)		The qualifier for the component status.A sequence of characters
rSzaction:RetentionSize
(scalar:Uint16)		The retention size of the task results.
RANGE: [1 , 1024]
DEFAULT: 100
rTmaction:RetentionTime
(scalar:Time)		The retention time of the task results.TIME FORMAT: %H:%M:%S 54:05:07:26.000
rn
reference:BinRN		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
sessionIdngoam:SessionId
(scalar:Uint16)		Name
RANGE: [0 , 0xffff]
startTsmo:TStamp
(scalar:Date)		The date and time when the task began.SELECTION:
0 - never
DEFAULT: never
typeaction:Type
(scalar:Enum8)		The specific type of the object or component.SELECTION:
1 - clear
2 - reset
3 - reload
4 - locate
5 - install
6 - test
7 - collect
8 - interface-in-service
DEFAULT: clear


ngoamPathTr Properties

The following table contains information about the ngoamPathTr 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
idngoam:PathId
(scalar:UByte)		IDRANGE: [0, 255]
rn
reference:BinRN		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


ngoamNodeTr Properties

The following table contains information about the ngoamNodeTr 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
addraddress:IPv4
IPv4 AddressValue must match ipv4 format
elapsedTimescalar:Time
Elapsed TimeTIME FORMAT: %H:%M:%S 54:05:07:26.000
orderngoam:Order
(scalar:UByte)		OrderRANGE: [0, 255]
rn
reference:BinRN		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
v6addraddress:IPv6
IPv6 AddressValue must match ipv6 format


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

Executing Path Trace NVE

Executing Path Trace NVE

POST http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json

{
     "ngoamPathTraceNve": {
         "attributes": {
             "session": "12.0.22.1-3"
             "dstIp": "12.0.22.1"
             "vni": "31000"
             "reqStats": "yes"
             "adminSt": "1"
         }
     }
}

The POST fields are optional. See the GET request for all available fields.


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

pathtrace nve ip 12.0.22.1 vni 31000 req-stats

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
ngoamPathTraceNve sys/action/lsubj-{[oDn]}/pathtracenve-{session}


ngoamPathTraceNve Properties

The following table contains information about the ngoamPathTraceNve 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
sessionstring:Basic
sessionA sequence of characters
dstIpaddress:IPv4
Destination Node IDValue must match ipv4 format
vningoam:Vnid
(scalar:Uint32)		VNI
RANGE: [1 , 16777215]
reqStatsscalar:Bool
Request StatsSELECTION: true or false
adminStaction:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
0 - unknown
1 - start
2 - stop
3 - suspend
DEFAULT: unknown


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 the Path Trace NVE

Querying the Path Trace NVE

GET http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json?rsp-subtree=full

{
 "ngoamPathTraceNveRslt": {
            "attributes": {
              "ack": "no",
              "descr": "",
              "dstIp": "12.0.22.1",
              "dstIpv6": "",
              "endTs": "never",
              "errorCode": "",
              "failReason": "",
              "maxHops": "2",
              "operSt": "scheduled",
              "peerClassId": "unspecified",
              "qual": "",
              "rSz": "0",
              "rTm": "00:00:00:00.000",
              "rn": "ptrnverslt-[6]",
              "sessionId": "6",
              "startTs": "never",
              "type": "0"
            },
    "children": [
    {
    "ngoamPathPtr": {
      "attributes": {
        "id": "1",
        "rn": "pathptr-1"
    }, "children": [
    {
      "ngoamNodePtr": {
        "attributes": {
         "addr": "55.55.55.2",
           "ngoamPathTraceNveRslt": {
            "attributes": {
              "ack": "no",
              "descr": "",
              "dstIp": "12.0.22.1",
              "dstIpv6": "",
              "endTs": "never",
              "errorCode": "",
              "failReason": "",
              "maxHops": "2",
              "operSt": "scheduled",
              "peerClassId": "unspecified",
              "qual": "",
              "rSz": "0",
              "rTm": "00:00:00:00.000",
              "rn": "ptrnverslt-[6]",
              "sessionId": "6",
              "startTs": "never",
              "type": "0"
    },
    "children": [
    {
    "ngoamPathPtr": {
      "attributes": {
        "id": "1",
        "rn": "pathptr-1"
    }, "children": [
        {
          "ngoamNodePtr": {
            "attributes": {
             "addr": "55.55.55.2",
             "egressIf": "Eth5/7/3",
              "egressIfState": "UP",
              "elapsedTime": "00:00:00:00.013",
              "ingressIf": "Eth5/7/1",
              "ingressIfState": "UP",
              "order": "1",
              "rn": "nodeptr-1",
              "rxBandwidth": "10000000",
              "rxBcast": "11",
              "rxByteRate": "0",
              "rxBytes": "26696076",
              "rxDiscards": "0",
              "rxErrors": "1",
              "rxLen": "84",
              "rxLoad": "0",
              "rxMcast": "24222",
              "rxPktRate": "0",
              "rxUcast": "384",
              "rxUnknown": "0",
              "txBandwidth": "10000000",
              "txBcast": "9",
              "txByteRate": "0",
              "txBytes": "26731567",
              "txDiscards": "0",
              "txErrors": "18",
              "txLen": "84",
              "txLoad": "0",
              "txMcast": "24179",
              "txPktRate": "0",
              "txUcast": "940",
              "v6addr": "::” 
}

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


ngoamPathTraceNveRslt Properties

The following table contains information about the ngoamPathTraceNveRslt 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
ackscalar:Bool
The acknowledgement status of the fault. If a fault is acknowledged and cleared, it is immediately deleted. If a fault is not acknowledged and cleared, it is deleted after the retention interval.SELECTION: true or false
descraction:Descr
(naming:Descr)		Description
RANGE: [0 , 128]
dstIpaddress:IPv4
Destination Node IDValue must match ipv4 format
dstIpv6
address:IPv6		Destination Ipv6 addr
endTsmo:TStamp
(scalar:Date)		The date and time when the task ended.SELECTION:
0 - never
DEFAULT: never
errorCodestring:CharBuffer
Error Code String
failReasonstring:CharBuffer
Failure Reason
maxHopsngoam:Hops
(scalar:UByte)		Max Hops
RANGE: [1 , 255]
DEFAULT: 32
operStaction:OperSt
(scalar:Enum8)		The runtime state of the object or policy.SELECTION:
0 - scheduled
1 - processing
2 - completed
3 - cancelled
4 - failed
5 - indeterminate
6 - suspended
7 - crashsuspect
DEFAULT: scheduled
peerClassIdmo:MoClassId
The BGP neighbor.DEFAULT: unspecified
qualaction:Qual
(string:Basic)		The qualifier for the component status.A sequence of characters
rSzaction:RetentionSize
(scalar:Uint16)		The retention size of the task results.
RANGE: [1 , 1024]
DEFAULT: 100
rTmaction:RetentionTime
(scalar:Time)		The retention time of the task results.TIME FORMAT: %H:%M:%S 54:05:07:26.000
rn
reference:BinRN		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
sessionIdngoam:SessionId
(scalar:Uint16)		Name
RANGE: [0 , 0xffff]
startTsmo:TStamp
(scalar:Date)		The date and time when the task began.SELECTION:
0 - never
DEFAULT: never
typeaction:Type
(scalar:Enum8)		The specific type of the object or component.SELECTION:
1 - clear
2 - reset
3 - reload
4 - locate
5 - install
6 - test
7 - collect
8 - interface-in-service
DEFAULT: clear


ngoamPathPtr Properties

The following table contains information about the ngoamPathPtr 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
idngoam:PathId
(scalar:UByte)		IDRANGE: [0, 255]
rn
reference:BinRN		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.


ngoamNodePtr Properties

The following table contains information about the ngoamNodePtr 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
addraddress:IPv4
IPv4 AddressValue must match ipv4 format


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

Clearing a Session

Clearing a Session

DELETE http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json

Issue a DELETE oDn request to clear sessions created using the REST API.

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