Querying NetFlow RTP Information
Querying for Detailed NetFlow RTP Information (IPv4 and IPv6)
Querying for Detailed NetFlow RTP Information (IPv4 and IPv6)
GET http://<IP_Address>/api/mo/sys/hwtelemetry/netflow.json?rsp-subtree=children&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=50000&batch-context=" "
{
"totalCount": "1",
"imdata": [
{
"netflowNetflow": {
"attributes": {
"childAction": "",
"dn": "sys/hwtelemetry/netflow",
"isRtpIpv4": "yes",
"isRtpIpv6": "yes",
"modTs": "2019-10-11T04:58:11.782+00:00",
"rtpIpv4Acl": "",
"rtpIpv6Acl": "",
"rtpTimeout": "1440",
"status": ""
},
"children": [
{
"netflowInst": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"ctrl": "",
"modTs": "2019-10-11T04:58:08.065+00:00",
"mode": "netflow",
"name": "",
"operErr": "",
"rn": "inst-netflow",
"status": "",
"timeOut": "60"
}
}
},
{
"netflowFlowInfo": {
"attributes": {
"bytesPerSec": "1819726",
"dip": "30.30.1.2",
"dstPort": "21999",
"flowId": "2",
"flowStartTime": "21:16:52 UTC Oct 15 2019",
"intfName": "Ethernet1/97",
"lossEndTime": "",
"lossStartTime": "",
"pktCount": "133100",
"pktLoss": "0",
"protocol": "17",
"rn": "flowinfo-2",
"sip": "20.20.1.2",
"srcPort": "30000"
}
}
},
{
"netflowFlowInfo": {
"attributes": {
"bytesPerSec": "1819726",
"dip": "20.20.1.2",
"dstPort": "21999",
"flowId": "1",
"flowStartTime": "21:16:52 UTC Oct 15 2019",
"intfName": "Ethernet1/98",
"lossEndTime": "",
"lossStartTime": "",
"pktCount": "133100",
"pktLoss": "0",
"protocol": "17",
"rn": "flowinfo-1",
"sip": "30.30.1.2",
"srcPort": "30000"
}
}
}
]
}
},
{
"warning": {
"attributes": {
"text": "backend rv=43700005, No more ephemeral data to dump."
}
}
}
]
}
Note: This example was added in Cisco NX-OS Release 9.3(3).
CLI Output Switch(config)# show flow rtp details
RTP Flow timeout is 1440 minutes
IPV4 Entries
SIP DIP BD ID S-Port D-Port Intf/Vlan Name Pack
et Count BytesPerSec FlowStart
30.30.1.2 20.20.1.2 4197 30000 21999 Ethernet1/98 1863
40 1811638 21:16:52 UTC Oct 15 2019
20.20.1.2 30.30.1.2 4196 30000 21999 Ethernet1/97 1863
40 1811638 21:16:52 UTC Oct 15 2019
netflowNetflow Properties
The following table contains information about the netflowNetflow 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 childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. isRtpIpv4 scalar:Bool RTP IPV4 Config SELECTION: true or false isRtpIpv6 scalar:Bool RTP IPV6 Config SELECTION: true or false modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: rtpIpv4Acl netflow:ACLName
(string:Basic)RTP IPV4 ACL rtpIpv6Acl netflow:ACLName
(string:Basic)RTP IPV6 ACL rtpTimeout netflow:RtpTimeout
(scalar:Uint32)RTP Flow Timeout status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION:
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 adminSt
nw:AdminSt
scalar:Enum8The administrative state of the object or policy. SELECTION:
childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
ctrl
nw:InstCtrl
scalar:Bitmask64The control state. SELECTION:
modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: mode netflow:ModeT
(scalar:Enum8)It represents the mode in which netflow is running SELECTION: name
naming:Name256
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "128" operErr
nw:OperErrQual
scalar:Bitmask64 SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION: timeOut netflow:FlowTimeout
(scalar:Uint32)Flow timeout
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:
Querying for Detailed NetFlow RTP Information (IPv4 Only)
Querying for Detailed NetFlow RTP Information (IPv4 Only)
GET http://<IP_Address>/api/mo/sys/hwtelemetry/netflow.json?rsp-subtree=children&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=50000&batch-context="af-ipv4"
{
"totalCount": "1",
"imdata": [
{
"netflowNetflow": {
"attributes": {
"childAction": "",
"dn": "sys/hwtelemetry/netflow",
"isRtpIpv4": "yes",
"isRtpIpv6": "yes",
"modTs": "2019-10-11T04:58:11.782+00:00",
"rtpIpv4Acl": "",
"rtpIpv6Acl": "",
"rtpTimeout": "1440",
"status": ""
},
"children": [
{
"netflowInst": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"ctrl": "",
"modTs": "2019-10-11T04:58:08.065+00:00",
"mode": "netflow",
"name": "",
"operErr": "",
"rn": "inst-netflow",
"status": "",
"timeOut": "60"
}
}
},
{
"netflowFlowInfo": {
"attributes": {
"bytesPerSec": "1811638",
"dip": "30.30.1.2",
"dstPort": "21999",
"flowId": "2",
"flowStartTime": "21:16:52 UTC Oct 15 2019",
"intfName": "Ethernet1/97",
"lossEndTime": "",
"lossStartTime": "",
"pktCount": "186340",
"pktLoss": "0",
"protocol": "17",
"rn": "flowinfo-2",
"sip": "20.20.1.2",
"srcPort": "30000"
}
}
},
{
"netflowFlowInfo": {
"attributes": {
"bytesPerSec": "1811638",
"dip": "20.20.1.2",
"dstPort": "21999",
"flowId": "1",
"flowStartTime": "21:16:52 UTC Oct 15 2019",
"intfName": "Ethernet1/98",
"lossEndTime": "",
"lossStartTime": "",
"pktCount": "186340",
"pktLoss": "0",
"protocol": "17",
"rn": "flowinfo-1",
"sip": "30.30.1.2",
"srcPort": "30000"
}
}
}
]
}
},
{
"warning": {
"attributes": {
"text": "backend rv=43700005, No more ephemeral data to dump."
}
}
}
]
}
Note: This example was added in Cisco NX-OS Release 9.3(3).
CLI Output Switch(config)# show flow rtp details ipv4
RTP Flow timeout is 1440 minutes
IPV4 Entries
SIP DIP BD ID S-Port D-Port Intf/Vlan Name Pack
et Count BytesPerSec FlowStart
30.30.1.2 20.20.1.2 4197 30000 21999 Ethernet1/98 1863
40 1811638 21:16:52 UTC Oct 15 2019
20.20.1.2 30.30.1.2 4196 30000 21999 Ethernet1/97 1863
40 1811638 21:16:52 UTC Oct 15 2019
netflowNetflow Properties
The following table contains information about the netflowNetflow 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 childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. isRtpIpv4 scalar:Bool RTP IPV4 Config SELECTION: true or false isRtpIpv6 scalar:Bool RTP IPV6 Config SELECTION: true or false modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: rtpIpv4Acl netflow:ACLName
(string:Basic)RTP IPV4 ACL rtpIpv6Acl netflow:ACLName
(string:Basic)RTP IPV6 ACL rtpTimeout netflow:RtpTimeout
(scalar:Uint32)RTP Flow Timeout status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION:
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 adminSt
nw:AdminSt
scalar:Enum8The administrative state of the object or policy. SELECTION:
childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
ctrl
nw:InstCtrl
scalar:Bitmask64The control state. SELECTION:
modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: mode netflow:ModeT
(scalar:Enum8)It represents the mode in which netflow is running SELECTION: name
naming:Name256
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "128" operErr
nw:OperErrQual
scalar:Bitmask64 SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION: timeOut netflow:FlowTimeout
(scalar:Uint32)Flow timeout
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:
Querying for RTP Flows with Active Losses
Querying for RTP Flows with Active Losses
GET http://<IP_Address>/api/mo/sys/hwtelemetry/netflow.json?rsp-subtree=children&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=50000&batch-context="error-active"
{
"totalCount": "1",
"imdata": [
{
"netflowNetflow": {
"attributes": {
"childAction": "",
"dn": "sys/hwtelemetry/netflow",
"isRtpIpv4": "yes",
"isRtpIpv6": "yes",
"modTs": "2019-10-11T04:58:11.782+00:00",
"rtpIpv4Acl": "",
"rtpIpv6Acl": "",
"rtpTimeout": "1440",
"status": ""
},
"children": [
{
"netflowInst": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"ctrl": "",
"modTs": "2019-10-11T04:58:08.065+00:00",
"mode": "netflow",
"name": "",
"operErr": "",
"rn": "inst-netflow",
"status": "",
"timeOut": "60"
}
}
}
]
}
},
{
"warning": {
"attributes": {
"text": "backend rv=43700005, No more ephemeral data to dump."
}
}
}
]
}
Note: This example was added in Cisco NX-OS Release 9.3(3).
CLI Output Switch(config)# show flow rtp errors active
RTP Flow timeout is 1440 minutes
netflowNetflow Properties
The following table contains information about the netflowNetflow 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 childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. isRtpIpv4 scalar:Bool RTP IPV4 Config SELECTION: true or false isRtpIpv6 scalar:Bool RTP IPV6 Config SELECTION: true or false modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: rtpIpv4Acl netflow:ACLName
(string:Basic)RTP IPV4 ACL rtpIpv6Acl netflow:ACLName
(string:Basic)RTP IPV6 ACL rtpTimeout netflow:RtpTimeout
(scalar:Uint32)RTP Flow Timeout status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION:
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 adminSt
nw:AdminSt
scalar:Enum8The administrative state of the object or policy. SELECTION:
childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
ctrl
nw:InstCtrl
scalar:Bitmask64The control state. SELECTION:
modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: mode netflow:ModeT
(scalar:Enum8)It represents the mode in which netflow is running SELECTION: name
naming:Name256
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "128" operErr
nw:OperErrQual
scalar:Bitmask64 SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION: timeOut netflow:FlowTimeout
(scalar:Uint32)Flow timeout
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:
Querying RTP Flows with Loss History (IPv6 Only)
Querying RTP Flows with Loss History (IPv6 Only)
GET http://<IP_Address>/api/mo/sys/hwtelemetry/netflow.json?rsp-subtree=children&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=50000&batch-context="af-ipv6,error-history"
{
"totalCount": "1",
"imdata": [
{
"netflowNetflow": {
"attributes": {
"childAction": "",
"dn": "sys/hwtelemetry/netflow",
"isRtpIpv4": "yes",
"isRtpIpv6": "yes",
"modTs": "2019-10-11T04:58:11.782+00:00",
"rtpIpv4Acl": "",
"rtpIpv6Acl": "",
"rtpTimeout": "1440",
"status": ""
},
"children": [
{
"netflowInst": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"ctrl": "",
"modTs": "2019-10-11T04:58:08.065+00:00",
"mode": "netflow",
"name": "",
"operErr": "",
"rn": "inst-netflow",
"status": "",
"timeOut": "60"
}
}
}
]
}
},
{
"warning": {
"attributes": {
"text": "backend rv=43700005, No more ephemeral data to dump."
}
}
}
]
}
Note: This example was added in Cisco NX-OS Release 9.3(3).
CLI Output Switch(config)# show flow rtp errors history ipv6
RTP Flow timeout is 1440 minutes
netflowNetflow Properties
The following table contains information about the netflowNetflow 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 childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. isRtpIpv4 scalar:Bool RTP IPV4 Config SELECTION: true or false isRtpIpv6 scalar:Bool RTP IPV6 Config SELECTION: true or false modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: rtpIpv4Acl netflow:ACLName
(string:Basic)RTP IPV4 ACL rtpIpv6Acl netflow:ACLName
(string:Basic)RTP IPV6 ACL rtpTimeout netflow:RtpTimeout
(scalar:Uint32)RTP Flow Timeout status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION:
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 adminSt
nw:AdminSt
scalar:Enum8The administrative state of the object or policy. SELECTION:
childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
ctrl
nw:InstCtrl
scalar:Bitmask64The control state. SELECTION:
modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: mode netflow:ModeT
(scalar:Enum8)It represents the mode in which netflow is running SELECTION: name
naming:Name256
string:BasicThe name of the object. RANGE:
Min: "0"
Max: "128" operErr
nw:OperErrQual
scalar:Bitmask64 SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)Modification status SELECTION: timeOut netflow:FlowTimeout
(scalar:Uint32)Flow timeout
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: