6.6. Cflowd Configuration Command Reference

6.6.1. Command Hierarchies

config
[no] cflowd
cache-size num-entries
— no cache-size
collector ip-address[:port] [version version]
— no collector ip-address[:port]
[no] aggregation
[no] as-matrix
[no] protocol-port
[no] raw
[no] source-prefix
autonomous-system-type {origin | peer}
description description-string
[no] family
[no] ipv4
[no] ipv6
[no] l2-ip
[no] mcast-ipv4
[no] mcast-ipv6
[no] mpls
[no] router router-instance interface interface-name
[no] ies service-id interface ip-int-name
[no] ies service-id subscriber-interface ip-int-name group-interface ip-int-name
[no] vprn service-id interface ip-int-name
[no] vprn service-id network-interface ip-int-name
[no] vprn service-id subscriber-interface ip-int-name group-interface ip-int-name
[no] router router-instance
router router-instance
[no] shutdown
template-set {basic | mpls-ip | l2-ip | mpls-transport}
export-mode {automatic | manual}
overflow percent
— no overflow
sample-profile profile-id [create]
— no sample-profile profile-id
sample-rate [rate]
[no] shutdown

6.6.2. Command Descriptions

6.6.2.1. Global Commands

cflowd

Syntax 
[no] cflowd
Context 
config>cflowd
Description 

This command creates the context to configure cflowd.

The no form of this command removes all configuration under cflowd including the deletion of all configured collectors. This can only be executed if cflowd is in a shutdown state.

Default 

no cflowd

active-flow-timeout

Syntax 
active-flow-timeout seconds
no active-flow-timeout
Context 
config>cflowd
Description 

This command configures the maximum amount of time before an active flow is aged out of the active cache. If an individual flow is active for the specifried amount of time, the flow is aged out and a new flow is created on the next packet sampled for that flow.

Existing flows do not inherit the new active-flow-timeout value if this parameter is changed while cflowd is active. The active-flow-timeout value for a flow is set when the flow is first created in the active cache table and does not change dynamically.

The no form of this command resets the timeout back to the default value.

Default 

active-flow-timeout 1800

Parameters 
seconds—
Specifies the value, in seconds, before an active flow is exported.
Values—
60 to 36000

 

analyze-gre-payload

Syntax 
[no] analyze-gre-payload
Context 
config>cflowd
Description 

This command enables cflowd analysis of the inner IP packet in a sampled GRE packet that is transiting the local router.

If the GRE packet terminates on the local node, the inner IP payload is analyzed and reported using existing IPv4 or IPv6 flow templates. This behavior is not affected by this command.

If this parameter is enabled and a GRE packet is transiting the local node, the inner payload is reported using the GRE Flow Template. (Template ID 308 or 309)

This behavior is only supported with V10 (IPFIX) collectors.

The no form of this command disables cflowd analysis of the inner IP packet in a sampled GRE packet.

analyze-l2tp-traffic

Syntax 
[no] analyze-l2tp-traffic
Context 
config>cflowd
Description 

This command causes cflowd to look for and analyze the inner IP header of an L2TPv2 frame.

L2TPv2 traffic is identified by either the source or destination UDP port numbering that is set to 1701.

The no form of this command disables this function.

Default 

no analyze-l2tp-traffic

analyze-v4overv6-traffic

Syntax 
[no] analyze-v4overv6-traffic
Context 
config>cflowd
Description 

This command causes cflowd to look for and analyze the inner IPv4 header of IPv4overIPv6 frames that include MAP-E as well as DS-Lite and SAM traffic.

The no form of this command disables this function.

Default 

no analyze-v4overv6-traffic

cache-size

Syntax 
cache-size num-entries
no cache-size
Context 
config>cflowd
Description 

This command specifies the maximum number of active flows to maintain in the flow cache table.

The no form of this command resets the number of active entries back to the default value.

Default 

cache-size 65536

Parameters 
num-entries—
Specifies the maximum number of entries maintained in the cflowd cache. The number depends on the CPM version.
Values—

For the 7450 ESS and 7750 SR (cfm-xp, SF/CPM3):

1000 to 250000

For the 7450 ESS and 7750 SR (CPM4 or CPM5):

1000 to 1000000

For the 7950 XRS:

1000 to 1500000

 

Default—

For the 7450 ESS and 7750 SR:

65536 (64K)

For the 7950 XRS:

500000

collector

Syntax 
collector ip-address[:port] [version version]
no collector ip-address[:port]
Context 
config>cflowd
Description 

This command defines a flow data collector for cflowd data. The IP address and version of the flow collector must be specified. The UDP port number is an optional parameter. If it is not set, the default of 2055 is used for all collector versions. To connect to an IPFIX (version 10) collector using the IPFIX default port, specify port 4739 when defining the collector. A maximum of eight collectors can be configured.

The no form of this command removes the flow collector definition from the config and stops the export of data to the collector. The collector needs to be shut down to be deleted.

Parameters 
ip-address—
Specifies the address of a remote cflowd collector host to receive the exported cflowd data.
Values—

ipv4-address

a.b.c.d

ipv6-address

x:x:x:x:x:x:x:x-[interface]

 

port—
Specifies the UDP port number on the remote cflowd collector host to receive the exported cflowd data.
Values—
1 to 65535

 

Default—
2055
version—
Specifies the version of the flow data collector.
Values—
5, 8, 9, 10

 

Default—
5

aggregation

Syntax 
[no] aggregation
Context 
config>cflowd>collector
Description 

This command configures the type of aggregation scheme to be exported.

Specifies the type of data to be aggregated and to the collector.

To configure aggregation, you must decide which type of aggregation scheme to configure: autonomous system, destination prefix, protocol port, raw, source destination, or source prefix.

This can only be configured if the collector version is configured as V8.

The no form of this command removes all aggregation types from the collector configuration.

Default 

no aggregation

as-matrix

Syntax 
[no] as-matrix
Context 
config>cflowd>collector>aggregation
Description 

This command specifies that the aggregation data should be based on autonomous system (AS) information. An AS matrix contains packet and byte counters for traffic from either source-destination autonomous systems or last-peer to next-peer autonomous systems.

The no form of this command removes this type of aggregation from the collector configuration.

Default 

no as-matrix

destination-prefix

Syntax 
[no] destination-prefix
Context 
config>cflowd>collector>aggregation
Description 

This command specifies that the aggregation data is based on destination prefix information.

The no form removes this type of aggregation from the collector configuration.

protocol-port

Syntax 
[no] protocol-port
Context 
config>cflowd>collector>aggregation
Description 

This command specifies that flows be aggregated based on the IP protocol, source port number, and destination port number.

The no form of this command removes this type of aggregation from the collector configuration.

raw

Syntax 
[no] raw
Context 
config>cflowd>collector>aggregation
Description 

This command configures raw (unaggregated) flow data to be sent in Version 5.

The no form of this command removes this type of aggregation from the collector configuration.

source-destination-prefix

Syntax 
[no] source-destination-prefix
Context 
config>cflowd>collector>aggregation
Description 

This command configures cflowd aggregation based on source and destination prefixes.

The no form of this command removes this type of aggregation from the collector configuration.

source-prefix

Syntax 
[no] source-prefix
Context 
config>cflowd>collector>aggregation
Description 

This command configures cflowd aggregation based on source prefix information.

The no form of this command removes this type of aggregation from the collector configuration.

autonomous-system-type

Syntax 
autonomous-system-type {origin | peer}
Context 
config>cflowd>collector
Description 

This command defines whether the autonomous system (AS) information included in the flow data is based on the originating AS or external peer AS of the routes.

This option is only allowed if the collector is configured as Version 5 or Version 8.

Default 

autonomous-system-type origin

Parameters 
origin—
Specifies that the AS information included in the flow data is based on the originating AS.
peer—
Specifies that the AS information included in the flow data is based on the peer AS.

description

Syntax 
description description-string
no description
Context 
config>cflowd>collector
Description 

This command creates a text description stored in the configuration file for a configuration context.

The no form of this command removes the description string from the context.

Parameters 
description-string—
The description character string. Allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

export-filter

Syntax 
export-filter
Context 
config>cflowd>collector
Description 

This command creates the CLI context to specify cflowd data filters. These filters allow the administrator to control which flows are sent or are not sent to an associated cflowd collector.

family

Syntax 
[no] family
Context 
config>cflowd>collector>export-filter
Description 

This command defines the address family for the flow types that should not be sent to the associated cflowd collector.

Multiple family types can be defined in this context to filter out multiple address families to a given collector.

The no form of this command removes the address family definition, allowing all address family types to be exported to the associated collector.

Default 

no family

ipv4

Syntax 
[no] ipv4
Context 
config>cflowd>collector>export-filter>family
Description 

This command filters IPv4 flow data from being sent to the associated collector.

