3.2.34. ipfix¶

Note

requires a Product License.

IPFIX configuration.

vsr running config# vrf <vrf> ipfix

enabled (pushed)¶

Enable or disable the IPFIX daemons for perf measurement.

vsr running config# vrf <vrf> ipfix
vsr running ipfix# enabled true|false

Default value: true

ipfix-collector¶

List of IPFIX collectors.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>

<ipfix-collector>

Collector unique identifier.

address (mandatory)¶

The address or hostname of the IPFIX collector.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># address ADDRESS

`ADDRESS` values	Description
`<ipv4-address>`	The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format
`<ipv6-address>`	The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.
`<domain-name>{1,253}`	The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890.

port¶

The port number of the IPFIX collector.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># port PORT

PORT

A 16-bit port number used by a transport protocol such as TCP or UDP.

Default value: 4739

protocol¶

Force the protocol to select between IPFIX or NetFlow v9.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># protocol PROTOCOL

`PROTOCOL` values	Description
`tcp`	TCP protocol to use to connect the IPFIX collector.
`udp`	UDP protocol to use to connect the IPFIX collector.
`nfv9`	NetFlow v9 protocol to use to connect the NetFlow collector.

Default value: tcp

scan-interval-seconds¶

Scanning interval in seconds.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># scan-interval-seconds <1-4294967295>

Default value: 5

frag-flow-lifetime-seconds¶

Fragmented flow lifetime timeout.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># frag-flow-lifetime-seconds <1-4294967295>

Default value: 5

active-flow-lifetime-interval-seconds¶

Active flow lifetime timeout.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># active-flow-lifetime-interval-seconds <1-4294967295>

Default value: 5

idle-flow-lifetime-interval-seconds¶

IDLE flow lifetime timeout.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># idle-flow-lifetime-interval-seconds <1-4294967295>

Default value: 5

mpls-route-hash-order¶

Order for the MPLS route hash table.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># mpls-route-hash-order <1-10>

Default value: 1

interface-cache-hash-order¶

Order for the interface cache hash table.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># interface-cache-hash-order <1-10>

Default value: 3

sampling-packet-interval¶

Specifies the number of packets that are consecutively sampled. A value of 100 means that 100 consecutive packets are sampled. Unused on NetFlow v9.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># sampling-packet-interval <1-4294967295>

Default value: 1

sampling-packet-space¶

Specifies the number of packets between two ‘sampling-packet- interval’s. A value of 100 means that the next interval starts 100 packets (which are not sampled) after the current ‘sampling-packet- interval’ is over.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># sampling-packet-space <0-4294967295>

Default value: 4000

source-ip¶

Source address used to reach the collector.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># source-ip SOURCE-IP

`SOURCE-IP` values	Description
`<ipv4-address>`	An IPv4 address.
`<ipv6-address>`	An IPv6 address.

export-expired-flow-only¶

Export only expired flow to this collector.

vsr running config# vrf <vrf> ipfix ipfix-collector <ipfix-collector>
vsr running ipfix-collector <ipfix-collector># export-expired-flow-only true|false

Default value: false

ipfix-probe¶

List of IPFIX interfaces.

vsr running config# vrf <vrf> ipfix ipfix-probe <ipfix-probe>

<ipfix-probe>

An interface name.

enabled¶

Enable or disable the IPFIX probe on this interface for perf measurement.

vsr running config# vrf <vrf> ipfix ipfix-probe <ipfix-probe>
vsr running ipfix-probe <ipfix-probe># enabled true|false

Default value: true

link-vrf¶

The link vrf name used to locate the interface. If unset, this vrf is used.

vsr running config# vrf <vrf> ipfix ipfix-probe <ipfix-probe>
vsr running ipfix-probe <ipfix-probe># link-vrf <leafref>

collector (mandatory)¶

The collector to send flow information to.

vsr running config# vrf <vrf> ipfix ipfix-probe <ipfix-probe>
vsr running ipfix-probe <ipfix-probe># collector <leafref>

observation-domain-id¶

Unique identifier in the domain of the probe.

vsr running config# vrf <vrf> ipfix ipfix-probe <ipfix-probe>
vsr running ipfix-probe <ipfix-probe># observation-domain-id <uint32>

Default value: 0

template-refresh-timeout¶

unit: seconds

Time before re-sending Template Sets (in seconds). Mainly for UDP and nfv9 protocols. Be aware, that a new Template Sets message will be sent in the next scan, following the timeout (see scan-interval).

vsr running config# vrf <vrf> ipfix ipfix-probe <ipfix-probe>
vsr running ipfix-probe <ipfix-probe># template-refresh-timeout <60-86400>

Default value: 600

connected (state only)¶

True when the connection with the collector is established.

vsr> show state vrf <vrf> ipfix ipfix-probe <ipfix-probe> connected

collecting (state only)¶

True when flows on this interface are being collected.

vsr> show state vrf <vrf> ipfix ipfix-probe <ipfix-probe> collecting