Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Querying for Detailed NetFlow RTP Information (IPv4 and IPv6)

DME

Copy
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=" "
Response
{
    "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."
                }
            }
        }
    ]
}

Querying NetFlow RTP Information

Querying for Detailed NetFlow RTP Information (IPv4 and IPv6)

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

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:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
dn	reference:BinRef	A 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 DEFAULT: false
isRtpIpv6	scalar:Bool	RTP IPV6 Config	SELECTION: true or false DEFAULT: false
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
rtpIpv4Acl	netflow:ACLName (string:Basic)	RTP IPV4 ACL	MAX SIZE: 64 DEFAULT:
rtpIpv6Acl	netflow:ACLName (string:Basic)	RTP IPV6 ACL	MAX SIZE: 64 DEFAULT:
rtpTimeout	netflow:RtpTimeout (scalar:Uint32)	RTP Flow Timeout	RANGE: [0 , 1440] DEFAULT: 1
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
ctrl	nw:InstCtrl scalar:Bitmask64	The control state.	SELECTION: 1ull - stateful-ha DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
mode	netflow:ModeT (scalar:Enum8)	It represents the mode in which netflow is running	SELECTION: 0 - netflow DEFAULT: netflow
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "0" Max: "128"
operErr	nw:OperErrQual scalar:Bitmask64		SELECTION: 16ull - sock-err 1ull - init-err 2ull - mem-err 32ull - proto-err 4ull - ipc-err 8ull - int-err DEFAULT: 0
rn	reference:BinRN	Identifies 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: 2 - created 4 - modified 8 - deleted 16 - replaced
timeOut	netflow:FlowTimeout (scalar:Uint32)	Flow timeout	RANGE: [5 , 60] DEFAULT: 10

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Querying for Detailed NetFlow RTP Information (IPv4 Only)

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

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

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
dn	reference:BinRef	A 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 DEFAULT: false
isRtpIpv6	scalar:Bool	RTP IPV6 Config	SELECTION: true or false DEFAULT: false
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
rtpIpv4Acl	netflow:ACLName (string:Basic)	RTP IPV4 ACL	MAX SIZE: 64 DEFAULT:
rtpIpv6Acl	netflow:ACLName (string:Basic)	RTP IPV6 ACL	MAX SIZE: 64 DEFAULT:
rtpTimeout	netflow:RtpTimeout (scalar:Uint32)	RTP Flow Timeout	RANGE: [0 , 1440] DEFAULT: 1440
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

netflowInst Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
ctrl	nw:InstCtrl scalar:Bitmask64	The control state.	SELECTION: 1ull - stateful-ha DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
mode	netflow:ModeT (scalar:Enum8)	It represents the mode in which netflow is running	SELECTION: 0 - netflow DEFAULT: netflow
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "0" Max: "128"
operErr	nw:OperErrQual scalar:Bitmask64		SELECTION: 16ull - sock-err 1ull - init-err 2ull - mem-err 32ull - proto-err 4ull - ipc-err 8ull - int-err DEFAULT: 0
rn	reference:BinRN	Identifies 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: 2 - created 4 - modified 8 - deleted 16 - replaced
timeOut	netflow:FlowTimeout (scalar:Uint32)	Flow timeout	RANGE: [5 , 60] DEFAULT: 10

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Querying for RTP Flows with Active Losses

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

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
dn	reference:BinRef	A 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 DEFAULT: false
isRtpIpv6	scalar:Bool	RTP IPV6 Config	SELECTION: true or false DEFAULT: false
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
rtpIpv4Acl	netflow:ACLName (string:Basic)	RTP IPV4 ACL	MAX SIZE: 64 DEFAULT:
rtpIpv6Acl	netflow:ACLName (string:Basic)	RTP IPV6 ACL	MAX SIZE: 64 DEFAULT:
rtpTimeout	netflow:RtpTimeout (scalar:Uint32)	RTP Flow Timeout	RANGE: [0 , 1440] DEFAULT: 1440
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

netflowInst Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
ctrl	nw:InstCtrl scalar:Bitmask64	The control state.	SELECTION: 1ull - stateful-ha DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
mode	netflow:ModeT (scalar:Enum8)	It represents the mode in which netflow is running	SELECTION: 0 - netflow DEFAULT: netflow
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "0" Max: "128"
operErr	nw:OperErrQual scalar:Bitmask64		SELECTION: 16ull - sock-err 1ull - init-err 2ull - mem-err 32ull - proto-err 4ull - ipc-err 8ull - int-err DEFAULT: 0
rn	reference:BinRN	Identifies 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: 2 - created 4 - modified 8 - deleted 16 - replaced
timeOut	netflow:FlowTimeout (scalar:Uint32)	Flow timeout	RANGE: [5 , 60] DEFAULT: 10

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Querying RTP Flows with Loss History (IPv6 Only)

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

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
dn	reference:BinRef	A 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 DEFAULT: false
isRtpIpv6	scalar:Bool	RTP IPV6 Config	SELECTION: true or false DEFAULT: false
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
rtpIpv4Acl	netflow:ACLName (string:Basic)	RTP IPV4 ACL	MAX SIZE: 64 DEFAULT:
rtpIpv6Acl	netflow:ACLName (string:Basic)	RTP IPV6 ACL	MAX SIZE: 64 DEFAULT:
rtpTimeout	netflow:RtpTimeout (scalar:Uint32)	RTP Flow Timeout	RANGE: [0 , 1440] DEFAULT: 1
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

netflowInst Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
ctrl	nw:InstCtrl scalar:Bitmask64	The control state.	SELECTION: 1ull - stateful-ha DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
mode	netflow:ModeT (scalar:Enum8)	It represents the mode in which netflow is running	SELECTION: 0 - netflow DEFAULT: netflow
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "0" Max: "128"
operErr	nw:OperErrQual scalar:Bitmask64		SELECTION: 16ull - sock-err 1ull - init-err 2ull - mem-err 32ull - proto-err 4ull - ipc-err 8ull - int-err DEFAULT: 0
rn	reference:BinRN	Identifies 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: 2 - created 4 - modified 8 - deleted 16 - replaced
timeOut	netflow:FlowTimeout (scalar:Uint32)	Flow timeout	RANGE: [5 , 60] DEFAULT: 10

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html