The no form of this command removes the filter, allowing IPv4 flow data to be sent to the associated collector.

Default 

no ipv4

ipv6

Syntax 
[no] ipv6
Context 
config>cflowd>collector>export-filter>family
Description 

This command filters IPv6 flow data from being sent to the associated collector.

The no form of this command removes the filter, allowing IPv6 flow data to be sent to the associated collector.

Default 

no ipv6

l2-ip

Syntax 
[no] l2-ip
Context 
config>cflowd>collector>export-filter>family
Description 

This command filters Layer 2 IP flow data from being sent to the associated collector.

The no form of this command removes the filter, allowing Layer 2 IP flow data to be sent to the associated collector.

Default 

no l2-ip

mcast-ipv4

Syntax 
[no] mcast-ipv4
Context 
config>cflowd>collector>export-filter>family
Description 

This command filters multicast IPv4 flow data from being sent to the associated collector.

The no form of this command removes the filter, allowing multicast IPv4 flow data to be sent to the associated collector.

Default 

no mcast-ipv4

mcast-ipv6

Syntax 
[no] mcast-ipv6
Context 
config>cflowd>collector>export-filter>family
Description 

This command filters multicast IPv6 flow data from being sent to the associated collector.

The no form of this command removes the filter, allowing multicast IPv6 flow data to be sent to the associated collector.

Default 

no mcast-ipv6

mpls

Syntax 
[no] mpls
Context 
config>cflowd>collector>export-filter>family
Description 

This command filters MPLS flow data from being sent to the associated collector.

The no form of this command removes the filter, allowing MPLS flow data to be sent to the associated collector.

Default 

no mpls

interface-list

Syntax 
interface-list
Context 
config>cflowd>collector>exp-filter
Description 

This command enables the context allowing the administrator to specify which interface’s flow data should be exported to the associated collector.

Table 100 describes the cflowd export filter precedence.

Table 100:  Cflowd Export Filter Precedence  

Family Filter

Router Filter

Interface Filter

Export to Collector

0

0

0

export all

0

0

1

export if matched interface only

0

1

0

export if matched router only

0

1

1

export if router match *OR* interface match

1

0

0

not exported due to family exclusion filter

1

0

1

not exported due to family exclusion filter

1

1

0

not exported due to family exclusion filter

1

1

1

not exported due to family exclusion filter

router

Syntax 
[no] router router-instance interface interface-name
Context 
config>cflowd>collector>exp-filter>if-list
Description 

This command identifies an interface for which ingress sampled data flows should be sent to the associated collector.

The no form of this command removes the specified interface from the interface-list filter.

Parameters 
router-instance—
Specifies the router instance ID associated with the interface name
Values—
router-name | vprn-svc-id
router-name: Base, management Default - Base
vprn-svc-id: 1 to 2147483647

 

interface-name—
Specifies the interface name, up to 32 characters and must start with a letter, for the desired router to the service interface or SAP

service

Syntax 
service
Context 
config>cflowd>collector>exp-filter>if-list
Description 

This command enables the context to configure which service interfaces' flow data is being sent to this collector

ies

Syntax 
[no] ies service-id interface ip-int-name
[no] ies service-id subscriber-interface ip-int-name group-interface ip-int-name
Context 
config>cflowd>collector>exp-filter>if-list>svc
Description 

This command configures which IES service interfaces' flow data is being sent to this collector.

The no form of the command removes the values from the configuration.

Parameters 
service-id—
Specifies the unique service identification number or string identifying the service in the service domain. This ID must be unique to this service and may not be used for any other service of any type. The service-id must be the same number used for every SR OS on which this service is defined.
Values—
service-id: 1 to 2147483647
svc-name: 64 characters maximum

 

interface ip-int-name—
Specifies the name of the IP interface. Interface names must be unique within the group of defined IP interfaces for config router interface and config service ies interface commands. An interface name cannot be in the form of an IP address. Interface names can be from 1 to 32 alphanumeric characters and must start with a letter. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
subscriber-interface ip-int-name—
Specifies the interface name of a subscriber interface. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes and must start with a letter.
group-interface ip-int-name—
Specifies the interface name of a group interface. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes and must start with a letter.

vprn

Syntax 
[no] vprn service-id interface ip-int-name
[no] vprn service-id network-interface ip-int-name
[no] vprn service-id subscriber-interface ip-int-name group-interface ip-int-name
Context 
config>cflowd>collector>exp-filter>if-list>svc
Description 

This command configures which VPRN service interfaces' flow data is being sent to this collector.

