Flow Monitor Map

Configure NetFlow/IPFIX flow monitor maps for traffic monitoring and analysis. Flow monitor maps define how flow data is collected, including the record format, exporter destination, and cache parameters.

Diagram

Classes

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
flow_monitor_maps	List	`[flow_monitor_maps]`	No

flow_monitor_maps (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory
name	String		Yes
cache_entries	Integer	min: `4096`, max: `1000000`	No
cache_immediate	Boolean	`true`, `false`	No
cache_permanent	Boolean	`true`, `false`	No
cache_timeout_active	Integer	min: `1`, max: `604800`	No
cache_timeout_inactive	Integer	min: `0`, max: `604800`	No
cache_timeout_rate_limit	Integer	min: `1`, max: `1000000`	No
cache_timeout_update	Integer	min: `1`, max: `604800`	No
exporters	List	`[exporters]`	No
hw_cache_timeout_inactive	Integer	min: `50`, max: `1800`	No
option_bgpattr	Boolean	`true`, `false`	No
option_filtered	Boolean	`true`, `false`	No
option_outbundlemember	Boolean	`true`, `false`	No
option_outphysint	Boolean	`true`, `false`	No
record_datalink_record	Boolean	`true`, `false`	No
record_default_mdi	Boolean	`true`, `false`	No
record_default_rtp	Boolean	`true`, `false`	No
record_ipv4	Boolean	`true`, `false`	No
record_ipv4_as	Boolean	`true`, `false`	No
record_ipv4_as_tos	Boolean	`true`, `false`	No
record_ipv4_bgp_nexthop_tos	Boolean	`true`, `false`	No
record_ipv4_destination	Boolean	`true`, `false`	No
record_ipv4_destination_prefix	Boolean	`true`, `false`	No
record_ipv4_destination_prefix_tos	Boolean	`true`, `false`	No
record_ipv4_destination_tos	Boolean	`true`, `false`	No
record_ipv4_extended	Boolean	`true`, `false`	No
record_ipv4_gtp	Boolean	`true`, `false`	No
record_ipv4_l2_l3	Boolean	`true`, `false`	No
record_ipv4_peer_as	Boolean	`true`, `false`	No
record_ipv4_prefix	Boolean	`true`, `false`	No
record_ipv4_prefix_port	Boolean	`true`, `false`	No
record_ipv4_prefix_tos	Boolean	`true`, `false`	No
record_ipv4_protocol_port	Boolean	`true`, `false`	No
record_ipv4_protocol_port_tos	Boolean	`true`, `false`	No
record_ipv4_source_prefix	Boolean	`true`, `false`	No
record_ipv4_source_prefix_tos	Boolean	`true`, `false`	No
record_ipv6	Boolean	`true`, `false`	No
record_ipv6_destination	Boolean	`true`, `false`	No
record_ipv6_extended	Boolean	`true`, `false`	No
record_ipv6_gtp	Boolean	`true`, `false`	No
record_ipv6_l2_l3	Boolean	`true`, `false`	No
record_ipv6_peer_as	Boolean	`true`, `false`	No
record_ipv6_srv6	Boolean	`true`, `false`	No
record_map_t	Boolean	`true`, `false`	No
record_mpls	Boolean	`true`, `false`	No
record_mpls_ipv4_fields	Boolean	`true`, `false`	No
record_mpls_ipv4_ipv6_fields	Boolean	`true`, `false`	No
record_mpls_ipv6_fields	Boolean	`true`, `false`	No
record_mpls_labels	Integer	min: `1`, max: `6`	No
record_sflow	Boolean	`true`, `false`	No
sflow_options	Boolean	`true`, `false`	No
sflow_options_extended_gateway	Boolean	`true`, `false`	No
sflow_options_extended_ipv4_tunnel_egress	Boolean	`true`, `false`	No
sflow_options_extended_ipv6_tunnel_egress	Boolean	`true`, `false`	No
sflow_options_extended_router	Boolean	`true`, `false`	No
sflow_options_if_counters_polling_interval	Integer	min: `5`, max: `1800`	No
sflow_options_input_ifindex	Choice	`physical`	No
sflow_options_output_ifindex	Choice	`physical`	No
sflow_options_sample_header_size	Integer	min: `128`, max: `343`	No

exporters (iosxr.devices.configuration.flow_monitor_maps)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

Example YAML Code:

Example-1: Configure a basic IPv4 flow monitor with exporter.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "FLOW_MONITOR_IPV4"
            record_ipv4: true
            exporters:
              - name: "EXPORTER1"
            cache_entries: 10000
            cache_timeout_active: 60
            cache_timeout_inactive: 15

Example-2: Configure IPv4 flow monitoring with extended options.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "FLOW_IPV4_EXTENDED"
            record_ipv4_extended: true
            exporters:
              - name: "EXPORTER1"
            cache_entries: 50000
            cache_timeout_active: 120
            cache_timeout_inactive: 30
            cache_timeout_update: 60
            option_outphysint: true
            option_filtered: true

Example-3: Configure IPv6 flow monitoring with SRv6 support.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "FLOW_IPV6_MONITOR"
            record_ipv6: true
            record_ipv6_srv6: true
            exporters:
              - name: "EXPORTER1"
            cache_entries: 25000
            cache_timeout_active: 90
            cache_timeout_inactive: 20

Example-4: Configure MPLS flow monitoring.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "FLOW_MPLS_MONITOR"
            record_mpls: true
            record_mpls_ipv4_fields: true
            record_mpls_labels: 6
            exporters:
              - name: "EXPORTER1"
            cache_entries: 15000
            cache_timeout_active: 60
            cache_timeout_inactive: 10

Example-5: Configure sFlow monitoring with all options.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "SFLOW_MONITOR"
            record_sflow: true
            sflow_options: true
            sflow_options_extended_router: true
            sflow_options_extended_gateway: true
            sflow_options_extended_ipv4_tunnel_egress: true
            sflow_options_extended_ipv6_tunnel_egress: true
            sflow_options_if_counters_polling_interval: 300
            sflow_options_sample_header_size: 256
            sflow_options_input_ifindex: "physical"
            sflow_options_output_ifindex: "physical"
            exporters:
              - name: "SFLOW_EXPORTER"
            cache_entries: 100000
            cache_timeout_inactive: 60

Example-6: Configure hardware cache with advanced settings.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "HW_FLOW_MONITOR"
            record_ipv4: true
            exporters:
              - name: "EXPORTER1"
            cache_entries: 500000
            cache_timeout_active: 300
            cache_timeout_inactive: 60
            cache_timeout_rate_limit: 5000
            cache_permanent: false
            cache_immediate: true
            hw_cache_timeout_inactive: 300
            option_bgpattr: true
            option_outbundlemember: true

Example-7: Configure multiple monitor maps for different traffic types.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        flow_monitor_maps:
          - name: "FLOW_IPV4_GTP"
            record_ipv4_gtp: true
            exporters:
              - name: "GTP_EXPORTER"
            cache_entries: 100000
            cache_timeout_active: 180
          - name: "FLOW_MAP_T"
            record_map_t: true
            exporters:
              - name: "MAP_T_EXPORTER"
            cache_entries: 50000
          - name: "FLOW_DATALINK"
            record_datalink_record: true
            exporters:
              - name: "DATALINK_EXPORTER"
            cache_entries: 25000
          - name: "FLOW_RTP"
            record_default_rtp: true
            exporters:
              - name: "RTP_EXPORTER"
            cache_entries: 10000
          - name: "FLOW_MDI"
            record_default_mdi: true
            exporters:
              - name: "MDI_EXPORTER"
            cache_entries: 10000