cflowd commands

configure 
   —  cflowd 
      —  active-flow-timeout number
      —  admin-state keyword
      —  analyze-gre-payload boolean
      —  analyze-l2tp-traffic boolean
      —  analyze-v4overv6-traffic boolean
      —  apply-groups reference
      —  apply-groups-exclude reference
      —  cache-size number
      —  collector (ipv4-address-no-zone | ipv6-address-no-zone) port number 
         —  admin-state keyword
         —  aggregation 
            —  as-matrix boolean
            —  destination-prefix boolean
            —  protocol-port boolean
            —  raw boolean
            —  source-destination-prefix boolean
            —  source-prefix boolean
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  autonomous-system-type keyword
         —  description string
         —  export-filter 
            —  family 
               —  ipv4 boolean
               —  ipv6 boolean
               —  l2-ip boolean
               —  mcast-ipv4 boolean
               —  mcast-ipv6 boolean
               —  mpls boolean
            —  interface-list 
               —  router reference interface-name reference 
               —  service 
                  —  ies-group-interface service-name reference subscriber-interface-name reference group-interface-name reference 
                  —  ies-interface service-name reference interface-name reference 
                  —  vprn-group-interface service-name reference subscriber-interface-name reference group-interface-name reference 
                  —  vprn-interface service-name reference interface-name reference 
                  —  vprn-network-interface service-name reference network-interface-name reference 
            —  router string 
         —  router-instance string
         —  template-set keyword
         —  version number
      —  enhanced-distribution boolean
      —  export-mode keyword
      —  inactive-flow-timeout number
      —  inband-collector-export-only boolean
      —  overflow number
      —  sample-profile number 
         —  apply-groups reference
         —  apply-groups-exclude reference
         —  metering-process keyword
         —  sample-rate number
      —  template-retransmit number
      —  use-vrtr-if-index boolean
Parent topic: Configuration commands

cflowd command descriptions

cflowd

  Synopsis Enable the cflowd context
  Context configure cflowd
  Tree cflowd
  Introduced 16.0.R1
 

Platforms

All

active-flow-timeout number

  Synopsis Maximum time before an active flow is exported
  Context configure cflowd active-flow-timeout number
  Tree active-flow-timeout
 

Description

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

This value is set for a flow when the flow is initially created in the active cache table and does not change dynamically.

  Range 30 to 36000
  Default 1800
  Units seconds
  Introduced 20.2.R1
 

Platforms

All

admin-state keyword

  Synopsis Administrative state of cflowd
  Context configure cflowd admin-state keyword
  Tree admin-state
  Default enable
  Options enable, disable
  Introduced 16.0.R1
 

Platforms

All

analyze-gre-payload boolean

  Synopsis Perform cflowd analysis on the inner IP packet
  Context configure cflowd analyze-gre-payload boolean
  Tree analyze-gre-payload
  Default false
  Introduced 16.0.R1
 

Platforms

All

analyze-l2tp-traffic boolean

  Synopsis Analyze the inner IP header of an L2TP packet
  Context configure cflowd analyze-l2tp-traffic boolean
  Tree analyze-l2tp-traffic
 

Description

When configured to true, cflowd looks for and analyzes 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.

When configured to false, the analysis is not performed.
  Default false
  Introduced 19.10.R1
 

Platforms

All

analyze-v4overv6-traffic boolean

  Synopsis Analyze the inner IPv4 packet within an IPv6 packet
  Context configure cflowd analyze-v4overv6-traffic boolean
  Tree analyze-v4overv6-traffic
 

Description

When configured to true, cflowd looks for and analyzes the inner IPv4 header of IPv4overIPv6 frames that include MAP-E as well as DSLite and SAM traffic.

When configured to false, the analysis is not performed.
  Default false
  Introduced 19.10.R1
 

Platforms

All

cache-size number

  Synopsis Maximum number of active flows in the flow cache table
  Context configure cflowd cache-size number
  Tree cache-size
  Range 1000 to 2000000
  Units flows
  Introduced 16.0.R1
 

Platforms

All

collector [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone) port number

  Synopsis Enter the collector list instance
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number
  Tree collector
  Max. Instances 8
  Introduced 16.0.R1
 

Platforms

All
[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
  Synopsis IP address of the remote cflowd collector host
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number
 

Description

This command specifies the IP address of the remote cflowd collector host to receive the exported cflowd data.
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All
port number
  Synopsis UDP port number of the remote cflowd collector host
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number
  Range 1 to 65535
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All
admin-state keyword
  Synopsis Administrative state of the cflowd collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number admin-state keyword
  Tree admin-state
  Default enable
  Options enable, disable
  Introduced 16.0.R1
 

Platforms

All
aggregation
  Synopsis Enter the aggregation context
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation
  Tree aggregation
  Introduced 16.0.R1
 

Platforms

All
as-matrix boolean
  Synopsis Base aggregation data based on AS information
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation as-matrix boolean
  Tree as-matrix
  Default false
  Introduced 16.0.R1
 

Platforms

All
destination-prefix boolean
  Synopsis Aggregate data based on destination prefix information
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation destination-prefix boolean
  Tree destination-prefix
  Default false
  Introduced 16.0.R1
 

Platforms

All
protocol-port boolean
  Synopsis Aggregate flows based on the IP protocol and ports
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation protocol-port boolean
  Tree protocol-port
  Default false
  Introduced 16.0.R1
 

Platforms

All
raw boolean
  Synopsis Export flow data without aggregation
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation raw boolean
  Tree raw
  Default false
  Introduced 16.0.R1
 

Platforms

All
source-destination-prefix boolean
  Synopsis Aggregate data based on prefix information
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation source-destination-prefix boolean
  Tree source-destination-prefix
  Default false
  Introduced 16.0.R1
 

Platforms

All
source-prefix boolean
  Synopsis Aggregate flows based on the source prefix information
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number aggregation source-prefix boolean
  Tree source-prefix
  Default false
  Introduced 16.0.R1
 

Platforms

All
autonomous-system-type keyword
  Synopsis Basis of the AS information included in flow data
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number autonomous-system-type keyword
  Tree autonomous-system-type
  Default origin
  Options origin, peer
  Introduced 16.0.R1
 

Platforms

All
description string
  Synopsis Text description
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number description string
  Tree description
  String Length 1 to 80
  Introduced 16.0.R1
 

Platforms

All
export-filter
  Synopsis Enter the export-filter context
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter
  Tree export-filter
  Introduced 16.0.R1
 

Platforms

All
family
  Synopsis Enter the family context
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family
  Tree family
  Introduced 16.0.R1
 

Platforms

All
ipv4 boolean
  Synopsis Filter IPv4 flow data from being sent to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family ipv4 boolean
  Tree ipv4
  Default false
  Introduced 16.0.R1
 

Platforms

All
ipv6 boolean
  Synopsis Filter IPv6 flow data from being sent to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family ipv6 boolean
  Tree ipv6
  Default false
  Introduced 16.0.R1
 

Platforms

All
l2-ip boolean
  Synopsis Filter L2 IP flow data from being sent to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family l2-ip boolean
  Tree l2-ip
  Default false
  Introduced 16.0.R1
 

Platforms

All
mcast-ipv4 boolean
  Synopsis Filter multicast IPv4 data from going to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family mcast-ipv4 boolean
  Tree mcast-ipv4
  Default false
  Introduced 16.0.R1
 

Platforms

All
mcast-ipv6 boolean
  Synopsis Filter multicast IPv6 data from going to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family mcast-ipv6 boolean
  Tree mcast-ipv6
  Default false
  Introduced 16.0.R1
 

Platforms

All
mpls boolean
  Synopsis Filter MPLS flow data from being sent to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter family mpls boolean
  Tree mpls
  Default false
  Introduced 16.0.R1
 

Platforms

All
interface-list
  Synopsis Enter the interface-list context
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list
  Tree interface-list
  Introduced 16.0.R4
 

Platforms

All
router [router-name] reference interface-name reference
  Synopsis Add a list entry for router
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list router reference interface-name reference
  Tree router
  Introduced 16.0.R4
 

Platforms

All
[router-name] reference
  Synopsis Administrative router name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list router reference interface-name reference
 

Reference

configure router string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
interface-name reference
  Synopsis Name for the router to the service interface or SAP
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list router reference interface-name reference
 

Reference

configure router string interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
service
  Synopsis Enter the service context
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service
  Tree service
  Introduced 16.0.R4
 

Platforms

All
ies-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
  Synopsis Add a list entry for ies-group-interface
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
  Tree ies-group-interface
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
service-name reference
  Synopsis Administrative service name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
 

Reference

configure service ies string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
subscriber-interface-name reference
  Synopsis Subscriber interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
 

Reference

configure service ies string subscriber-interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
group-interface-name reference
  Synopsis Group interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
 

Reference

configure service ies string subscriber-interface string group-interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
ies-interface service-name reference interface-name reference
  Synopsis Add a list entry for ies-interface
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-interface service-name reference interface-name reference
  Tree ies-interface
  Introduced 16.0.R4
 

Platforms

All
service-name reference
  Synopsis Administrative service name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-interface service-name reference interface-name reference
 

Reference

configure service ies string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
interface-name reference
  Synopsis IP interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service ies-interface service-name reference interface-name reference
 

Reference

configure service ies string interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
vprn-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
  Synopsis Add a list entry for vprn-group-interface
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
  Tree vprn-group-interface
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
service-name reference
  Synopsis Administrative service name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
 

Reference

configure service vprn string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
subscriber-interface-name reference
  Synopsis Subscriber interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
 

Reference

configure service vprn string subscriber-interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
group-interface-name reference
  Synopsis Group interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-group-interface service-name reference subscriber-interface-name reference group-interface-name reference
 

Reference

configure service vprn string subscriber-interface string group-interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
vprn-interface service-name reference interface-name reference
  Synopsis Add a list entry for vprn-interface
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-interface service-name reference interface-name reference
  Tree vprn-interface
  Introduced 16.0.R4
 

Platforms

All
service-name reference
  Synopsis Administrative service name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-interface service-name reference interface-name reference
 

Reference

configure service vprn string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
interface-name reference
  Synopsis IP interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-interface service-name reference interface-name reference
 

Reference

configure service vprn string interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
vprn-network-interface service-name reference network-interface-name reference
  Synopsis Add a list entry for vprn-network-interface
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-network-interface service-name reference network-interface-name reference
  Tree vprn-network-interface
  Introduced 16.0.R4
 

Platforms

All
service-name reference
  Synopsis Administrative service name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-network-interface service-name reference network-interface-name reference
 

Reference

configure service vprn string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
network-interface-name reference
  Synopsis Network interface name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter interface-list service vprn-network-interface service-name reference network-interface-name reference
 

Description

This command specifies the network interface name. Interface names must be unique within the group of defined IP interfaces for the configure router interface and configure service ies interface commands. An interface name cannot be in the form of an IP address. 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.
 

Reference

configure service vprn string network-interface string

 

Notes

This element is part of a list key.
  Introduced 16.0.R4
 

Platforms

All
router [router-instance] string
  Synopsis Add a list entry for router
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter router string
  Tree router
  Introduced 16.0.R1
 

Platforms

All
[router-instance] string
  Synopsis Router instance name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number export-filter router string
 

Description

This command specifies the router instance name. Only "Base" is supported.
 

Notes

This element is part of a list key.
  Introduced 16.0.R1
 

Platforms

All
router-instance string
  Synopsis Router or service name
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number router-instance string
  Tree router-instance
 

Description

This command specifies the routing instance used to route traffic to the associated collector IP address. 

The "Base" routing instance is the fallback if no route is found. No fallback mechanism is supported for "Base" and "VPRN".
  Default management
  Introduced 16.0.R1
 

Platforms

All
template-set keyword
  Synopsis Templates sent to the collector
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number template-set keyword
  Tree template-set
 

Description

This command specifies the set of templates sent to the collector when using cflowd Version 9 or Version 10.
  Options not-applicable, basic, mpls-ip, l2-ip, mpls-transport, compact, fastpath
  Introduced 16.0.R1
 

Platforms

All
version number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.
  Synopsis Flow data collector version
  Context configure cflowd collector (ipv4-address-no-zone | ipv6-address-no-zone) port number version number
  Tree version
  Range 5 | 8 to 10
 

Notes

This element is mandatory.
  Introduced 16.0.R1
 

Platforms

All

enhanced-distribution boolean

  Synopsis Include ingress port ID in hashing algorithm for cflowd
  Context configure cflowd enhanced-distribution boolean
  Tree enhanced-distribution
  Default false
  Introduced 16.0.R1
 

Platforms

7750 SR-7s, 7750 SR-14s, 7950 XRS

export-mode keyword

  Synopsis Export mode for flow data
  Context configure cflowd export-mode keyword
  Tree export-mode
  Default automatic
  Options automatic, manual
  Introduced 16.0.R1
 

Platforms

All

inactive-flow-timeout number

  Synopsis Time without matching packet before flow is inactive
  Context configure cflowd inactive-flow-timeout number
  Tree inactive-flow-timeout
 

Description

This command configures the time interval that must elapse without a packet matching a flow before the flow is considered inactive.

This value is set for a flow when the flow is initially created in the active cache table and does not change dynamically.

  Range 10 to 600
  Default 15
  Units seconds
  Introduced 20.2.R1
 

Platforms

All

inband-collector-export-only boolean

  Synopsis Export the traffic to all collectors only via in-band interfaces
  Context configure cflowd inband-collector-export-only boolean
  Tree inband-collector-export-only
  Default false
  Introduced 16.0.R1
 

Platforms

All

overflow number

  Synopsis Percentage of entries to remove from Cflowd cache when the maximum number of entries is exceeded
  Context configure cflowd overflow number
  Tree overflow
  Range 1 to 50
  Default 1
  Units percent
  Introduced 16.0.R1
 

Platforms

All

sample-profile [profile-id] number

  Synopsis Enter the sample-profile list instance
  Context configure cflowd sample-profile number
  Tree sample-profile
  Max. Instances 5
  Introduced 19.5.R1
 

Platforms

All
[profile-id] number
  Synopsis The unique specifier of this sample-profile
  Context configure cflowd sample-profile number
  Range 1 to 5
 

Notes

This element is part of a list key.
  Introduced 19.5.R1
 

Platforms

All
metering-process keyword
  Synopsis Metering process for samples taken
  Context configure cflowd sample-profile number metering-process keyword
  Tree metering-process
 

Description

This command specifies the type of metering process to use for the samples taken from the associated interfaces. 
  Default standard
  Options standard, fp-accelerated
  Introduced 21.10.R1
 

Platforms

7750 SR-7s, 7950 XRS-20e
sample-rate number
  Synopsis Cflowd sampling rate for sample profile ID
  Context configure cflowd sample-profile number sample-rate number
  Tree sample-rate
 

Description

This command defines the cflowd sampling rate for the sample profile ID.

The sample rate indicates that the associated interface samples 1 in N packets for cflowd analysis. You can only associate one rate profile below 1:256 with a specific IOM, IMM, or XMA.
  Range 1 to 60000
  Default 1000
  Introduced 19.5.R1
 

Platforms

All

template-retransmit number

  Synopsis Time to resend template information
  Context configure cflowd template-retransmit number
  Tree template-retransmit
  Range 10 to 600
  Default 600
  Units seconds
  Introduced 16.0.R1
 

Platforms

All

use-vrtr-if-index boolean

  Synopsis Export flow data using virtual router interface indexes
  Context configure cflowd use-vrtr-if-index boolean
  Tree use-vrtr-if-index
  Default false
  Introduced 16.0.R1
 

Platforms

All