The no form of the command removes the values from the configuration.

Parameters 
service-id—
Specifies the unique service identification number or string identifying the service in the service domain. This ID must be unique to this service and may not be used for any other service of any type. The service-id must be the same number used for every SR OS on which this service is defined.
Values—
service-id: 1 to 2147483647
svc-name: 64 characters maximum

 

interface ip-int-name—
Specifies the name of an IP interface. Interface names must be unique within the group of defined IP interfaces for config router interface and config service ies interface commands. An interface name cannot be in the form of an IP address. Interface names can be from 1 to 32 alphanumeric characters and must start with a letter. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
network-interface ip-int-name—
Specifies the name of a network interface. Interface names must be unique within the group of defined IP interfaces for config router interface and config service ies interface commands. An interface name cannot be in the form of an IP address. Interface names can be from 1 to 32 alphanumeric characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes and must start with a letter.
subscriber-interface ip-int-name—
Specifies an interface name of a subscriber interface. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes and must start with a letter.
group-interface ip-int-name—
Specifies an interface name of a group interface. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes and must start with a letter.

router

Syntax 
[no] router router-instance
Context 
config>cflowd>collector>export-filter
Description 

This command allows the flow data from only specific router instances to be sent to the associated collector.

Multiple router instances can be configured by issuing the command multiple times with the different router-instances.

The no form of this command removes the specified router-instance restriction, which means flows from that router-instance will no longer be exported. If all router-instances are removed, then flows from all router instances are sent to the associated collector.

Default 

no router

Parameters 
router-instances—
Specifies the router name or router instance VPRN service ID. Only “Base” is supported.
Values—
router-name: Base, management Default - management
vprn-svc-id: 1 to 2147483647

 

router

Syntax 
router {router-name | vprn-svc-id}
Context 
config>cflowd>collector
Description 

This command configures the flow data sent to the associated collector to be sent within the specified router context. If this parameter is not specified, flow data is exported using the management routing context.

Default 

router management

Parameters 
router-name—
Specifies the router name.
Values—
Base, management

 

Default—
management
vprn-svc-id—
Specifies the router instance VPRN service ID.
Values—
1 to 2147483647

 

shutdown

Syntax 
[no] shutdown
Context 
config>cflowd
config>cflowd>collector
Description 

This command administratively disables an entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

The no form of this command administratively enables an entity.

Unlike other commands and parameters where the default state is not indicated in the configuration file. The shutdown and no shutdown states are always indicated in system generated configuration files.

Default 

no shutdown

template-set

Syntax 
template-set {basic | mpls-ip | l2-ip | mpls-transport}
Context 
config>cflowd>collector
Description 

This command specifies the set of templates sent to the collector when using cflowd Version 9 or Version 10.

Default 

template-set basic

Parameters 
basic—
Specifies that basic flow data is sent.
mpls-ip—
Specifies that extended flow data is sent that includes IP and MPLS flow information.

If the sampled traffic is part of a locally configured service or IPv4 or IPv6 traffic is being forwarded with an MPLS shortcut, then the MPLS labels associated with that service encapsulation are included in the extended flow data for both network ingress and egress sampling.

l2-ip—
Specifies that extended flow data is sent that includes Layer 2 (Ethernet) and IP flow information. This template is only applicable for V10 (IPFIX) collectors.
mpls-transport—
Specifies that cflowd can collect flow statistics for MPLS traffic using only the outer transport label, EXP bit value, and ingress interface as the flow identifier. This template enables the collection of flow statistics on a core router to develop LSP usage statistics.

enhanced-distribution

Syntax 
[no] enhanced-distribution
Context 
config>cflowd
Description 

This command enables the inclusion of the ingress port ID into the hash algorithm used to distribute cflowd sample traffic to cflowd processes running on the 7950 XRS CPM. By including this new attribute, cflowd may see better distribution of flows across processing tasks if there is a limited number of IP interfaces on which sampling is performed, but those interfaces use LAGs with a large number of port members.

By enabling this option, the same flow may be captured multiple times if packets are received on multiple ingress ports.

This command is only applicable to cflowd running on a 7950 XRS platform.

The no form of this command removes the command from the configuration and disables the inclusion of the ingress port ID in the cflowd hash algorithm.

Default 

no enhanced-distribution

export-mode

Syntax 
export-mode {automatic | manual}
Context 
config>cflowd
Description 

