![]() |
Cisco IOS Media Monitoring Command Reference
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cisco Performance Monitor
![]() |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contents
Cisco Performance Monitoraction (policy-react and policy-inline-react)To configure which applications which will receive an alarm or notification, use the actioncommand in policy react configuration mode and policy inline react configuration mode. To disable the sending alarms or notifications, use the no form of this command. Command Modes
Usage GuidelinesYou can configure multiple action commands to allow more than one recipients to receive an alarm or notification. ExamplesThe following example shows how to specify that SNMP MIB variables will receive an alarm or notification, while configuring a policy-map: Router(config)# policy-map type performance-monitor policy-4 Router(config-pmap)# class PM-CLASS-4 Router(config-pmap-c)# react 2000 rtp-jitter-average Router(config-pmap-c-react)# action snmp The following example shows how to specify that SNMP MIB variables will receive an alarm or notification, while associating a service-policy with an interface: Router(config)# interface ethernet 0/0 Router(config-if)# service-policy type performance-monitor inline input Router(config-if-spolicy-inline)# react 2000 rtp-jitter-average Router(config-spolicy-inline-react)# action snmp alarm severity (policy-react and policy-inline-react)To configure the severity of alarms sent for a Performance Monitor policy, use the alarm severitycommand in policy react configuration mode and policy inline react configuration mode. To return to the default and send all alarms, use the no form of this command.
alarm
severity
{alert | critical | emergency | error | info}
no
alarm
severity
{alert | critical | emergency | error | info}
Command Modes
Usage GuidelinesThe definition of the alarms types are listed below in order of severity:
ExamplesThe following example shows how to specify that only emergency alarms will be sent, while configuring a policy-map: Router(config)# policy-map type performance-monitor policy-4 Router(config-pmap)# class PM-CLASS-4 Router(config-pmap-c)# react 2000 rtp-jitter-average Router(config-pmap-c-react)# alarm severity emergency The following example shows how to specify that only emergency alarms will be sent, while associating a service-policy with an interface: Router(config)# interface ethernet 0/0 Router(config-if)# service-policy type performance-monitor inline input Router(config-if-spolicy-inline)# react 2000 rtp-jitter-average Router(config-spolicy-inline-react)# alarm severity emergency alarm type (policy-react and policy-inline-react)To configure the types of alarms sent for a Performance Monitor policy, use the alarm typecommand in policy react configuration mode and policy inline react configuration mode. To return to the default and send all alarms, use the no form of this command.
alarm type
{discrete | grouped {count number | percent number}}
no alarm type
{discrete | grouped {count number | percent number}}
Command Modes
Usage GuidelinesThe monitored event is specified by the react command. You can group alarms by whether they exceed a specified percentage or count. ExamplesThe following example shows how to specify that only percentage type alarms will be sent, while configuring a policy-map: Router(config)# policy-map type performance-monitor policy-4 Router(config-pmap)# class PM-CLASS-4 Router(config-pmap-c)# react 2000 rtp-jitter-average Router(config-pmap-c-react)# alarm type percent 80 The following example shows how to specify that only percentage type alarms will be sent, while associating a service-policy with an interface: Router(config)# interface ethernet 0/0 Router(config-if)# service-policy type performance-monitor inline input Router(config-if-spolicy-inline)# react 2000 rtp-jitter-average Router(config-spolicy-inline-react)# alarm type percent 80 cache entriesTo configure the number cache entries for a Performance Monitor flow monitor, use the cache entriescommand in flow monitor configuration mode. To remove the configuration, use the no form of this command. ExamplesThe following example shows how to set the number cache entries to 200, while configuring a flow monitor for Performance Monitor: Router(config)# flow monitor type performance-monitor monitor-4 Router(config-flow-monitor)# cache entries 200 Router(config-flow-monitor)# record r2 Router(config-flow-monitor)# exporter e2 cache timeoutTo configure the cache timeout for a Performance Monitor flow monitor, use the cache timeoutcommand in flow monitor configuration mode. To remove the configuration, use the no form of this command.
cache
timeout
{{active | inactive | synchronized}timeout | event transaction end}
no
cache
timeout
{{active | inactive | synchronized}timeout | event transaction end}
ExamplesThe following example shows how to set an active cache timeout of 20 seconds, while configuring a flow monitor for Performance Monitor: Router(config)# flow monitor type performance-monitor monitor-4 Router(config-flow-monitor)# cache timeout active 20 Router(config-flow-monitor)# record r2 Router(config-flow-monitor)# exporter e2 cache typeTo configure the cache type for a Performance Monitor flow monitor, use the cache typecommand in flow monitor configuration mode. To remove the configuration, use the no form of this command. ExamplesThe following example shows how to configure a normal cache, while configuring a flow monitor for Performance Monitor: Router(config)# flow monitor type performance-monitor monitor-4 Router(config-flow-monitor)# cache type normal Router(config-flow-monitor)# record r2 Router(config-flow-monitor)# exporter e2 class-mapTo create a class map to be used for matching packets to a specified class and to enter QoS class-map configuration mode, use the class-map command in global configuration mode. To remove an existing class map from a device, use the no form of this command. Cisco 2600, 3660, 3845, 6500, 7200, 7401, and 7500 Series Routers
class-map
[type {stack | access-control | port-filter | queue-threshold | logging log-class}]
[match-all | match-any]
class-map-name
no
class-map
[type {stack | access-control | port-filter | queue-threshold | logging log-class}]
[match-all | match-any]
class-map-name
Cisco 7600 Series Routers
class-map
class-map-name
[match-all | match-any]
no
class-map
class-map-name
[match-all | match-any]
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE
class-map
class-map-name
no
class-map
class-map-name
Syntax DescriptionCommand History
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SEOnly the class-map-name argument is available. Cisco 2600, 3660, 3845, 6500, 7200, 7401, 7500, and ASR 1000 Series RoutersUse the class-map command to specify the class that you will create or modify to meet the class-map match criteria. This command enters QoS class-map configuration mode in which you can enter one or more match commands to configure the match criteria for this class. Packets that arrive at either the input interface or the output interface (determined by how the service-policy command is configured) are checked against the match criteria that are configured for a class map to determine if packets belong to that class. When configuring a class map, you can use one or more match commands to specify the match criteria. For example, you can use the match access-group command, the match protocol command, or the match input-interface command. The match commands vary according to the Cisco software release. For more information about match criteria and match commands, see the "Modular Quality of Service Command-Line Interface (CLI) (MQC)" chapter of the Cisco IOS Quality of Service Solutions Configuration Guide. Cisco 7600 Series RoutersApply the class-map command and commands available in QoS class-map configuration mode on a per-interface basis to define packet classification, marking, aggregating, and flow policing as part of a globally named service policy. You can attach a service policy to an EtherChannel. Do not attach a service policy to a port that is a member of an EtherChannel. When a device is in QoS class-map configuration mode, the following configuration commands are available:
The following commands appear in the CLI help but are not supported on LAN interfaces or WAN interfaces on Optical Service Modules (OSMs):
OSMs are not supported on Cisco 7600 series routers that are configured with a Supervisor Engine 32. Policy Feature Card (PFC) QoS does not support the following commands:
If you enter these commands, PFC QoS does not detect unsupported keywords until you attach a policy map to an interface. When you try to attach the policy map to an interface, an error message is generated. For additional information, see the Cisco 7600 Series Router Cisco IOS Software Configuration Guide and Cisco IOS command references. After configuring the class-map name and the device you can enter the match access-group and match ip dscp commands in QoS class-map configuration mode. The syntax for these commands is as follows: match [access-group {acl-index | acl-name} | ip dscp | precedence} value] See the table below for a description of match command keywords.
ExamplesThe following example shows how to specify class101 as the name of a class and define a class map for this class. The class named class101 specifies policy for the traffic that matches ACL 101. Device(config)# class-map class101 Device(config-cmap)# match access-group 101 Device(config-cmap)# end The following example shows how to define FPM traffic classes for slammer and UDP packets. The match criteria defined within class maps are for slammer and UDP packets with an IP length that does not exceed 404 (0x194) bytes, UDP port 1434 (0x59A), and pattern 0x4011010 at 224 bytes from the start of the IP header. Device(config)# load protocol disk2:ip.phdf Device(config)# load protocol disk2:udp.phdf Device(config)# class-map type stack match-all ip-udp Device(config-cmap)# description "match UDP over IP packets" Device(config-cmap)# match field ip protocol eq 0x11 next udp Device(config-cmap)#exit Device(config)# class-map type access-control match-all slammer Device(config-cmap)# description "match on slammer packets" Device(config-cmap)# match field udp dest-port eq 0x59A Device(config-cmap)# match field ip length eq 0x194 Device(config-cmap)# match start 13-start offset 224 size 4 eq 0x 4011010 Device(config-cmap)# end The following example shows how to configure a port-filter policy to drop all traffic that is destined to closed or "nonlistened" ports except Simple Network Management Protocol (SNMP): Device(config)# class-map type port-filter pf-class Device(config-cmap)# match not port udp 123 Device(config-cmap)# match closed-ports Device(config-cmap)# exit Device(config)# policy-map type port-filter pf-policy Device(config-pmap)# class pf-class Device(config-pmap-c)# drop Device(config-pmap-c)# end The following example shows how to configure a class map named ipp5 and enter a match statement for IP precedence 5: Device(config)# class-map ipp5 Device(config-cmap)# match ip precedence 5 Setting Up a Class Map Inside an 802.1p DomainThe following example shows how to set up a class map and match traffic classes for the 802.1p domain with packet class of service (CoS) values: Device> enable Device# configure terminal Device(config)# class-map cos1 Device(config-cmap)# match cos 0 Device(config-pmap-c)# end Setting Up a Class Map Inside an MPLS DomainThe following example shows how to set up a class map and match traffic classes for the Multiprotocol Label Switching (MPLS) domain with packet experimental (EXP) values: Device> enable Device# configure terminal Device(config)# class-map exp7 Device(config-cmap)# match mpls experimental topmost 2 Device(config-pmap-c)# end Related Commands
clear fm performance-monitor countersTo clear counters for the Performance Monitor component of Feature Monitor, use the clear fm performance-monitor counterscommand in privileged EXEC mode. ExamplesThe following example shows the how to clear counters for the Performance Monitor component of Feature Monitor:
Router# clear fm performance-monitor counters
Related Commands
clock-rate (policy RTP)To configure the rate for the RTP packet time-stamp clock, use the clock-ratecommand in policy RTP configuration mode. To remove the configuration, use the no form of this command. Syntax Description
Command Modes
Usage GuidelinesFor more information about how the clock rate for RTP packet time-stamp clock is used to calculate the packet arrival latency, see RFC 3550, RTP, A Transport Protocol for Real-Time Applications . The clock rate has to be synchronized with the routers along the path of the flow. Because the clock rate can vary depending on the payload codec type, a keyword is provided to set the expected clock rate. The available values for type-name and type-numberare celb (25), cn (13), dvi4 (5) (8000 Hz as described in RFC 3551, RTP Profile for Audio and Video Conferences with Minimal Control ), dvi4-2 (6) (8000 Hz as described in RFC 3551), dvi4-3 (16) (DVI4 Dipol 11025 Hz), dvi4-4 (17) DVI4 Dipol 22050 Hz), g722 (9), g723 (4), g728 (15), g729 (18), gsm (3), h261 (31), h263 (34), jpeg (26), l16 (11) (L16 channel 1), l16-2 (10) (L16 channel 2), lpc (7), mp2t (33), mpa (14), mpv (32), nv (28), pcma (8), pcmu (0), qcelp (12). ExamplesThe following example shows how to set the rate for the RTP packet time-stamp clock,while configuring a policy-map: Router(config)# policy-map type performance-monitor policy-4 Router(config-pmap)# class PM-CLASS-4 Router(config-pmap-c)# monitor metric rtp Router(config-pmap-c-mrtp)# clock-rate 8 9600 The following example shows how to set the rate for the RTP packet time-stamp clock, while associating a service-policy with an interface: Router(config)# interface ethernet 0/0 Router(config-if)# service-policy type performance-monitor inline input Router(config-if-spolicy-inline)# monitor metric rtp Router(config-spolicy-inline-mrtp)# clock-rate 8 9600 collect application descriptionTo configure one or more of the application description field as a nonkey field for a flow record, use the collect application description command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect application httpTo configure one of the HTTP application fields as a nonkey field for a flow record, use the collect application http host command in flow record configuration mode. To disable the use the HTTP application fields as a key field for a flow record, use the no form of this command.
collect
application
http
{host | uri statistics}
no collect
application
http
{host | uri statistics}
Command History
Usage GuidelinesThis command can be used with Flexible NetFlow, MACE (Measurement, Aggregation, and Correlation Engine), and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for all three products, here we refer to the command mode for these products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the HTTP application host as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect application http host Cisco Performance Monitor in Cisco IOS Release 15.2(4)S and Cisco IOS XE Release 3.7SThe following example configures the HTTP application host as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application http host The following example configures the HTTP application URI statistics as a nonkey field for Performance Monitor: Router(config)# flow record type mace RECORD-1 Router(config-flow-record)# collect application http uri statistics Related Commands
collect application mediaTo configure one of the application media fields as a nonkey field for a flow record, use the collect application media command in flow record configuration mode. To disable the use of one of the application media field as a nonkey field for a flow record, use the no form of this command.
collect
application
media
{bytes {rate | counter [long] } | packets {rate [variation] | counter [long] } | events}
no
collect
application
media
{bytes | packets | events}
Syntax Description
Command DefaultThe application media field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect application nameTo configure the use of the application name as a nonkey field for a flow record, use the collect application name command in flow record configuration mode. To disable the use of the application name as a nonkey field for a flow record, use the no form of this command. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. A flow record requires at least one key field before it can be used in a flow monitor. The key fields differentiate flows, with each flow having a unique set of values for the key fields. The key fields are defined using the match command. ExamplesThe following example configures the application name as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect application name Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the application name as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application name Related Commands
collect application nntpTo configure the NNTP application group name field as a nonkey field for a flow record, use the collect application nntp group-name command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the NNTP application group name as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect application nntp group-name Cisco Performance Monitor in Cisco IOS Release 15.2(4)S and Cisco IOS XE Release 3.7SThe following example configures the NNTP application group name as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application nntp group-name collect application pop3To configure the POP3 application server field as a nonkey field for a flow record, use the collect application pop3 server command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe fields collected by this command can only extracted using the IPFIX export protocol. This command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the POP3 application server as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect application pop3 server Cisco Performance Monitor in Cisco IOS Release 15.2(4)S and Cisco IOS XE Release 3.7SThe following example configures the POP3 application server as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application pop3 server collect application rtspTo configure the RTSP application hostname field as a nonkey field for a flow record, use the collect application rtsp host-name command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe fields collected by this command can only extracted using the IPFIX export protocol. This command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the RTSP application hostname as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect application rtsp host-name Cisco Performance Monitor in Cisco IOS Release 15.2(4)S and Cisco IOS XE Release 3.7SThe following example configures the RTSP application hostname as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application rtsp host-name collect application sipTo configure the SIP application destination or source field as a nonkey field for a flow record, use the collect application sip command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe fields collected by this command can only extracted using the IPFIX export protocol. This command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the SIP application source as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect application sip source Cisco Performance Monitor in Cisco IOS Release 15.2(4)S and Cisco IOS XE Release 3.7SThe following example configures the application SMTP hostname as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application sip source collect application smtpTo configure the SMTP application server or sender field as a nonkey field for a flow record, use the collect application smtp command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe fields collected by this command can only extracted using the IPFIX export protocol. This command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the SMTP application server as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect application smtp server Cisco Performance Monitor in Cisco IOS Release 15.2(4)S and Cisco IOS XE Release 3.7SThe following example configures the SMTP application server as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect application smtp server collect application vendorTo configure one or more of the application vendor field as a nonkey field for a flow record, use the collect application vendor command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect application versionTo configure one or more of the application version field as a nonkey field for a flow record, use the collect application version command in flow record configuration mode. To disable the use the application fields as a key field for a flow record, use the no form of this command. Usage GuidelinesThe Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connectionTo configure various connection information fields as a nonkey field for a flow record, use the collect connection command in flow record configuration mode. To disable the use of the connection information fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
{initiator | new-translations | sum-duration}
no
collect
connection
{initiator | new-translations | sum-duration}
Syntax Description
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The initiator keyword provides the following information about the direction of the flow.
For the new-translations and sum-duration keywords, the observation period can be specified by the start and end timestamps for the flow. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures information about the direction of the flow as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect connections initiator collect connection clientTo configure one of the connection client fields as a nonkey field for a flow record, use the collect connection client command in flow record configuration mode. To disable the use of one of the connection client fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
client {counter{{bytes long | packets long | packets retransmitted}} | {{ipv4 | ipv6}}address | transport port}
no
collect
connection
client {counter{{bytes long | packets long | packets retransmitted}} | {{ipv4 | ipv6}}address | transport port}
Syntax Description
Command DefaultThe connection client fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection delay applicationTo configure one of the connection application delay fields as a nonkey field for a flow record, use the collect connection delay application command in flow record configuration mode. To disable the use of one of the connection application delay field as a nonkey field for a flow record, use the no form of this command. Syntax Description
Command DefaultThe connection application delay fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection delay networkTo configure one of the connection network delay fields as a nonkey field for a flow record, use the collect connection delay network command in flow record configuration mode. To disable the use of one of the connection network delay field as a nonkey field for a flow record, use the no form of this command.
collect
connection
delay
network {{client-to-server | to-client | to-server}}
{{sum | min | max}}
no
collect
connection
delay
network{{client-to-server | to-client | to-server}}
Syntax Description
Command DefaultThe connection network delay fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection delay responseTo configure one of the connection response delay fields as a nonkey field for a flow record, use the collect connection delay response command in flow record configuration mode. To disable the use of one of the connection response delay fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
delay
response {{client-to-server{{sum | min | max}} | to-server{{sum | min | max}} | to-server histogram{{bucket1 | bucket2 | bucket3 | bucket4 | bucket5 | bucket6 | bucket7 | late}}}}
no
collect
connection
delay
response{{client-to-server | to-server | to-server histogram}}
Syntax Description
Command DefaultThe connection response delay fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection performance application-delayTo configure one of the connection performance application-delay fields as a nonkey field for a flow record, use the collect connection performance application-delay command in flow record configuration mode. To disable the use of one of the application-delay fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
performance
application-delay {{max | min | sum}}
no
collect
connection
performance
application-delay
Command DefaultThe connection performance application-delay field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection performance initiatorTo configure one of the connection performance initiator fields as a nonkey field for a flow record, use the collect connection performance initiator command in flow record configuration mode. To disable the use of one of the application media field as a nonkey field for a flow record, use the no form of this command.
collect
connection
performance
initiator {bytes long | count late-responses | network-delay {{max | min | sum}} | packets long}
no
collect
connection
performance
initiator{bytes | count | network-delay | packets}
Syntax Description
Command DefaultThe connection performance initiator field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the field that counts the total number of late responses collected from the initiator, as a nonkey field: Router(config)# flow record type performance-monitor PM-RECORD-4 Router(config-flow-record)# collect connection performance initiator count late-responses collect connection performance network-delayTo configure one of the connection performance network-delay fields as a nonkey field for a flow record, use the collect connection performance network-delay command in flow record configuration mode. To disable the use of one of the performance network-delay fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
performance
network-delay {{max | min | sum}}
no
collect
connection
performance
network-delay
Command DefaultThe connection performance network-delay field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection performance new-transactionTo configure one of the connection performance new-transaction fields as a nonkey field for a flow record, use the collect connection performance new-transaction command in flow record configuration mode. To disable the use of one of the performance new-transaction fields as a nonkey field for a flow record, use the no form of this command. Command DefaultThe connection performance new-transaction field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection performance responderTo configure one of the connection performance responder fields as a nonkey field for a flow record, use the collect connection performance responder command in flow record configuration mode. To disable the use of one of the application media field as a nonkey field for a flow record, use the no form of this command.
collect
connection
performance
responder {bytes long | count {histogram{{bucket1 | bucket2 | bucket3 | bucket4
| bucket5 | bucket6 | bucket7}} | late-responses | responses} | network-delay {{max | min | sum}} | packets long | response-time {{sum | min | max}}}
no
collect
connection
performance
responder{bytes | count | network-delay | packets | response-time}
Syntax Description
Command DefaultThe connection performance responder field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the field that counts the total number of late responses collected from the responder, as a nonkey field: Router(config)# flow record type performance-monitor PM-RECORD-4 Router(config-flow-record)# collect connection performance responder count late-responses collect connection performance total-delayTo configure one of the connection performance total-delay fields as a nonkey field for a flow record, use the collect connection performance total-delay command in flow record configuration mode. To disable the use of one of the performance total-delay fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
performance
total-delay {{max | min | sum}}
no
collect
connection
performance
total-delay
Command DefaultThe connection performance total-delay field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection performance total-transaction-timeTo configure one of the connection performance total-transaction-time fields as a nonkey field for a flow record, use the collect connection performance total-transaction-time command in flow record configuration mode. To disable the use of one of the performance total-transaction-time fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
performance
total-transaction-time {{max | min | sum}}
no
collect
connection
performance
total-transaction-time
Command DefaultThe connection performance total-transaction-time field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection serverTo configure one of the connection server fields as a nonkey field for a flow record, use the collect connection server command in flow record configuration mode. To disable the use of one of the connection server fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
server {counter{{bytes long | packets long | packets retransmitted}} | {{ipv4 | ipv6}}address | transport port}
no
collect
connection
server {counter{{bytes long | packets long | packets retransmitted}} | {{ipv4 | ipv6}}address | transport port}
Syntax Description
Command DefaultThe connection server fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect connection transactionTo configure one of the connection transaction fields as a nonkey field for a flow record, use the collect connection delay application command in flow record configuration mode. To disable the use of one of the connection transaction fields as a nonkey field for a flow record, use the no form of this command.
collect
connection
transaction{counter complete | duration{{sum | min | max}}}
no
collect
connection
transaction{{counter complete | duration{{sum | min | max}}}}
Syntax Description
Command DefaultThe connection transaction duration fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect counterTo configure the number of bytes or packets in a flow as a nonkey field for a Flexible NetFlow flow record, use the collect counter command in Flexible NetFlow flow record configuration mode. To disable the use of the number of bytes or packets in a flow (counters) as a nonkey field for a Flexible NetFlow flow record, use the no form of this command.
collect
counter
{bytes [long | replicated [long] | squared long] | packets [long | replicated [long] ]}
no
collect
counter
{bytes [long | replicated [long] | squared long] | packets [long | replicated [long] ]}
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE
collect
counter
{bytes [long | rate] | packets [dropped [long] | long]}
no
collect
counter
{bytes [long | rate] | packets [dropped [long] | long]}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE The rate and droppedkeywords were added and the replicated and squared longkeywords are not available. You must first enter the flow record type performance-monitor command. collect counter bytes This command configures a 32-bit counter for the number of bytes seen in a flow. collect counter packets This command configures a 32-bit counter that is incremented for each packet seen in the flow. For extremely long flows it is possible for this counter to restart at 0 (wrap) when it reaches the limit of approximately 4 billion packets. On detection of a situation that would cause this counter to restart at 0, a flow monitor with a normal cache type exports the flow and starts a new flow. collect counter packets long This command configures a 64-bit counter that will be incremented for each packet seen in the flow. It is unlikely that a 64-bit counter will ever restart at 0. collect counter bytes squared long This counter can be used in conjunction with the byte and packet counters in order to calculate the variance of the packet sizes. Its value is derived from squaring each of the packet sizes in the flow and adding the results. This value can be used as part of a standard variance function. The variance and standard deviation of the packet sizes for the flow can be calculated with the following formulas: cbs: value from the counter bytes squared field pkts: value from the counter packets field bytes: value from the counter bytes field Variance = (cbs/pkts) - (bytes/pkts)2 Standard deviation = square root of Variance Example 1: Packet sizes of the flow: 100, 100, 100, 100 Counter packets: 4 Counter bytes: 400, mean packet size = 100 Counter bytes squared: 40,000 Variance = (40,000/4) - (400/4)2 = 0 Standard Deviation = 0 Size = 100 +/- 0 Example 2: Packet sizes of the flow: 50, 150, 50, 150 Counter packets: 4 Counter bytes: 400, mean packet size = 100 Counter bytes squared: 50,000 Variance = (50,000/4) - (400/4)2 = 2500 Standard deviation = 50 Size = 100 +/- 50 ExamplesThe following example configures the total number of bytes in the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect counter bytes The following example configures the total number of bytes in the flows as a nonkey field using a 64-bit counter: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect counter bytes long The following example configures the sum of the number of bytes of each packet in the flow squared as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect counter bytes squared long The following example configures the total number of packets from the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect counter packets The following example configures the total number of packets from the flows as a nonkey field using a 64-bit counter: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect counter packets long Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SEThe following example configuresthe total number of packets from the flows as a nonkey field using a 64-bit counter: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect counter packets long collect datalink destination-vlan-idTo configure the use of destination VLAN ID as a nonkey field for a flow record, use the collectdatalinkdestination-vlan-id command in flow record configuration mode. To disable the use of destination VLAN ID as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. The collectcommands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect datalink macTo configure the use of MAC addresses as a nonkey field for a Flexible NetFlow flow record, use the collectdatalinkmac command in Flexible NetFlow flow record configuration mode. To disable the use of Layer 2 MAC addresses as a non-key field for a Flexible NetFlow flow record, use the no form of this command.
collect datalink mac
{destination | source}
address
{input | output}
no collect datalink mac
{destination | source}
address
{input | output}
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitorcommand before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. The input and output keywords of the collectdatalinkmac command are used to specify the observation point that is used by the collectdatalinkmac command to capture the MAC addressees from network traffic. For example, when you configure a flow record with the collectdatalinkmacdestinationaddressinputcommand to monitor the simulated denial of service (DoS) attack in the figure below and apply the flow monitor to which the flow record is assigned in either input (ingress) mode on interface Ethernet 0/0.1 on R3 or output (egress) mode on interface Ethernet 1/0.1 on R3, the observation point is always Ethernet 0/0.1 on R3. The destination MAC address that is collected is aaaa.bbbb.cc04. When the destination output mac address is configured, the value is the destination mac address of the output packet, even if the monitor the flow record is applied to is input only. When the destination input mac address is configured, the value is the destination mac address of the input packet, even if the monitor the flow record is applied to is output only. When the source output mac address is configured, the value is the source mac address of the output packet, even if the monitor the flow record is applied to is input only. When the source input mac address is configured, the value is the source mac address of the input packet, even if the monitor the flow record is applied to is output only. ExamplesThe following example configures the use of the destination MAC address of packets that are received by the router as a nonkey field for a Flexible NetFlow flow record: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect datalink mac destination address input The following example configures the use of the source MAC addresses of packets that are transmitted by the router as a nonkey field for a Flexible NetFlow flow record: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect datalink mac source address output Cisco Performance Monitor in Cisco IOS Release 15.2(2)TThe following example configures the use of the source MAC addresses of packets that are transmitted by the router as a nonkey field for a Performance Monitor flow record: : Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect datalink mac source address output collect datalink source-vlan-idTo configure the use of source VLAN ID as a nonkey field for a flow record, use the collectdatalinksource-vlan-id command in flow record configuration mode. To disable the use of source VLAN ID as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. The collectcommands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect datalink vlanTo configure the use of VLAN as a nonkey field for a flow record, use the collectdatalinkvlan command in flow record configuration mode. To disable the use of VLAN as a nonkey field for a flow record, use the no form of this command. Command History
Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. The input and output keywords are used to specify the observation point that is used by the collectdatalinkvlan command to capture the VLAN from network traffic. collect flowTo configure the flow direction, the flow sampler ID number, or reason why the flow ended as a nonkey field for a flow record, use the collect flow command in flow record configuration mode. To disable the use of the flow direction and the flow sampler ID number as a nonkey field for a flow record, use the no form of this command.
collect
flow
{direction | sampler | class | qos-class}
no
collect
flow
{direction | sampler | class | qos-class}
Cisco IOS Release 15.1(4)M1
collect
flow
direction
no
collect
flow
direction
Syntax Description
Command DefaultThe flow direction and the flow sampler ID number are not configured as nonkey fields. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect flow direction This field indicates the direction of the flow. This is of most use when a single flow monitor is configured for input and output flows. It can be used to find and eliminate flows that are being monitored twice, once on input and once on output. This field may also be used to match up pairs of flows in the exported data when the two flows are flowing in opposite directions. collect flow sampler This field contains the ID of the flow sampler used to monitor the flow. This is useful when more than one flow sampler is being used with different sampling rates. The flow exporter option sampler-table command exports options records with mappings of the flow sampler ID to sampling rate so the collector can calculate the scaled counters for each flow. ExamplesThe following example configures the ID of the flow sampler that is assigned to the flow as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect flow sampler collect interfaceTo configure the input and output interface as a nonkey field for a flow record, use the collect interface command in flow record configuration mode. To disable the use of the input and output interface as a nonkey field for a flow record, use the no form of this command. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE You must first enter the flow record type performance-monitor command. ExamplesThe following example configures the input interface as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect interface input The following example configures the output interface as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect interface output collect ipv4To configure one or more of the IPv4 fields as a nonkey field for a flow record, use the collect ipv4 command in flow record configuration mode. To disable the use of one or more of the IPv4 fields as a nonkey field for a flow record, use the no form of this command.
collect
ipv4
{dscp | header-length | id | option map | precedence | protocol | tos | version}
no
collect
ipv4
{dscp | header-length | id | option map | precedence | protocol | tos | version}
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE
collect
ipv4
dscp
no
collect
ipv4
dscp
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow.
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE Only the the dscp keyword is available. You must first enter the flow record type performance-monitor command. ExamplesThe following example configures the DSCP field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 dscp collect ipv4 destinationTo configure the IPv4 destination address as a nonkey field for a flow record, use the collect ipv4 destination command in flow record configuration mode. To disable the use of an IPv4 destination address field as a nonkey field for a flow record, use the no form of this command.
collect
ipv4
destination
{address | {mask | prefix} [minimum-mask mask]}
no
collect
ipv4
destination
{address | {mask | prefix} [minimum-mask mask]}
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE
collect ipv4 destination mask
[minimum-mask mask]
no collect ipv4 destination mask
[minimum-mask mask]
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE Only the maskand minimum-maskkeywords are available. You must first enter the flow record type performance-monitor command. ExamplesThe following example configures the IPv4 destination address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 destination prefix minimum-mask 16 Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SEThe following example configures the IPv4 destination address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv4 destination prefix minimum-mask 16 collect ipv4 fragmentationTo configure the IPv4 fragmentation flags and the IPv4 fragmentation offset as a nonkey field for a flow record, use the collect ipv4 fragmentation command in flow record configuration mode. To disable the use of the IPv4 fragmentation flags and the IPv4 fragmentation offset as a nonkey field for a flow record, use the no form of this command. Syntax Description
Command DefaultThe IPv4 fragmentation flags and the IPv4 fragmentation offset are not configured as nonkey fields. Command History
Usage GuidelinesThe Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect ipv4 fragmentation flags This field collects the "don't fragment" and "more fragments" flags. Bit 0: reserved, must be zero. Bit 1: (DF) 0 = May Fragment, 1 = Don't Fragment Bit 2: (MF) 0 = Last Fragment, 1 = More Fragments Bits 3-7: (DC) Don't Care, value is irrelevant
0 1 2 3 4 5 6 7
+---+---+---+---+---+---+---+---+
| | D | M | D | D | D | D | D |
| 0 | F | F | C | C | C | C | C |
+---+---+---+---+---+---+---+---+
For more information on IPv4 fragmentation flags, see RFC 791 Internet Protocol at the following URL: http://www.ietf.org/rfc/rfc791.txt . ExamplesThe following example configures the IPv4 fragmentation flags as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 fragmentation flags collect ipv4 initiatorTo configure one or more of the IPv4 initiator address field as a nonkey field for a flow record, use the collect ipv4 initiator command in flow record configuration mode. To disable the use of one or more of the IPv4 initiator address field as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect ipv4 responderTo configure one or more of the IPv4 responder address field as a nonkey field for a flow record, use the collect ipv4 responder command in flow record configuration mode. To disable the use of one or more of the IPv4 responder address field as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect ipv4 sectionTo configure a section of an IPv4 packet as a nonkey field for a flow record, use the collect ipv4 section command in flow record configuration mode. To disable the use of a section of an IPv4 packet as a nonkey field for a flow record, use the no form of this command.
collect
ipv4
section
{header size header-size | payload size payload-size}
no
collect
ipv4
section
{header size header-size | payload size payload-size}
Syntax Description
Command History
Usage GuidelinesThe Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. It is recommended that you configure both header size and payload size so that you know how much data is going to be captured. collect ipv4 section header This command causes the first IPv4 header to be copied into the flow record for this flow. Only the configured size in bytes will be copied and part of the payload will also be captured if the configured size is larger than the size of the header.
collect ipv4 section payload This command results in a copy of the first IPv4 payload being put into the flow record for this flow. Only the configured size in bytes will be copied and may end in a series of 0's if the configured size is greater than the size of the payload.
ExamplesThe following example configures the first eight bytes from the IP header of the packets in the flows as a non-key field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 section header size 8 The following example configures the first 16 bytes from the payload of the packets in the flows as a non-key field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 section payload size 16 Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the first 16 bytes from the payload of the packets in the flows as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv4 section payload size 16 collect ipv4 sourceTo configure the IPv4 source address as a nonkey field for a flow record, use the collect ipv4 source command in flow record configuration mode. To disable the use of the IPv4 source address field as a nonkey field for a flow record, use the no form of this command.
collect
ipv4
source
{address | {mask | prefix} [minimum-mask mask]}
no
collect
ipv4
source
{address | {mask | prefix} [minimum-mask mask]}
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE
collect ipv4 source mask
[minimum-mask mask]
no collect ipv4 source mask
[minimum-mask mask]
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE Only the maskand minimum-maskkeywords are available. You must first enter the flow record type performance-monitor command. collect ipv4 source prefix minimum-mask The source address prefix is the network part of an IPv4 source address. The optional minimum mask allows more information to be gathered about large networks. collect ipv4 source mask minimum-mask The source address mask is the number of bits that make up the network part of the source address. The optional minimum mask allows a minimum value to be configured. This command is useful when there is a minimum mask configured for the source prefix field and the mask is to be used with the prefix. In this case, the values configured for the minimum mask should be the same for the prefix and mask fields. Alternatively, if the collector is aware of the minimum mask configuration of the prefix field, the mask field can be configured without a minimum mask so that the true mask and prefix can be calculated. ExamplesThe following example configures the IPv4 source address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 source prefix minimum-mask 16 Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SEThe following example configures the IPv4 source address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv4 source prefix minimum-mask 16 collect ipv4 total-lengthTo configure the IPv4 total-length field as a nonkey field for a flow record, use the collect ipv4 total-length command in flow record configuration mode. To disable the use of the IPv4 total-length field as a nonkey field for a flow record, use the no form of this command. Syntax Description
Command History
Usage GuidelinesThe Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect ipv4 total-length [minimum | maximum] This command is used to collect the lowest and highest IPv4 total length values seen in the lifetime of the flow. Configuring this command results in more processing than is needed to simply collect the first total length value seen using the collect ipv4 total-length command. ExamplesThe following example configures total-length value as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 total-length The following example configures minimum total-length value seen in the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 total-length minimum collect ipv4 ttlTo configure the IPv4 time-to-live (TTL) field as a nonkey field for a flow record, use the collect ipv4 ttl command in flow record configuration mode. To disable the use of the IPv4 TTL field as a nonkey field for a flow record, use the no form of this command. Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE You must first enter the flow record type performance-monitor command. collect ipv4 ttl [minimum | maximum] This command is used to collect the lowest and highest IPv4 TTL values seen in the lifetime of the flow. Configuring this command results in more processing than is needed to simply collect the first TTL value seen using the collect ipv4 ttl command. ExamplesThe following example configures the largest value for IPv4 TTL seen in the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 ttl maximum The following example configures the smallest value for IPv4 TTL seen in the flows as a nonkey field Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv4 ttl minimum collect ipv6To configure one or more of the IPv6 fields as a nonkey field for a flow record, use the collect ipv6 command in flow record configuration mode. To disable the use of one or more of the IPv6 fields as a nonkey field for a flow record, use the no form of this command.
collect
ipv6
{dscp | flow-label | next-header | payload-length | precedence | protocol | traffic-class | version}
no
collect
ipv6
{dscp | flow-label | next-header | payload-length | precedence | protocol | traffic-class | version}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow.
ExamplesThe following example configures the IPv6 DSCP field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 dscp collect ipv6 destinationTo configure the IPv6 destination address as a nonkey field for a flow record, use the collect ipv6 destination command in flow record configuration mode. To disable the use of an IPv6 destination address field as a nonkey field for a flow record, use the no form of this command.
collect
ipv6
destination
{address | {mask | prefix} [minimum-mask mask]}
no
collect
ipv6
destination
{address | {mask | prefix} [minimum-mask mask]}
Command Syntax on Cisco Catalyst 6500 Switches running Cisco IOS Release 12.2(50)SY
collect
ipv6
destination
{mask | prefix}
no
collect
ipv6
destination
{mask | prefix}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the IPv6 destination address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 destination prefix minimum-mask 16 Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the IPv6 destination address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv6 destination prefix minimum-mask 16 collect ipv6 extension mapTo configure the bitmap of the IPv6 extension header map as a nonkey field for a flow record, use the collect ipv6 extension map command in flow record configuration mode. To disable the use of the IPv6 bitmap of IPv6 extension header map as a nonkey field for a flow record, use the no form of this command. Command DefaultThe use of the bitmap of the IPv6 extension header map is not configured as a nonkey field. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Bitmap of the IPv6 Extension Header Map The bitmap of IPv6 extension header map is made up of 32 bits.
0 1 2 3 4 5 6 7
+-----+-----+-----+-----+-----+-----+-----+-----+
| Res | FRA1| RH | FRA0| UNK | Res | HOP | DST |
+-----+-----+-----+-----+-----+-----+-----+-----+
8 9 10 11 12 13 14 15
+-----+-----+-----+-----+-----+-----+-----+-----+
| PAY | AH | ESP | Reserved |
+-----+-----+-----+-----+-----+-----+-----+-----+
16 17 18 19 20 21 22 23
+-----+-----+-----+-----+-----+-----+-----+-----+
| Reserved |
+-----+-----+-----+-----+-----+-----+-----+-----+
24 25 26 27 28 29 30 31
+-----+-----+-----+-----+-----+-----+-----+-----+
| Reserved |
+-----+-----+-----+-----+-----+-----+-----+-----+
0 Res Reserved
1 FRA1 Fragmentation header - not first fragment
2 RH Routing header
3 FRA0 Fragment header - first fragment
4 UNK Unknown Layer 4 header
(compressed, encrypted, not supported)
5 Res Reserved
6 HOP Hop-by-hop option header
7 DST Destination option header
8 PAY Payload compression header
9 AH Authentication Header
10 ESP Encrypted security payload
11 to 31 Reserved
For more information on IPv6 headers, refer to RFC 2460 Internet Protocol, Version 6 (IPv6) at the following URL: http://www.ietf.org/rfc/rfc2460.txt . ExamplesThe following example configures the bitmap of IPv6 extension header map as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 extension map collect ipv6 fragmentationTo configure one or more of the IPv6 fragmentation fields as a nonkey field for a flow record, use the collect ipv6 fragmentation command in flow record configuration mode. To disable the use one or more of the IPv6 fragmentation fields as a nonkey field for a flow record, use the no form of this command.
collect
ipv6
fragmentation
{flags | id | offset}
no
collect
ipv6
fragmentation
{flags | id | offset}
Syntax Description
Command DefaultThe use of one or more of the IPv6 fragmentation fields is not configured as a nonkey field. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the IPv6 fragmentation flags field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 fragmentation flags collect ipv6 hop-limitTo configure the IPv6 hop limit as a nonkey field for a flow record, use the collect ipv6 hop-limit command in flow record configuration mode. To disable the use of the IPv6 hop limit field as a nonkey field for a flow record, use the no form of this command. Syntax Description
Command History
Usage Guidelinescollect ipv6 hop-limit [minimum | maximum] This command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. This command is used to collect the lowest and highest IPv6 hop limit values seen in the lifetime of the flow. Configuring this command results in more processing than is needed to simply collect the first hop limit value seen using the collect ipv6 hop-limit command. ExamplesThe following example configures the IPv6 maximum hop limit from the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 hop-limit maximum collect ipv6 initiatorTo configure one or more of the IPv6 initiator address field as a nonkey field for a flow record, use the collect ipv6 initiator command in flow record configuration mode. To disable the use of one or more of the IPv6 initiator address field as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the IPv6 initiator address field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 initiator address collect ipv6 lengthTo configure one or more of the IPv6 length fields as a nonkey field for a flow record, use the collect ipv6 lengthcommand in flow record configuration mode. To disable the use of one or more of the IPv6 length fields as a nonkey field for a flow record, use the no form of this command.
collect
ipv6
length
{header | payload | total [maximum] [minimum] }
no
collect
ipv6
length
{header | payload | total [maximum] [minimum] }
Syntax Description
Command History
Usage Guidelinescollect ipv6 length [minimum | maximum] This command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. This command is used to collect the lowest and highest IPv6 length values seen in the lifetime of the flow. Configuring this command results in more processing than is needed to simply collect the length value seen using the collect ipv6 length command. ExamplesThe following example configures the length of the IPv6 header, not including any extension headers, in bytes as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 length header Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the length of the IPv6 header, not including any extension headers, in bytes as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv6 length header collect ipv6 responderTo configure one or more of the IPv6 responder address field as a nonkey field for a flow record, use the collect ipv6 responder command in flow record configuration mode. To disable the use of one or more of the IPv6 responder address field as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect ipv6 sectionTo configure a section of an IPv6 packet as a nonkey field for a flow record, use the collect ipv6 section command in flow record configuration mode. To disable the use of a section of an IPv6 packet as a nonkey field for a flow record, use the no form of this command.
collect
ipv6
section
{header size header-size | payload size payload-size}
no
collect
ipv6
section
{header size header-size | payload size payload-size}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. It is recommended that you configure both header size and payload size so that you know how much data is going to be captured.
collect ipv6 section header This command causes a copy of the first IPv6 header to be put into the flow record for this flow. Only the configured size in bytes will be copied, and part of the payload will also be captured if the configured size is larger than the size of the header.
collect ipv6 section payload This command causes a copy of the first IPv6 payload to be put into the flow record for this flow. Only the configured size in bytes will be copied, and it may end in a series of zeros if the configured size is smaller than the size of the payload.
ExamplesThe following example configures the first eight bytes from the IPv6 header of the packets in the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 section header size 8 The following example configures the first 16 bytes from the payload of the IPv6 packets in the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 section payload size 16 Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the first 16 bytes from the payload of the IPv6 packets in the flows as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv6 section payload size 16 collect ipv6 sourceTo configure the IPv6 source address as a nonkey field for a flow record, use the collect ipv6 source command in flow record configuration mode. To disable the use of the IPv6 source address field as a nonkey field for a flow record, use the no form of this command.
collect
ipv6
source
{address | {mask | prefix} [minimum-mask mask]}
no
collect
ipv6
source
{address | {mask | prefix} [minimum-mask mask]}
Cisco Catalyst 6500 Switches in Cisco IOS Release 12.2(50)SY
collect
ipv6
source
{mask | prefix}
no
collect
ipv6
source
{mask | prefix}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect IPv6 source prefix minimum mask The source address prefix field is the network part of the source address. The optional minimum mask allows more information to be gathered about large networks. collect IPv6 source mask minimum mask The source address mask is the number of bits that make up the network part of the source address. The optional minimum mask allows a minimum value to be configured. This command is useful when there is a minimum mask configured for the source prefix field and the mask is to be used with the prefix. In this case, the values configured for the minimum mask should be the same for the prefix and mask fields. Alternatively, if the collector is aware of the minimum mask configuration of the prefix field, the mask field can be configured without a minimum mask so that the true mask and prefix can be calculated. ExamplesThe following example configures the IPv6 source address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect ipv6 source prefix minimum-mask 16 Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the IPv6 source address prefix from the flows that have a prefix of 16 bits as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect ipv6 source prefix minimum-mask 16 collect metadataTo configure one or more of the metadata fields as a nonkey field for a flow record, use the collect metadata command in flow record configuration mode. To disable the use the metadata fields as a key field for a flow record, use the no form of this command.
collect
metadata
{global-session-id | multi-party-session-id}
no collect
metadata
{global-session-id | multi-party-session-id}
Syntax Description
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the global session ID of an end-to-end flow as a nonkey field for Flexible Netflow: Router(config)# flow record RECORD-1 Router(config-flow-record)# collect metadata global-session-id Cisco Performance Monitor in Cisco IOS Release 15.2(2)S and 15.2(3)TThe following example configures the global session ID of an end-to-end flow as a nonkey field for Performance Monitor: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect metadata global-session-id collect monitor eventTo configure the monitor event field as a nonkey field for a flow record, use the collect monitor event command in flow record configuration mode. To disable the use of a monitor event field as a nonkey field for a flow record, use the no form of this command. Command DefaultThe monitor event field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesMonitor events are recorded using two bits. Bit 1 is not used. Bit 2 indicates that no media application packets were seen, in other words, a Media Stop Event occured. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect policy performance-monitorTo configure the classification hierarchy of the performance monitor policy as a nonkey field for a flow record, use the collect policy performance-monitorcommand in flow record configuration mode. To disable the use of this nonkey field for a flow record, use the no form of this command.
collect
policy
performance-monitor
classification
hierarchy
no
collect
policy
performance-monitor
classification
hierarchy
Command DefaultClassification hierarchy of the performance monitor policy is not configured as a nonkey field. Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. Because the mode prompt is the same for Flexible NetFlow and Performance Monitor, the command mode for both products is referred to as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the use of the classification hierarchy of the performance monitor policy as a nonkey field for a Flexible NetFlow flow record: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect policy performance-monitor classification hierarchy collect routingTo configure one or more of the routing attributes as a nonkey field for a flow record, use the collect routing command in flow record configuration mode. To disable the use of one or more of the routing attributes as a nonkey field for a flow record, use the no form of this command.
collect
routing
{{destination | source} {as [ [4octet] ] [{peer [4-octet]}] | trafficindex} | forwardingstatus | nexthop address {ipv4 | ipv6} [ [bgp] ] | vrf input | vrf output}
no collect
routing
{{destination | source} {as [ [4octet] ] [{peer [4-octet]}] | trafficindex} | forwardingstatus | nexthop address {ipv4 | ipv6} [ [bgp] ] | vrf input | vrf output}
Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE
collect
routing
forwarding-status
[reason]
no
collect
routing
forwarding-status
[reason]
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode. For Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. Here we refer to them both as flow record configuration mode. The Flexible NetFlow and Performance Monitor collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SE The reason keywordwas added and only the forwarding-statu s keyword is available. You must first enter the flow record type performance-monitor command. collect routing source as [peer] This command collects the 16-bit autonomous system number based on a lookup of the router's routing table using the source IP address. The optional peer keyword provides the expected next network, as opposed to the originating network. collect routing source as 4-octet [peer 4-octet] This command collects the 32-bit autonomous system number based on a lookup of the router's routing table using the source IP address. The optional peer keyword provides the expected next network, as opposed to the originating network. collect routing destination as [peer] This command collects the 16-bit autonomous system number based on a lookup of the router's routing table using the destination IP address. The optional peer keyword provides the expected next network as opposed to the destination network. collect routing destination as 4-octet [peer 4-octet] This command collects the 32-bit autonomous system number based on a lookup of the router's routing table using the destination IP address. The peer keyword will provide the expected next network as opposed to the destination network. collect routing destination traffic-index This command collects the traffic-index field based on the destination autonomous system for this flow. The traffic-index field is a value propagated through BGP. This command is not supported for IPv6. collect routing source traffic-index This command collects the traffic-index field based on the source autonomous system for this flow. The traffic-index field is a value propagated through BGP. This command is not supported for IPv6. collect routing forwarding-status This command collects a field to indicate if the packets were successfully forwarded. The field is in two parts and may be up to 4 bytes in length. For the releases specified in the Command History table, only the status field is used:
+-+-+-+-+-+-+-+-+
| S | Reason |
| t | codes |
| a | or |
| t | flags |
| u | |
| s | |
+-+-+-+-+-+-+-+-+
0 1 2 3 4 5 6 7
Status:
00b=Unknown, 01b = Forwarded, 10b = Dropped, 11b = Consumed
collect routing vrf input This command collects the VRF ID from incoming packets on a router. In the case where VRFs are associated with an interface via methods such as VRF Selection Using Policy Based Routing/Source IP Address, a VRF ID of 0 will be recorded. If a packet arrives on an interface that does not belong to a VRF, a VRF ID of 0 is recorded. ExamplesThe following example configures the 16-bit autonomous system number based on a lookup of the router's routing table using the source IP address as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing source as The following example configures the 16-bit autonomous system number based on a lookup of the router's routing table using the destination IP address as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing destination as The following example configures the value in the traffic-index field based on the source autonomous system for a flow as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing source traffic-index The following example configures the forwarding status as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing forwarding-status The following example configures the VRF ID for incoming packets as a nonkey field for a Flexible NetFlow flow record: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing vrf input Cisco Performance Monitor in Cisco IOS Release 15.1(3)T and 12.2(58)SEThe following example configures the forwarding status as a nonkey field for a Performance Monitor flow record: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect routing forwarding-status reason collect routing is-multicastTo configure the use of the is-multicast field (indicating that the IPv4 traffic is multicast traffic) as a nonkey field, use the collect routing is-multicastcommand in flow record configuration mode. To disable the use of the is-multicast field as a nonkey field for a flow record, use the no form of this command. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the is-multicast field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing is-multicast collect routing multicast replication-factorTo configure the multicast replication factor value for IPv4 traffic as a nonkey field for a flow record, use the collect routing multicast replication-factorcommand in flow record configuration mode. To disable the use of the multicast replication factor value as a nonkey field for a flow record, use the no form of this command. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. When the replication-factor field is used in a flow record, it will only have a non-zero value in the cache for ingress multicast traffic that is forwarded by the router. If the flow record is used with a flow monitor in output (egress) mode or to monitor unicast traffic or both, the cache data for the replication factor field is set to 0. ExamplesThe following example configures the multicast replication factor value as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect routing multicast replication-factor collect services waasTo configure one of the WAAS services fields as a nonkey field for a flow record, use the collect services wascommand in flow record configuration mode. To disable the use of this nonkey field for a flow record, use the no form of this command.
collect
services
waas
{segment | passthrough-reason}
no
collect
services
waas
{segment | passthrough-reason}
Usage GuidelinesYou must first enter the flow record type performance-monitorcommand before you can use this command. This command cannot be used with Flexible NetFlow. Because the mode prompt is the same for Flexible NetFlow and Performance Monitor, the command mode for both products is referred to as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect timestamp absoluteTo configure one of the absolute timestamp fields as a nonkey field for a flow record, use the collect timestamp absolute command in flow record configuration mode. To disable the use of one of the absolute timestamp fields as a nonkey field for a flow record, use the no form of this command. Command DefaultThe absolute timestamp fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect timestamp intervalTo configure the start time of the monitoring interval as a nonkey field for a flow record, use the collect timestamp interval command in flow record configuration mode. To disable the use of the start time of the monitoring interval as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect timestamp sys-uptimeTo configure the system uptime of the first seen or last seen packet in a flow as a nonkey field for a flow record, use the collect timestamp sys-uptime command in flow record configuration mode. To disable the use of the first seen or last seen packet in a flow as a nonkey field for a flow record, use the no form of this command. Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures time stamps based on the system uptime for the time the first packet was seen from the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect timestamp sys-uptime first The following example configures the time stamps based on the system uptime for the time the most recent packet was seen from the flows as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect timestamp sys-uptime last Cisco Performance Monitor in Cisco IOS Release 15.2(2)T and XE 3.5SThe following example configures the time stamps based on the system uptime for the time the most recent packet was seen from the flows as a nonkey field: Router(config)# flow record type performance-monitor RECORD-1 Router(config-flow-record)# collect timestamp sys-uptime last collect transportTo configure one or more of the transport layer fields as a nonkey field for a flow record, use the collect transport command in flow record configuration mode. To disable the use of one or more of the transport layer fields as a nonkey field for a flow record, use the no form of this command.
collect
transport
{destination-port | igmp type | source-port}
no
collect
transport
{destination-port | igmp type | source-port}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the transport destination port as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport destination-port The following example configures the transport source port as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport source-port collect transport event packet-loss counterTo configure the event packet-loss counter field as a nonkey field for a flow record, use the collect transport event packet-loss countercommand in flow record configuration mode. To disable the use of the event packet-loss counter field as a nonkey field for a flow record, use the no form of this command. Command DefaultThe event packet-loss counter field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe event packet-loss counter is incremented when a lost RTP packet is detected. However, the counter is also incremented when a reorder occurs, in other words, when packets are received out of order. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect transport icmp ipv4To configure the internet control message protocol (ICMP) IPv4 type field and the code field as nonkey fields for a flow record, use the collect transport icmp ipv4 command in flow record configuration mode. To disable the use of the ICMP IPv4 type field and code field as nonkey fields for a flow record, use the no form of this command. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the ICMP IPv4 code field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport icmp ipv4 code The following example configures the ICMP IPv4 type field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport icmp ipv4 type collect transport icmp ipv6To configure the Internet Control Message Protocol (ICMP) IPv6 type field and code field as nonkey fields for a flow record, use the collect transport icmp ipv6 command in flow record configuration mode. To disable the use of the ICMP IPv6 type field and code field as nonkey fields for a flow record, use the no form of this command. Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the ICMP IPv6 code field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport icmp ipv6 code The following example configures the ICMP IPv6 type field as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport icmp ipv6 type collect transport initiator portTo configure one or more of the transport initiator port field as a nonkey field for a flow record, use the collect transport initiator port command in flow record configuration mode. To disable the use of one or more of the transport initiator port field as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect transport packetsTo configure various packet fields as a nonkey field for a flow record, use the collect transport packetscommand in flow record configuration mode. To disable the use of a packet field as a nonkey field for a flow record, use the no form of this command.
collect
transport
packets
{lost counter | lost rate | expected counter | out-of-order | round-trip-time}
no
collect
transport
packets
{lost counter | lost rate | expected counter | out-of-order | round-trip-time}
Syntax Description
Command DefaultThe packet fields are not configured as a nonkey field for a user-defined flow record. Usage GuidelinesYou can retrieve different transport packet counters for RTP and TCP. The following transport packet counters as available:
The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect transport responder portTo configure the transport responder port field as a nonkey field for a flow record, use the collect transport responder port command in flow record configuration mode. To disable the use of the transport responder port field as a nonkey field for a flow record, use the no form of this command. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect transport rtp jitterTo configure one of the RTP jitter fields as a nonkey field for a flow record, use the collect transport rtp jittercommand in flow record configuration mode. To disable the use of a jitter field as a nonkey field for a flow record, use the no form of this command.
collect
transport
rtp
jitter
{mean | maximum | minimum}
no
collect
transport
rtp
jitter
{mean | maximum | minimum}
Command DefaultThe RTP jitter field is not configured as a nonkey field for a user-defined flow record. Usage GuidelinesThe collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect transport tcpTo configure one or more of the TCP fields as a nonkey field for a flow record, use the collect transport tcp command in flow record configuration mode. To disable the use of one or more of the TCP fields as a nonkey field for a flow record, use the no form of this command.
collect
transport
tcp
{acknowledgement-number | destination-port | flags [ack | cwr | ece | fin | psh | rst | syn | urg] | header-length | maximum-segment-size | sequence-number | source-port | urgent-pointer | window-size | window-size-average | window-size-maximum | window-size-minimum}
no
collect
transport
tcp
{acknowledgement-number | destination-port | flags [ack | cwr | ece | fin | psh | rst | syn | urg] | header-length | maximum-segment-size | sequence-number | source-port | urgent-pointer | window-size | window-size-average | window-size-maximum | window-size-minimum}
Cisco Catalyst 6500 Switches in Cisco IOS Release 12.2(50)SY
collect
transport
tcp
flags
[ack | cwr | ece | fin | psh | rst | syn | urg]
no
collect
transport
tcp
flags
[ack | cwr | ece | fin | psh | rst | syn | urg]
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. collect transport tcp flags ece For more information about ECN echo, refer to RFC 3168 The Addition of Explicit Congestion Notification (ECN) to IP , at the following URL: http://www.ietf.org/rfc/rfc3168.txt . ExamplesThe following example configures the TCP acknowledgment number as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport tcp acknowledgement-number The following example configures the TCP source port as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport tcp source-port The following example configures the TCP acknowledgment flag as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport tcp flags ack The following example configures the TCP finish flag as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport tcp flags fin The following example configures the TCP reset flag as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport tcp flags rst collect transport udpTo configure one or more of the user datagram protocol UDP fields as a nonkey field for a flow record, use the collect transport udp command in flow record configuration mode. To disable the use of one or more of the UDP fields as a nonkey field for a flow record, use the no form of this command.
collect transport udp
{destination-port | message-length | source-port}
no collect transport udp
{destination-port | message-length | source-port}
Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. These products use different commands to enter the configuration mode in which you issue this command, however the mode prompt is the same for both products. For Performance Monitor, you must first enter the flow record type performance-monitor command before you can use this command. Because the mode prompt is the same for both products, here we refer to the command mode for both products as flow record configuration mode. However, for Flexible NetFlow, the mode is also known as Flexible NetFlow flow record configuration mode; and for Performance Monitor, the mode is also known as Performance Monitor flow record configuration mode. The Flexible NetFlow collect commands are used to configure nonkey fields for the flow monitor record and to enable capturing the values in the fields for the flow created with the record. The values in nonkey fields are added to flows to provide additional information about the traffic in the flows. A change in the value of a nonkey field does not create a new flow. In most cases the values for nonkey fields are taken from only the first packet in the flow. ExamplesThe following example configures the UDP destination port as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport udp destination-port The following example configures the UDP message length as a nonkey field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport udp message-length The following example configures the UDP source port as a non-key field: Router(config)# flow record FLOW-RECORD-1 Router(config-flow-record)# collect transport udp source-port debug fm performance-monitorTo enable the display of debugging information for the Performance Monitor component of Feature Manager, use the debug fm performance-monitorcommand in privileged EXEC mode. To disable debugging output, use the no form of this command.
debug
fm
performance-monitor
{all | dynamic | event | unusual | verbose | vmr}
no
debug
fm
performance-monitor
{all | dynamic | event | unusual | verbose | vmr}
Syntax Description
ExamplesThe following example shows how to enable debugging for dynamic policy configuration.
Router# debug fm performance dynamic
Related Commands
debug performance monitorTo enable debugging for performance monitor, use the debug performance monitorcommand in privileged EXEC mode. To disable debugging, use the no form of this command.
debug
performance
monitor
{database | dynamic | event | export | flow-monitor | metering | provision | sibling | snmp | tca | timer}
no
debug
performance
monitor
{database | dynamic | event | export | flow-monitor | metering | provision | sibling | snmp | tca | timer}
Syntax Description
description (Performance Monitor)To configure a description for a flow exporter, flow record, flow monitor, or policy map use the descriptioncommand in the appropriate configuration mode. To remove the description, use the no form of this command. Command Modes
Usage GuidelinesThe description command is meant solely as a comment to be put in the configuration to help you remember information about the flow exporter, flow record, flow monitor, or policy map, such as which packets are included within the policy map. ExamplesThe following example shows how to configuration a description for a flow record: Router(config)# flow record type performance-monitor Router(config-flow-record)# description collect the number of IPV4 packet dropped Router(config-flow-record)# match ipv4 protocol Router(config-flow-record)# collect counter packets dropped destinationTo configure an export destination for a flow exporter, use the destination command in flow exporter configuration mode. To remove an export destination for a flow exporter, use the no form of this command. Syntax Description
Command History
Usage GuidelinesThis command can be used with both Flexible NetFlow and Performance Monitor. Each flow exporter can have only one destination address or hostname. With Flexible Netflow, you can export to a either an IPv4 or IPv6 address. When you configure a hostname instead of the IP address for the device, the hostname is resolved immediately and the IP address is stored in the running configuration. If the hostname-to-IP-address mapping that was used for the original domain name system (DNS) name resolution changes dynamically on the DNS server, the router does not detect this, and the exported data continues to be sent to the original IP address, resulting in a loss of data. Resolving the hostname immediately is a prerequisite of the export protocol, to ensure that the templates and options arrive before the data ExamplesThe following example shows how to configure the networking device to export the Flexible NetFlow or Performance Monitorcache entry to a destination system using an IPv4 address: Router(config)# flow exporter FLOW-EXPORTER-1 Router(config-flow-exporter)# destination 10.0.0.4 The following example shows how to configure the networking device to export the Flexible NetFlow cache entry to a destination system using an IPv6 address: Router(config)# flow exporter FLOW-EXPORTER-1 Router(config-flow-exporter)# destination 10:0:0:4:4 The following example shows how to configure the networking device to export the Flexible NetFlow or Performance Monitor cache entry to a destination system using a VRF named VRF-1: Router(config)# flow exporter FLOW-EXPORTER-1 Router(config-flow-exporter)# destination 172.16.10.2 vrf VRF-1 dscp (Flexible NetFlow)To configure a differentiated services code point (DSCP) value for flow exporter datagrams, use the dscp command in flow exporter configuration mode. To remove a DSCP value for flow exporter datagrams, use the no form of this command. Command History
export-protocolTo configure the export protocol for a Flexible NetFlow exporter, use the export-protocol command in Flexible NetFlow flow exporter configuration mode. To restore the use of the default export protocol for a Flexible NetFlow exporter, use the no form of this command. Command DefaultNetflow Version 9 export is used as the export protocol for a Flexible NetFlow exporter. Command History
Usage GuidelinesThe NetFlow Version 5 export protocol is supported only for flow monitors that use the Flexible NetFlow predefined records. The export of extracted fields from NBAR is supported only over IPFIX. exporterTo configure a flow exporter for a flow monitor, use the exporter command in the appropriate configuration mode. To remove a flow exporter for a flow monitor, use the no form of this command. Command Modes
Command History
Usage GuidelinesYou must have already created a flow exporter by using the flow exporter command before you can apply the flow exporter to a flow monitor with the exporter command. For Performance Monitor, you can associate a flow exporter with a flow monitor while configuring either a flow monitor, policy map, or service policy. ExamplesThe following example configures an exporter for a flow monitor: Router(config)# flow monitor FLOW-MONITOR-1 Router(config-flow-monitor)# exporter EXPORTER-1 The following example shows one of the ways to configure a flow exporter for Performance Monitor: Router(config)# policy-map type performance-monitor policy-4 Router(config-pmap)# class class-4 Router(config-pmap-c)# flow monitor monitor-4 Router(config-pmap-c-flowmon)# exporter exporter-4 Related Commands
flow monitor type performance-monitorTo configure a flow monitor for Performance Monitor, use the flow monitor type performance-monitorcommand in global configuration mode. To remove flow monitor, use the no form of this command.
flow
monitor
type
performance-monitor
monitor-name
no
flow
monitor
type
performance-monitor
monitor-name
Usage Guidelines.Before you configure flow monitor, you should first configure a flow record and an optional flow exporter. flow record type performance-monitorTo configure a flow record for Performance Monitor, use the flow record type performance-monitorcommand in global configuration mode. To remove the flow record, use the no form of this command.
flow
record
type
performance-monitor
record-name
no
flow
record
type
performance-monitor
record-name
Usage GuidelinesA flow record requires at least one key field before it can be used in a flow monitor. The key fields differentiate flows, with each flow having a unique set of values for the key fields. The key fields are defined using the collect command. |