Configuring Flow Records

Configuring a Flow Record

Configuring a Flow Record
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "name": "record_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>record_1</name>
            </RecordP-list>
          </recordp-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 record record_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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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 Record

Deleting a Flow Record
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "name": "record_1",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list xc:operation="delete">
              <name>record_1</name>
            </RecordP-list>
          </recordp-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 record record_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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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 the Number of Bytes in a Flow as a Non-Key Field for a Flow Record

Configuring the Number of Bytes in a Flow as a Non-Key Field for a Flow Record
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "count-bytes",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect>count-bytes</collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 collect counter bytes

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 the Number of Bytes in a Flow as a Non-Key Field for a Flow Record

Deleting the Number of Bytes in a Flow as a Non-Key Field for a Flow Record
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect></collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no collect counter bytes

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 Number of Packets Using a 64-bit Counter

Configuring the Number of Packets Using a 64-bit Counter
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "count-pkts-long",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect>count-pkts-long</collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 collect counter packets long

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 the Number of Packets Using a 64-bit Counter

Deleting the Number of Packets Using a 64-bit Counter
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect></collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no collect counter packets long

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 Value in the IPv4 Version Field

Configuring the Value in the IPv4 Version Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "ip-version",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect>ip-version</collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 collect ip version

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 the Value in the IPv4 Version Field

Deleting the Value in the IPv4 Version Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect></collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no collect ip version

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 System Uptime of the First Seen Packet

Configuring the System Uptime of the First Seen Packet
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "ts-first",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect>ts-first</collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 collect timestamp sys-uptime first

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 the System Uptime of the First Seen Packet

Deleting the System Uptime of the First Seen Packet
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect></collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no collect timestamp sys-uptime first

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 System Uptime of the Last Seen Packet

Configuring the System Uptime of the Last Seen Packet 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "ts-recent",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect>ts-recent</collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 collect timestamp sys-uptime last

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 the System Uptime of the Last Seen Packet

Deleting the System Uptime of the Last Seen Packet 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect></collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no collect timestamp sys-uptime last

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 TCP Fields as a Non-Key Field

Configuring TCP Fields as a Non-Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "tcp-flags",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect>tcp-flags</collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 collect transport tcp flags

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 TCP Fields as a Non-Key Field

Deleting TCP Fields as a Non-Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "collect": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <collect></collect>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no collect transport tcp flags

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
collectnetflow:CollectParams
(scalar:Bitmask64)
The collect parameters of the netflow recordSELECTION:
1 - count-bytes
2 - count-pkts
4 - sampler-id
8 - pkt-disp
16 - ts-first
32 - ts-recent
64 - tcp-flags
128 - ip-version
256 - src-intf
512 - count-bytes-long
1024 - count-pkts-long
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 MAC Address as a Key Field

Configuring the Source MAC Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "src-mac",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>src-mac</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match datalink mac source-address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the Source MAC Address as a Key Field

Deleting the Source MAC Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match datalink mac source-address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 Destination MAC Address as a Key Field

Configuring the Destination MAC Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "dst-mac",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>dst-mac</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match datalink mac destination-address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the Destination MAC Address as a Key Field

Deleting the Destination MAC Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match datalink mac destination-address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 Ethertype as a key Field

Configuring the Ethertype as a key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "ethertype",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>ethertype</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match datalink ethertype

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the Ethertype as a Key Field

Deleting the Ethertype as a key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match datalink ethertype

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 VLAN ID as a Key Field

Configuring the VLAN ID as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "vlan",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>vlan</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match datalink vlan

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the VLAN ID as a Key Field

Deleting the VLAN ID as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match datalink vlan

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv4 Protocol as a Key Field

Configuring the IPv4 Protocol as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "proto",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>proto</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ip protocol

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv4 Protocol as a Key Field

Deleting the IPv4 Protocol as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ip protocol

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv4 ToS as a Key Field

Configuring the IPv4 ToS as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "tos",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>tos</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ip tos

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv4 ToS as a Key Field

Deleting the IPv4 ToS as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ip tos

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv4 Source Address as Key Field

Configuring the IPv4 Source Address as Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "src-ipv4",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>src-ipv4</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ipv4 source address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv4 Source Address as Key Field

Deleting the IPv4 Source Address as Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ipv4 source address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv4 Destination Address as a Key Field

Configuring the IPv4 Destination Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "dst-ipv4",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>dst-ipv4</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ipv4 destination address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv4 Destination Address as a Key Field

Deleting the IPv4 Destination Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ipv4 destination address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv6 Source Address as a Key Field

Configuring the IPv6 Source Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "src-ipv6",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>src-ipv6</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ipv6 source address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv6 Source Address as a Key Field

Deleting the IPv6 Source Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ipv6 source address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv6 Destination Address as a Key Field

Configuring the IPv6 Destination Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "dst-ipv6",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>dst-ipv6</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ipv6 destination address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv6 Destination Address as a Key Field

Deleting the IPv6 Destination Address as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ipv6 destination address

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv6 Flow Label as a Key Field

Configuring the IPv6 Flow Label as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ipv6 flow-label

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the IPv6 flow label as a Key Field

Deleting the IPv6 flow label as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ipv6 flow-label

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv6 Options as a Key Field

Configuring IPv6 Options as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "opt-ipv6",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>opt-ipv6</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match ipv6 options

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 IPv6 Options as a Key Field

Deleting IPv6 Options as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match ipv6 options

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 Transport Destination Port as a Key Field

Configuring the Transport Destination Port as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "dst-port",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>dst-port</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match transport destination-port

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the Transport Destination Port as a Key Field

Deleting the Transport Destination Port as a Key Field
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match transport destination-port

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 Transport Source Port as a Key Field

Configuring the Transport Source Port as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "src-port",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match>src-port</match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 match transport source-port

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 the Transport Source Port as a Key Field

Deleting the Transport Source Port as a Key Field 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "match": "",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <match></match>
            </RecordP-list>
          </recordp-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 record Flow_Rec_1
 no match transport source-port

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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
matchnetflow:MatchParams
(scalar:Bitmask64)
The match parameters of the netflow recordSELECTION:
1 - ethertype
2 - dst-mac
4 - src-mac
8 - vlan
16 - proto
32 - tos
64 - src-ipv4
128 - dst-ipv4
256 - src-ipv6
512 - dst-ipv6
1024 - src-port
2048 - dst-port
4096 - src-ip
8192 - dst-ip
16384 - opt-ipv6
32768 - flow-lbl-ipv6
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 a Description

Configuring a Description 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "descr": "Some description text 123",
                  "name": "Flow_Rec_1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list>
              <name>Flow_Rec_1</name>
              <descr>Some description text 123</descr>
            </RecordP-list>
          </recordp-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 record Flow_Rec_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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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
Description of the specified attribute
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 Description

Deleting a Description 
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
  "netflowNetflow": {
    "children": [
      {
        "netflowInst": {
          "attributes": {
            "mode": "netflow"
          },
          "children": [
            {
              "netflowRecordP": {
                "attributes": {
                  "name": "Flow_Rec_1",
                  "status": "deleted"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <recordp-items>
            <RecordP-list xc:operation="delete">
              <name>Flow_Rec_1</name>
            </RecordP-list>
          </recordp-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 record Flow_Rec_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}
netflowRecordP sys/hwtelemetry/netflow/inst-{mode}/recordp-{[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


netflowRecordP Properties

The following table contains information about the netflowRecordP 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