Global commands

cflowd

Syntax

[no] cflowd

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

Commands in this context configure cflowd.

The no form of this command removes all configuration under cflowd, including all configured collectors. The no form can only be executed if cflowd is shut down.

Default

no cflowd

active-timeout

Syntax

active-timeout minutes

no active-timeout

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

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

If the minutes parameter is changed while cflowd is active, the existing flows do not inherit the new active timeout value. The active timeout value for a flow is set when the flow is first created in the active cache table; the value does not change dynamically.

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

Default

active-timeout 30

Parameters

minutes

Specifies the value, expressed in minutes, before an active flow is exported.

Values

1 to 600

cache-size

Syntax

cache-size num-entries

no cache-size

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command specifies the maximum number of active entries maintained in the flow cache table.

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

Default

cache-size 65536

Parameters

num-entries

Specifies the maximum number of entries maintained in the cflowd cache.

Values

1000 to 131072

collector

Syntax

collector ip-address[:port] [version version]

no collector ip-address[:port]

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command defines a flow data collector for cflowd data. The IP address of the flow collector must be specified.

If the optional UDP port number parameter is not configured, default port 2055 is used for all collector versions. To connect to an IPFIX (version 10) collector using the IPFIX default port, specify port 4739 when configuring the collector. The version must be specified. A maximum of five collectors can be configured.

The no form of this command removes the flow collector definition from the configuration and stops the export of data to the collector. The collector must be shut down before it can be deleted.

Parameters

ip-address

Specifies the address of a remote cflowd collector host that will receive the exported cflowd data.

Values

<ip-address[:port]>

ip-address - a.b.c.d[:port]

(IPv4)

x:x:x:x:x:x:x:x

(IPv6)

[x:x:x:x:x:x:x:x]:port

(IPv6)

x - [0..FFFF]H

port

Specifies the UDP port number on the remote cflowd collector host that will 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

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command enables data aggregation for the collector and commands in this context configure the aggregation types.

To configure aggregation, you must choose the aggregation scheme: autonomous system, destination prefix, protocol port, raw, source destination, or source prefix.

This command can only be configured if the collector version is configured as Version 8.

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

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command enables cflowd aggregation based on autonomous system (AS) information. An AS matrix contains packet and byte counters for traffic from either source-destination ASs or last-peer to next-peer ASs.

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

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command enables cflowd aggregation based on destination prefix information.

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

Default

no destination-prefix

protocol-port

Syntax

[no] protocol-port

Context

config>cflowd>collector>aggregation

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command enables cflowd aggregation 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.

Default

no protocol-port

raw

Syntax

[no] raw

Context

config>cflowd>collector>aggregation

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command enables the sending of raw (unaggregated) flow data in Version 5.

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

Default

no raw

source-destination-prefix

Syntax

[no] source-destination-prefix

Context

config>cflowd>collector>aggregation

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

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.

Default

no source-destination-prefix

source-prefix

Syntax

[no] source-prefix

Context

config>cflowd>collector>aggregation

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

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.

Default

no source-prefix

autonomous-system-type

Syntax

autonomous-system-type {origin | peer}

Context

config>cflowd>collector

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command configures whether the AS information included in the flow data is based on the originating AS or external peer AS of the routes.

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

Default

autonomous-system-type origin

Parameters

origin

Keyword to specify that the AS information included in the flow data is based on the originating AS.

peer

Keyword to specify 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

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

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

Specifies the description character string, up to 80 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

shutdown

Syntax

[no] shutdown

Context

config>cflowd

config>cflowd>collector

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

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 can be deleted.

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.

The no form of this command administratively enables an entity.

Default

no shutdown

template-set

Syntax

template-set {basic | mpls-ip}

Context

config>cflowd>collector

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

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

Default

template-set basic

Parameters

basic

Keyword to send basic flow data.

mpls-ip

Keyword to send extended flow data that includes IP and MPLS flow information.

export-mode

Syntax

export-mode [automatic | manual]

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command configures 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. In manual mode, flow data is exported only when the tools perform cflowd manual-export command 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

Keyword to automatically generate cflowd flow data.

manual

Keyword to export cflowd flow data only when manually triggered.

inactive-timeout

Syntax

inactive-timeout seconds

no inactive-timeout

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

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

If the seconds parameter is changed while cflowd is active, the existing flows do not inherit the new inactive timeout value. The inactive timeout value for a flow is set when the flow is first created in the active cache table; the value does not change dynamically.

The no form of this command reverts the inactive timeout to the default value.

Default

inactive-timeout 15

Parameters

seconds

Specifies the amount of time, in seconds, that must elapse without a packet matching before the flow is considered inactive

Values

10 to 600

overflow

Syntax

overflow percent

no overflow

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

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

The no form of this command reverts 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

rate

Syntax

rate sample-rate

no rate

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

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, if sample-rate is configured as 1, all packets are sent to the cache. If sample-rate is configured as 100, one out of every 100 packets is sent to the cache.

Note:

On the 7210 SAS, when cflowd is enabled on an IP interface, the sampling rate is applied to a port and only the samples that match the IP interface for which cflowd is enabled are processed further to update or create flow records in the flow cache. Samples received that do not match the IP interface for which cflowd is enabled are not processed further, and flow records are not created for them.

The no form of this command reverts 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

template-retransmit

Syntax

template-retransmit seconds

no template-retransmit

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command specifies the interval for sending template definitions.

Default

template-retransmit 600

Parameters

seconds

Specifies the interval, in seconds, between the sending of template definitions.

Values

10 to 600

use-vrtr-if-index

Syntax

[no] use-vrtr-if-index

Context

config>cflowd

Platforms

7210 SAS-Mxp and 7210 SAS-Sx/S 1/10GE (standalone)

Description

This command exports 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, which are used to export the flow data to cflowd Version 9 and Version 10 collectors, is 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 present 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 revert to the default behavior of populating the ingress and egress interface ID with the global IF index ID.

Default

no use-vrtr-if-index