Configuring Flow Monitors
Configuring a Flow Monitor
Configuring a Flow Monitor
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "mon_1"
}}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>mon_1</name>
</Monitor-list>
</monitor-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 monitor mon_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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Flow Monitor
Deleting a Flow Monitor
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "mon_1",
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list xc:operation="delete">
<name>mon_1</name>
</Monitor-list>
</monitor-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 monitor mon_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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
status | mo: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:
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:
Configuring a Description
Configuring a Description
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"descr": "Some description text 123",
"name": "Flow_Mon_1"
}}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<descr>Some description text 123</descr>
</Monitor-list>
</monitor-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 monitor Flow_Mon_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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
descr | netflow:Descr | Description of the specified attribute | |
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Description
Deleting a Description
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1",
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list xc:operation="delete">
<name>Flow_Mon_1</name>
</Monitor-list>
</monitor-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 monitor Flow_Mon_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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
status | mo: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:
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:
Configuring a Flow Exporter Collector Bucket Id
Configuring a Flow Exporter Collector Bucket Id
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowCollectorBucket": {
"attributes": {
"id": "123"
},
"children": [
{
"netflowRsCollectorAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/collector-Flow_Exprt_1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<collectorbucket-items>
<CollectorBucket-list>
<id>123</id>
<rscollectorAtt-items>
<RsCollectorAtt-list>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/collector-items/Collector-list[name='Flow_Exprt_1']</tDn>
</RsCollectorAtt-list>
</rscollectorAtt-items>
</CollectorBucket-list>
</collectorbucket-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
exporter Flow_Exprt_1 collector-bucket-id 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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowCollectorBucket | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/collectorbucket-{id} |
netflowRsCollectorAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/collectorbucket-{id}/rscollectorAtt-{[tDn]} |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowCollectorBucket Properties
The following table contains information about the netflowCollectorBucket 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 Name | Data Type | Description | Values |
---|---|---|---|
id | netflow:CollBucketId (scalar:UByte) | Netflow Collector Bucket Id | RANGE: [0 , 255] |
netflowRsCollectorAtt Properties
The following table contains information about the netflowRsCollectorAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Flow Exporter Collector Bucket Id
Deleting a Flow Exporter Collector Bucket Id
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowCollectorBucket": {
"attributes": {
"id": "123"
},
"children": [
{
"netflowRsCollectorAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/hwtelemetry/netflow/inst-netflow/collector-Flow_Exprt_1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<collectorbucket-items>
<CollectorBucket-list>
<id>123</id>
<rscollectorAtt-items>
<RsCollectorAtt-list xc:operation="delete">
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/collector-items/Collector-list[name='Flow_Exprt_1']</tDn>
</RsCollectorAtt-list>
</rscollectorAtt-items>
</CollectorBucket-list>
</collectorbucket-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no exporter Flow_Exprt_1 collector-bucket-id 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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowCollectorBucket | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/collectorbucket-{id} |
netflowRsCollectorAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/collectorbucket-{id}/rscollectorAtt-{[tDn]} |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowCollectorBucket Properties
The following table contains information about the netflowCollectorBucket 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 Name | Data Type | Description | Values |
---|---|---|---|
id | netflow:CollBucketId (scalar:UByte) | Netflow Collector Bucket Id | RANGE: [0 , 255] |
netflowRsCollectorAtt Properties
The following table contains information about the netflowRsCollectorAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
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": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/recordp-record_1"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/recordp-items/RecordP-list[name='record_1']</tDn>
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
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": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items xc:operation="delete">
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no 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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo: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:
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:
Configuring Traditional IPv4 Input NetFlow
Configuring Traditional IPv4 Input NetFlow
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/recordp-netflow-ipv4-original-input"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/recordp-items/RecordP-list[name='netflow-ipv4-original-input']</tDn>
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
record netflow ipv4 original-input
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Traditional IPv4 Input NetFlow
Deleting Traditional IPv4 Input NetFlow
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items xc:operation="delete">
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no record netflow ipv4 original-input
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo: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:
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:
Configuring Input NetFlow for IPv6 Collection
Configuring Input NetFlow for IPv6 Collection
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/recordp-netflow-ipv6-original-input"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/recordp-items/RecordP-list[name='netflow-ipv6-original-input']</tDn>
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
record netflow ipv6 original-input
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Input NetFlow for IPv6 Collection
Deleting Input NetFlow for IPv6 Collection
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items xc:operation="delete">
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no record netflow ipv6 original-input
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo: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:
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:
Configuring Input NetFlow for Traditional L2 NetFlow Collection
Configuring Input NetFlow for Traditional L2 NetFlow Collection
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/recordp-netflow-layer2-switched-input"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/recordp-items/RecordP-list[name='netflow-layer2-switched-input']</tDn>
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
record netflow layer2-switched input
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Input NetFlow for Traditional L2 NetFlow Collection
Deleting Input NetFlow for Traditional L2 NetFlow Collection
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items xc:operation="delete">
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no record netflow layer2-switched input
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo: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:
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:
Configuring Protocol and Ports Aggregation
Configuring Protocol and Ports Aggregation
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/recordp-netflow-protocol-port"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/recordp-items/RecordP-list[name='netflow-protocol-port']</tDn>
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
record netflow protocol-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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Protocol and Ports Aggregation
Deleting Protocol and Ports Aggregation
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items xc:operation="delete">
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no record netflow protocol-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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo: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:
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:
Configuring Traditional IPv4 Input NetFlow
Configuring Traditional IPv4 Input NetFlow
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/recordp-netflow-original"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/recordp-items/RecordP-list[name='netflow-original']</tDn>
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
record netflow-original
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Traditional IPv4 Input NetFlow
Deleting Traditional IPv4 Input NetFlow
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowMonitor": {
"attributes": {
"name": "Flow_Mon_1"
},
"children": [
{
"netflowRsRecordPAtt": {
"attributes": {
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<monitor-items>
<Monitor-list>
<name>Flow_Mon_1</name>
<rsrecordPAtt-items xc:operation="delete">
</rsrecordPAtt-items>
</Monitor-list>
</monitor-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 monitor Flow_Mon_1
no record netflow-original
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.
MO | DN |
---|---|
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowMonitor | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]} |
netflowRsRecordPAtt | sys/hwtelemetry/netflow/inst-{mode}/monitor-{[name]}/rsrecordPAtt |
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 Name | Data Type | Description | Values |
---|---|---|---|
mode | netflow:ModeT (scalar:Enum8) | It represents the mode in which netflow is running | SELECTION: 0 - netflow DEFAULT: netflow |
netflowMonitor Properties
The following table contains information about the netflowMonitor 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 Name | Data Type | Description | Values |
---|---|---|---|
name | pol:ObjName (naming:Name256) | Object name | MAX SIZE: 64 |
netflowRsRecordPAtt Properties
The following table contains information about the netflowRsRecordPAtt 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 Name | Data Type | Description | Values |
---|---|---|---|
status | mo: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:
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: