Configuring Flow Exporters

Configuring a Flow Exporter

Configuring a Flow Exporter
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


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 Exporter

Deleting a Flow Exporter
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list xc:operation="delete">
              <name>Flow_Exprt_1</name>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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 Version 9 Export

Configuring Version 9 Export
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 the Exporter Stats Resend Time in Seconds

Configuring the Exporter Stats Resend Time in Seconds
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "statsTimeout": "123",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <statsTimeout>123</statsTimeout>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9
  option exporter-stats timeout 123

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
statsTimeoutnetflow:CollTimeout
(scalar:Uint32)
Collector stats timeout
RANGE: [0 , 86400]
DEFAULT: 0
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Exporter Stats Resend Time in Seconds

Deleting the Exporter Stats Resend Time in Seconds
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9
  no option exporter-stats timeout

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 the Interface Table Resend Time in Seconds

Configuring the Interface Table Resend Time in Seconds
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "interfaceTimeout": "123",
                  "name": "Flow_Exprt_1",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <interfaceTimeout>123</interfaceTimeout>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9
  option interface-table timeout 123

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
interfaceTimeoutnetflow:CollTimeout
(scalar:Uint32)
Collector interface table timeout
RANGE: [0 , 86400]
DEFAULT: 0
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Interface Table Resend Time in Seconds

Deleting the Interface Table Resend Time in Seconds
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9
  no option interface-table timeout

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 the Flow Exporter Template Data Timeout Period

Configuring the Flow Exporter Template Data Timeout Period
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "templateTimeout": "123",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <templateTimeout>123</templateTimeout>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9
  template data timeout 123

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
templateTimeoutnetflow:CollTemplateTimeout
(scalar:Uint32)
Collector template data timeout
RANGE: [1 , 86400]
DEFAULT: 15
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Flow Exporter Template Data Timeout Period

Deleting the Flow Exporter Template Data Timeout Period 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "ver": "v9",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <ver>v9</ver>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 version 9
  no template data timeout

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vernetflow:CollVersion
(scalar:Enum8)
Collector Version FormatSELECTION:
1 - v5
2 - v9
3 - cisco-v1
DEFAULT: v9
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Description

Configuring a Description
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "descr": "Some description text 123",
                  "name": "Flow_Exprt_1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <descr>Some description text 123</descr>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 description Some description text 123

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
descrnetflow:Descr
Collector Description
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Description

Deleting a Description 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 no description

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


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 IPv4 Export Destination

Configuring an IPv4 Export Destination
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "dstAddr": "1.2.3.4",
                  "name": "Flow_Exprt_1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <dstAddr>1.2.3.4</dstAddr>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 destination 1.2.3.4

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
dstAddrnetflow:addressIp
(address:Ip)
Remote Entity IPValue must match ipv4 or ipv6 known format
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 IPv6 Export Destination

Configuring an IPv6 Export Destination
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "dstAddr": "1:2::3:4",
                  "name": "Flow_Exprt_1",
                  "vrfName": "VRF_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <dstAddr>1:2::3:4</dstAddr>
              <vrfName>VRF_1</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 destination 1:2::3:4 use-vrf VRF_1

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
dstAddrnetflow:addressIp
(address:Ip)
Remote Entity IPValue must match ipv4 or ipv6 known format
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Export Destination

Deleting an Export Destination
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "dstAddr": "0.0.0.0",
                  "name": "Flow_Exprt_1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <dstAddr>0.0.0.0</dstAddr>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 no destination

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
dstAddrnetflow:addressIp
(address:Ip)
Remote Entity IPValue must match ipv4 or ipv6 known format
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 DSCP for Flow Exporter Datagrams

Configuring DSCP for Flow Exporter Datagrams
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "dscp": "2",
                  "name": "Flow_Exprt_1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <dscp>2</dscp>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 dscp 2

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
dscpnetflow:flowDscp
(qosp:DscpCP)
DSCP Value of Remote Entity
RANGE: [0 , 63]
DEFAULT: 0
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 DSCP for Flow Exporter Datagrams

Deleting DSCP for Flow Exporter Datagrams
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 no dscp

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


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 the Source Address for IGMPv3 Channel

Configuring the Source Address for IGMPv3 Channel 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1",
                  "srcIf": "eth1/2",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <srcIf>eth1/2</srcIf>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 source ethernet 1/2

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
srcIfnw:IfId
(base:IfIndex)
Source Interface of the senderMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 Source Address for IGMPv3 Channel

Deleting the Source Address for IGMPv3 Channel 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 no source

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


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 UDP as the Transport Protocol

Configuring UDP as the Transport Protocol
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "dstPort": "123",
                  "name": "Flow_Exprt_1",
                  "vrfName": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
              <dstPort>123</dstPort>
              <vrfName>default</vrfName>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 transport udp 123

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
dstPortnetflow:flowPort
(scalar:Uint16)
Remote Entity L4 Port
RANGE: [0 , 0xffff]
DEFAULT: 9995
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64
vrfNamenetflow:VrfName
(l3:VrfName)
Remote Entity VRF
DEFAULT: default


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 UDP as the Transport Protocol

Deleting UDP as the Transport Protocol 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowCollector": {
                "attributes": {
                  "name": "Flow_Exprt_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <collector-items>
            <Collector-list>
              <name>Flow_Exprt_1</name>
            </Collector-list>
          </collector-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

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 exporter Flow_Exprt_1
 no transport udp

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}
netflowCollector sys/hwtelemetry/netflow/inst-{mode}/collector-{[name]}


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


netflowCollector Properties

The following table contains information about the netflowCollector 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
namepol:ObjName
(naming:Name256)
Object name
MAX SIZE: 64


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