This command can be used to control how exports are generated by the cflowd process. The default behavior is for flow data to be exported automatically based on the active and inactive time-out values. The alternative mode is manual in which case flow data is only exported when the command “tools perform cflowd manual-export” is issued. The only exception is if the cflowd cache overflows, in which case the normal automatic export process is used.

Default 

export-mode automatic

Parameters 
automatic—
cflowd flow data is automatically generated.
manual—
cflowd flow data is exported only when manually triggered.

inactive-flow-timeout

Syntax 
inactive-flow-timeout seconds
no inactive-flow-timeout
Context 
config>cflowd
Description 

This command specifies the length of time, in seconds, that must elapse without a packet matching a flow before the flow is considered inactive.

The no form of this command resets the inactive flow timeout back to the default of 15 seconds.

Existing flows do not inherit the new inactive-flow-timeout value if this parameter is changed while cflowd is active. The inactive-flow-timeout value for a flow is set when the flow is first created in the active cache table and does not change dynamically.

Default 

inactive-flow-timeout 15

Parameters 
seconds—
Specifies the length of time, in seconds, without a packet matching a flow before the flow is considered inactive.
Values—
10 to 600

 

inband-collector-export-only

Syntax 
[no] inband-collector-export-only
Context 
config>cflowd
Description 

This command, when the inband-collector-export-only command is enabled, allows only collectors that are reachable through inband interfaces and enables a higher flow export rate.

The no form of this command, the default, re-enables the use of the out-of-band management Ethernet port.

overflow

Syntax 
overflow percent
no overflow
Context 
config>cflowd
Description 

This command specifies the percentage of the flow cache entries removed when the maximum number of entries is exceeded. The entries removed are the entries that have not been updated for the longest amount of time.

The no form of this command resets the number of entries cleared from the flow cache on overflow to the default value.

Default 

overflow 1

Parameters 
percent—
Specifies the percentage of the flow cache entries removed when the maximum number of entries is exceeded.
Values—
1 to 50 percent

 

rate

Syntax 
rate sample-rate
no rate
Context 
config>cflowd
Description 

This command specifies the rate (N) at which traffic is sampled and sent for flow analysis. A packet is sampled every N packets; for example, when sample-rate is configured as 1, then all packets are sent to the cache. When sample-rate is configured as 100, then every 100th packet is sent to the cache.

The no form of this command resets the sample rate to the default value.

Default 

rate 1000

Parameters 
sample-rate—
Specifies the rate at which traffic is sampled.
Values—
1 to 10000

 

sample-profile

Syntax 
sample-profile profile-id [create]
no sample-profile profile-id
Context 
config>cflowd
Description 

This command enables the context to create and define sampling parameters.

The no form of this command removes the associated sample-profile. sample-profile 1 cannot be deleted.

Parameters 
profile-id—
Specifies the rate profile.
Values—
1 to 5

 

create—
Mandatory keyword when creating a sample profile. The create keyword requirement can be enabled or disabled in the environment>create context.

sample-rate

Syntax 
sample-rate [rate]
Context 
config>cflowd>sample-profile
Description 

This command defines the cflowd sampling rate associated with the sample profile ID.

This rate indicates that 1 in N packets are sampled at the associated interface for cflowd analysis. Only one rate profile below 1:256 can be associated with a given IOM, IMM, or XMA.

Default 

sample-rate 1000

Parameters 
rate—
Specifies the rate at which traffic is sampled and forwarded for cflowd analysis.
Values—
1 to 10000

 

template-retransmit

Syntax 
template-retransmit seconds
no template-retransmit
Context 
config>cflowd
Description 

This command specifies the interval for sending template definitions.

Default 

template-retransmit 600

Parameters 
seconds—
Specifies the value expressed in seconds before sending template definitions.
Values—
10 to 600

 

use-vrtr-if-index

Syntax 
[no] use-vrtr-if-index
Context 
config>cflowd
Description 

This command is used to export flow data using interface indexes (ifIndex values), which can be used directly as the index into the IF-MIB tables for retrieving interface statistics. Specifically, if this command is enabled, the ingressInterface (ID=10) and egressInterface (ID= 14) fields in IP flow templates used to export the flow data to cflowd version 9 and version 10 collectors will be populated with the IF-MIB ifIndex of that interface. In addition, for version 10 templates, two fields are available in the IP flow templates to specify the virtual router ID associated with the ingress and egress interfaces.

The no form of this command removes the command from the active configuration and causes cflowd to return to the default behavior of populating the ingress and egress interface ID with the global IF index IDs.

Default 

no use-vrtr-if-index