Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Configuring a Flow Timeout
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json

{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow",
            "timeOut": "20"
          }
        }
      }
    ]
  }
}

Response
{
    imdata:[]
}

Copy
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <timeOut>20</timeOut>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Configuring Flow Timeout

Configuring a Flow Timeout

Configuring a Flow Timeout

Note: This example was added in Release 9.2(2).


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.

flow timeout 20

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
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)		It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow
timeOutnetflow:FlowTimeout
(scalar:Uint32)		Flow timeout
RANGE: [5 , 60]
DEFAULT: 10


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 Flow Timeout Configuration

Deleting a Flow Timeout Configuration

Note: This example was added in Release 9.2(2).


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.

no flow timeout 20

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
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)		It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow
timeOutnetflow:FlowTimeout
(scalar:Uint32)		Flow timeout
RANGE: [5 , 60]
DEFAULT: 10


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