Configuring NetFlow on a Port-Channel Interface
Configuring a Flow Monitor for IPv4 Ingress Traffic
Configuring a Flow Monitor for IPv4 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys/hwtelemetry/netflow.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123",
"layer": "Layer3",
"medium": "p2p",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
<layer>Layer3</layer>
<medium>p2p</medium>
<userCfgdFlags>admin_layer</userCfgdFlags>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
no switchport
medium p2p
ip flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
medium | l1:Medium (scalar:Enum8) | The administrative port medium type. | SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv4 Ingress Traffic
Deleting a Flow Monitor for IPv4 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123",
"layer": "Layer3",
"medium": "p2p",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
<layer>Layer3</layer>
<medium>p2p</medium>
<userCfgdFlags>admin_layer</userCfgdFlags>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list xc:operation="delete">
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
no switchport
medium p2p
no ip flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
medium | l1:Medium (scalar:Enum8) | The administrative port medium type. | SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv6 Ingress Traffic
Configuring a Flow Monitor for IPv6 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123",
"layer": "Layer3",
"medium": "p2p",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
<layer>Layer3</layer>
<medium>p2p</medium>
<userCfgdFlags>admin_layer</userCfgdFlags>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
no switchport
medium p2p
ipv6 flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
medium | l1:Medium (scalar:Enum8) | The administrative port medium type. | SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv6 Ingress Traffic
Deleting a Flow Monitor for IPv6 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123",
"layer": "Layer3",
"medium": "p2p",
"userCfgdFlags": "admin_layer"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
<layer>Layer3</layer>
<medium>p2p</medium>
<userCfgdFlags>admin_layer</userCfgdFlags>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list xc:operation="delete">
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
no switchport
medium p2p
no ipv6 flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer |
medium | l1:Medium (scalar:Enum8) | The administrative port medium type. | SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv4 Ingress Traffic
Configuring a Flow Monitor for IPv4 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
ip flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv4 Ingress Traffic
Deleting a Flow Monitor for IPv4 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list xc:operation="delete">
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
no ip flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv6 Ingress Traffic
Configuring a Flow Monitor for IPv6 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list>
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
ipv6 flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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 Monitor for IPv6 Ingress Traffic
Deleting a Flow Monitor for IPv6 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"interfaceEntity": {
"children": [
{
"pcAggrIf": {
"attributes": {
"id": "po123"
}
}
}
]
}
},
{
"analyticsHwTelemetry": {
"children": [
{
"netflowNetflow": {
"children": [
{
"netflowInst": {
"attributes": {
"mode": "netflow"
},
"children": [
{
"netflowFwdInstTarget": {
"attributes": {
"id": "369098874"
},
"children": [
{
"netflowRsMonitorAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<intf-items>
<aggr-items>
<AggrIf-list>
<id>po123</id>
</AggrIf-list>
</aggr-items>
</intf-items>
<hwtelemetry-items>
<netflow-items>
<inst-items>
<Inst-list>
<mode>netflow</mode>
<fwdinst-items>
<FwdInstTarget-list>
<id>369098874</id>
<rsmonitorAtt-items>
<RsMonitorAtt-list xc:operation="delete">
<tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
</RsMonitorAtt-list>
</rsmonitorAtt-items>
</FwdInstTarget-list>
</fwdinst-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.
interface port-channel 123
no ipv6 flow monitor mon_1 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 |
---|---|
topSystem | sys |
interfaceEntity | sys/intf |
pcAggrIf | sys/intf/aggr-{[id]} |
analyticsHwTelemetry | sys/hwtelemetry |
netflowNetflow | sys/hwtelemetry/netflow |
netflowInst | sys/hwtelemetry/netflow/inst-{mode} |
netflowFwdInstTarget | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id} |
netflowRsMonitorAtt | sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]} |
pcAggrIf Properties
The following table contains information about the pcAggrIf 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 | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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 |
netflowFwdInstTarget Properties
The following table contains information about the netflowFwdInstTarget 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:FwdInstTargetId (scalar:Uint32) | Identifier to the Forward Instance Target | RANGE: [0 , 4294967295] |
netflowRsMonitorAtt Properties
The following table contains information about the netflowRsMonitorAtt 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: