6.7. Cflowd Command Reference

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.

This command administratively disables the 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.

The no form of this command administratively enables the 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.

This command enables the context to configure Cflowd.

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

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

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

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

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 to the default value.

This command defines a flow data collector for Cflowd data. The IP address of the flow collector must be specified. The UDP port number is an optional parameter, but if it is not set, the default of 2055 is used for all collector versions. The version must be specified when a collector is first configured. To connect to a version 10 (IPFIX) collector using the IPFIX default port, specify port 4739 when configuring the collector. 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 to be deleted.

This command specifies the set of templates sent to the collector when using Cflowd version 9 or version 10. The Layer 2 (Ethernet) template (l2-ip keyword) is only applicable for collectors using Cflowd version 10 and is only used for flows sampled on Epipe or VPLS services

This command controls 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 timeout values. If manual mode is used, case flow data is only exported when the tools>perform>cflowd>manual-export command is issued. The only exception is if the Cflowd cache overflows, in which case, the automatic export process is used.

This command specifies the amount of time, in seconds, that must elapse without a packet matching a flow in order for the flow to be considered inactive.

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

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

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 reverts to the default value.

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, all packets are sent to the cache. When sample-rate is configured as 100, every 100th packet is sent to the cache.

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

This command specifies the interval at which template definitions are sent to the collector.

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. 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 causes Cflowd to return to the default behavior of populating the ingress and egress interface IDs with the global interface index IDs.

This command displays the administrative and operational status of data collectors.

This command displays the administrative and operational status of the interfaces with Cflowd enabled.

This command displays information about the administrative and operational status of Cflowd on Layer 2 services.

This command displays information about the administrative and operational status of Cflowd.

This command clears the raw flow caches that are sending flow data to the configured collectors. This action triggers all the flows to be discarded. The cache restarts flow data collection from a fresh state. This command also clears global statistics and collector statistics that are displayed using Cflowd show commands.