-
Cisco IOS XR Interface and Hardware Component Command Reference, Release 3.5
-
Preface
-
Inter-rack Switch Control Network Commands on Cisco IOS XR Software
-
SONET Controller Commands on Cisco IOS XR Software
-
T3 or E3 and T1 or E1 Controller Commands on Cisco IOS XR Software
-
Dense Wavelength Division Multiplexing Commands on Cisco IOS XR Software
-
10-Gigabit Ethernet WAN Physical Controller Commands on Cisco IOS XR Software
-
Global Interface Commands on Cisco IOS XR Software
-
Management Ethernet Interface Commands on Cisco IOS XR Software
-
Packet-over-SONET SDH Interface Commands on Cisco IOS XR Software
-
SRP Commands on Cisco IOS XR Software
-
Ethernet Interface Commands on Cisco IOS XR Software
-
802.1Q VLAN Subinterface Commands on Cisco IOS XR Software
-
Serial Interface Commands on Cisco IOS XR Software
-
ATM Commands on Cisco IOS XR Software
-
Null Interface Commands on Cisco IOS XR Software
-
Link Bundling Commands on Cisco IOS XR Software
-
PPP Commands on Cisco IOS XR Software
-
Bidirectional Forwarding Detection Commands on Cisco IOS XR Software
-
Frame Relay Service Configuration Commands on Cisco IOS XR Software
-
Diagnostics Commands on Cisco IOS XR Software
-
NetFlow Commands on Cisco IOS XR Software
-
Index
-
Table Of Contents
NetFlow Commands on Cisco IOS XR Software
clear flow platform producer statistics location
show flow platform producer statistics location
NetFlow Commands on Cisco IOS XR Software
This module describes the NetFlow commands on Cisco IOS XR software.
cache entries
To configure the number of entries in the monitor map flow cache, enter the cache entries command in flow monitor map configuration mode. To remove a configured number of entries and return the cache to the default configuration, use the no form of this command.
cache entries number
no command number
Syntax Description
number
Number of entries in the flow cache. Replace the number argument with the number of flow entries allowed in the flow cache. Range is from 4096 through 1000000.
Defaults
number = 65535
Command Modes
Flow monitor map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to configure the number of entries in the monitor map flow cache to be 10000:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# cache entries 10000Related Commands
cache permanent
To disable the removal of entries from the monitor map flow cache, enter the cache permanent command in flow monitor map configuration mode. To re-enable the removal of entries from the flow cache, use the no form of this command.
cache permanent
no cache permanent
Syntax Description
This command has no arguments or keywords.
Defaults
The removal of entries from the monitor map flow cache is enabled.
Command Modes
Flow monitor map configuration
Command History
Release 3.2
This command was introduced on the Cisco CRS-1.
Release 3.3.0
This feature was first supported on the Cisco XR 12000 Series Router.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to disable the removal of entries from the monitor map flow cache:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# cache permanentThe following example shows how to re-enable the removal of entries from the monitor map flow cache:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# no cache permanentRelated Commands
cache timeout
To configure the active, inactive, and update flow cache timeout, enter the cache timeout command in flow monitor map configuration mode. To remove the configured timeout value and return the cache to its default timeout value, use the no form of this command.
cache timeout {active | inactive | update} timeout_value
no cache timeout {active | inactive | update} timeout_value
Syntax Description
Defaults
For active timeout, the default value is 1800 seconds.
For inactive timeout, the default value is 15 seconds.
For update timeout, the default value is 1800 seconds.
Command Modes
Flow monitor map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Note
The inactive timeout value should be smaller than the active timeout value.
Note
Task ID
Examples
The following example shows how to set the active timeout for the monitor map cache to 200,000 seconds:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# cache timeout active 200000Related Commands
clear flow exporter
To export flow exporter templates to the collector or restart the flow exporter statistics collector, enter the clear flow exporter command in EXEC mode.
clear flow exporter [fem-name] {restart | statistics} location node-id
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example exports all templates to the collector:
RP/0/RP0/CPU0:router# clear flow exporter restart location 0/0/SPRestart exporter all locations. Continue? [confirm]The following example shows how to clear flow exporter statistics on a specific node.
RP/0/RP0/CPU0:router# clear flow exporter statistics location 0/0/CPU0Clear statistics for all exporters on the location. Continue? [confirm]Related Commands
Configures a flow exporter map.
Displays flow exporter data.
Displays flow exporter map information for a specific node.
clear flow monitor
To clear the flow monitor data, enter the clear flow monitor command in EXEC mode.
clear flow monitor [name] cache [force-export | statistics] location node-id
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to clear the cache-related flow records on a specific node:
RP/0/RP0/CPU0:router# clear flow monitor cache force-export location 0/0/CPU0Clear cache entries for this monitor on this location. Continue? [confirm]Related Commands
Configures a flow monitor map.
Displays flow monitor map information for a specific node that is installed in the router.
clear flow platform producer statistics location
To clear statistics collected by the NetFlow producer, use the clear flow platform producer statistics location command in EXEC mode.
clear flow platform producer statistics location node-id
Syntax Description
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1.
Release 3.4.0
No modification.
Release 3.5.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to clear statistics collected by the NetFlow producer:
RP/0/RP0/CPU0:router # clear flow platform producer statistics location 0/0/CPU0destination
To configure the collector export destination, enter the destination command in flow exporter map configuration mode. To remove a configured export destination, use the no form of this command.
destination hostname_or_IP_address
no destination hostname_or_IP_address
Syntax Description
hostname_or_IP_address
Export destination for the current flow exporter map. Enter the hostname or destination IP address in the A.B.C.D format.
Defaults
No default behavior or values
Command Modes
Flow exporter map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to configure the flow exporter map export destination to be a specific IP address:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# flow exporter-map map1RP/0/RP0/CPU0:router(config-fem)# destination 172.18.189.38Related Commands
dscp
To configure the differentiated services codepoint (DSCP) value for export packets, enter the dscp command in flow exporter map configuration mode. To remove a configured DSCP value, use the no form of this command.
dscp dscp_value
no dscp dscp_value
Syntax Description
dscp_value
Specifies the DSCP value for export packets. Replace dscp_value with a number. Range is from 0 through 63.
Defaults
No default behavior or values
Command Modes
Flow exporter map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to configure the DSCP value for export packets to be 30:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# flow exporter-map map1RP/0/RP0/CPU0:router(config-fem)# dscp 30Related Commands
exporter
To associate a flow exporter map with the current flow monitor map, enter the exporter command in flow monitor map configuration mode. To remove an associated flow exporter map from a flow monitor map, use the no form of this command.
exporter map_name
no exporter map_name
Syntax Description
map_name
Name of the flow exporter map you want to associate with the current flow monitor map. The exporter map name can be a maximum of 32 characters.
Defaults
No default behavior or values
Command Modes
Flow monitor map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Note
Task ID
Examples
The following example shows how to associate a flow exporter map called "fem_1" with the current flow monitor map:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# exporter fem_1Related Commands
flow
To specify a flow monitor map and a sampler map for the packets on an interface, enter the flow command in interface configuration mode.
flow [ipv4 | ipv6 | mpls] monitor name sampler name {egress | ingress}
Syntax Description
Defaults
No default behavior or values
Command Modes
Interface configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to enable IPV4 NetFlow on a Packet-over-SONET/SDH (POS) interface, and then apply the flow monitor map, named "map1," on outgoing IPv4 packets:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# interface POS 0/1/0/0RP/0/RP0/CPU0:router(config-if)# flow ipv4 monitor map1 sampler map1 egressThe following example shows how to enable MPLS NetFlow on a Packet-over-SONET/SDH (POS) interface, and apply the flow monitor map, named "map_mpls1," on outgoing MPLS packets:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# interface POS 0/1/0/0RP/0/RP0/CPU0:router(config-if)# flow mpls monitor map_mpls1 sampler map1 egressRelated Commands
Creates and configures a flow monitor map, and enters flow monitor map configuration submode.
Displays flow monitor map information.
flow exporter-map
To create a flow exporter map and enter flow exporter map configuration mode, use the flow exporter-map command in global configuration mode. To remove a configured flow exporter map, use the no form of this command.
flow exporter-map fem-name
no flow exporter-map fem-name
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
When you issue the flow exporter-map fem-name command in global configuration mode, the CLI prompt changes to "config-fem," indicating that you have entered the flow exporter map configuration submode. In the following sample output, the question mark (?) online help function displays all the commands available under flow exporter map configuration submode:
RP/0/RP0/CPU0:router(config)# flow exporter-map map1RP/0/RP0/CPU0:router(config-fem)# ?commit Commit the configuration changes to runningdescribe Describe a command without taking real actionsdestination Export destination configurationdo Run an exec commanddscp Specify DSCP value for export packetsexit Exit from this submodeno Negate a command or set its defaultsroot Exit to the global configuration modeshow Show contents of configurationsource Source interfacetransport Specify the transport protocol for export packetsversion Specify export version parametersTask ID
Examples
The following example shows how to create a flow exporter map called "map1," and then enter the flow exporter map configuration submode for that map:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# flow exporter-map map1RP/0/RP0/CPU0:router(config-fem)#Related Commands
flow monitor-map
To create and configure a flow monitor map and enter flow monitor map configuration submode, use the flow monitor-map command in global configuration mode. To remove a configured flow monitor map, use the no form of this command:
flow monitor-map map_name
no flow monitor-map map_name
Syntax Description
map_name
New monitor map name, or specifies the name of an existing monitor map. The monitor map name can be a maximum 32 characters.
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
When you issue the flow monitor-map map_name command in global configuration mode, the CLI prompt changes to "config-fmm," indicating that you have entered the flow monitor map configuration submode. In the following sample output, the question mark (?) online help function displays all the commands available under flow monitor map configuration submode:
RP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# ?cache Specify flow cache attributescommit Commit the configuration changes to runningdescribe Describe a command without taking real actionsdo Run an exec commandexit Exit from this submodeexporter Specify flow exporter map nameno Negate a command or set its defaultsrecord Specify a flow record map nameshow Show contents of configurationTask ID
Examples
The following example shows how to enter flow monitor map configuration mode for a monitor map called "map1:"
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0router(config)# flow monitor-map map1RP/0/RP0/CPU0router(config-fmm)#Related Commands
options
To export the tables in the options template and specify export timeout values, enter the options command in flow exporter map version configuration mode. To return the options template to its default configuration values, use the no form of this command.
options {interface-table | sampler-table} [timeout seconds]
no options {interface-table | sampler-table} [timeout seconds]
Syntax Description
Defaults
The default value for timeout is 0 seconds, which means that the template options are not exported by default.
Command Modes
Flow exporter map version configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to export the interface table and configure the export timeout value to be 300 seconds:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# flow exporter-map fem1RP/0/RP0/CPU0:router(config-fem)# version v9RP/0/RP0/CPU0:router(config-fem-ver)# options interface-table timeout 300Related Commands
random 1 out-of
To configure the packet sampling interval for a monitor map, use the random 1 out-of command in sampler map configuration submode. To remove a configured sampling interval and return to the default sampling interval, use the no form of this command.
random 1 out-of number_of_packets
no random 1 out-of number_of_packets
Syntax Description
number_of_packets
Sampling interval in units of packets. Replace the number_of_packets argument with a number. Range is from 1 through 65535 units.
Defaults
number_of_packets = 10000
Command Modes
Sampler map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to configure the sampler map to randomly sample 1 out of every 10 packets:
RP/0/RP0/CPU0:router # configureRP/0/RP0/CPU0:router(config)# sampler map1RP/0/RP0/CPU0:router(config-sm)# random 1 out-of 10Related Commands
Enters sampler map configuration submode for a specific monitor map.
Displays sampler map information.
record ipv4
To configure the flow record map name for IPv4, use the record ipv4 command in flow monitor map configuration mode. To remove the configured name from a flow record, use the no form of this command.
record ipv4
no record ipv4
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Flow monitor map configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to configure the flow record map name for IPv4:
RP/0/RP0/CPU0:router# configureRP/0/RP0/CPU0:router(config)# flow monitor-map map1RP/0/RP0/CPU0:router(config-fmm)# record ipv4Related Commands
record ipv6
