Analytics

Analytics configuration manages NX-OS flow analytics profiles, events, filters, records, collectors, monitors, system config, and traffic analytics. Profiles define collection parameters, events configure FTE event capture, filters provide named groupings, records define flow match/collect criteria, collectors specify remote destinations, monitors associate records with exporter buckets, system config binds monitors/profiles/events/filters at the system level, and traffic analytics enables interface-level flow monitoring.

Diagram

Classes

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
analytics	Class	[analytics]	No

analytics (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
shutdown	Boolean	true, false	No
flow_timeout	Integer	min: 5, max: 60	No
flow_profiles	List	[flow_profiles]	No
flow_events	List	[flow_events]	No
flow_filters	List	[flow_filters]	No
flow_records	List	[flow_records]	No
flow_exporters	List	[flow_exporters]	No
flow_monitors	List	[flow_monitors]	No
flow_system_config	Class	[flow_system_config]	No
flow_traffic_analytics	Class	[flow_traffic_analytics]	No

flow_profiles (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
burst_interval_shift	Integer	min: 0, max: 255	No
collect_interval	Integer	min: 100, max: 64000	No
ip_packet_id_shift	Integer	min: 0, max: 255	No
mtu	Integer	min: 576, max: 9216	No
seq_num_guess_threshold_high	Integer	min: 0, max: 4294967295	No
seq_num_guess_threshold_low	Integer	min: 0, max: 4294967295	No
source_port	Integer	min: 1, max: 65535	No

flow_events (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
capture_acl_drops	Boolean	true, false	No
capture_blackhole	Boolean	true, false	No
capture_buffer_drops	Boolean	true, false	No
capture_fwd_drops	Boolean	true, false	No
capture_ip_df	Boolean	true, false	No
capture_receive_window_zero	Boolean	true, false	No
capture_tos	Integer	min: 0, max: 255	No
capture_ttl	Integer	min: 0, max: 255	No
event_export_max	Integer	min: 0, max: 32000	No
group_drop_events	Boolean	true, false	No
group_latency_events	Boolean	true, false	No
group_packet_events	Boolean	true, false	No
latency_threshold	Integer	min: 0, max: 65535	No
latency_threshold_unit	Choice	micro-sec, milli-sec	No

flow_filters (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
ipv4_acl	String		No
ipv6_acl	String		No
ce_acl	String		No

flow_records (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
collect	List	Any[Choice[count-bytes, count-pkts, sampler-id, pkt-disp, ts-first, ts-recent, tcp-flags, src-intf, ingress-vrf-id] or String]	No
match	List	Any[Choice[ethertype, dst-mac, src-mac, vlan, proto, tos, src-ipv4, dst-ipv4, src-ipv6, dst-ipv6, src-port, dst-port, src-ip, dst-ip] or String]	No

flow_exporters (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
description	String		No
destination	IP		No
transport_udp	Integer	min: 0, max: 65535	No
dscp	Integer	min: 0, max: 63	No
events_transport_udp	Integer	min: 0, max: 65535	No
inband_interface	Boolean	true, false	No
source_address	IP		No
source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
source_interface_id	Any	String or Integer[min: 0]	No
v9	Boolean	true, false	No
version	Choice	v5, v9, cisco-v1	No
vrf	String		No

flow_monitors (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
record	String		No
exporter_bucket_ids	List	[exporter_bucket_ids]	No

flow_system_config (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
direction	Choice	in, out, both	No
exporter_id	Integer	min: 0, max: 4294967295	No
switch_latency	Boolean	true, false	No
traffic_analytics	Boolean	true, false	No
monitor	String		No
profile	String		No
event	String		No
filter	String		No

flow_traffic_analytics (nxos.devices.configuration.analytics)

Name	Type	Constraint	Mandatory	Default Value
name	String		No
db_size	Integer	min: 1, max: 5000	No
filter_export_interval	Integer	min: 10, max: 60	No
mode_interface	Boolean	true, false	No
udp_port	Integer	min: 0, max: 65535	No

exporter_bucket_ids (nxos.devices.configuration.analytics.flow_monitors)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 1, max: 255	Yes
hash_high	Integer	min: 0, max: 4294967295	No
hash_low	Integer	min: 0, max: 4294967295	No
exporters	List	String	No

Examples

Example 1: Basic analytics with a flow profile

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          analytics: true
        analytics:
          flow_timeout: 30
          flow_profiles:
            - name: PROFILE1
              collect_interval: 200
              mtu: 1500
              source_port: 10000

Example 2: Analytics with events, policy, and traffic analytics

nxos:
  devices:
    - name: SPINE1
      configuration:
        feature:
          analytics: true
        analytics:
          flow_timeout: 30
          flow_profiles:
            - name: PROFILE1
              burst_interval_shift: 10
              collect_interval: 200
              ip_packet_id_shift: 10
              mtu: 1500
              seq_num_guess_threshold_high: 100
              seq_num_guess_threshold_low: 50
              source_port: 10000
          flow_events:
            - name: EVENTS1
              capture_acl_drops: true
              capture_buffer_drops: true
              capture_fwd_drops: true
              capture_blackhole: true
              capture_ip_df: true
              capture_receive_window_zero: true
              capture_tos: 10
              capture_ttl: 10
              group_drop_events: true
              group_latency_events: true
              group_packet_events: true
              latency_threshold: 100
              latency_threshold_unit: milli-sec
              event_export_max: 10
          flow_filters:
            - name: FILTER1
              ipv4_acl: ACL1
              ipv6_acl: ACL1
          flow_traffic_analytics:
            name: TA1
            mode_interface: true
            db_size: 1000
            filter_export_interval: 30
            udp_port: "1234"

Example 3: Analytics with records, collectors, monitors, and system config

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          analytics: true
        analytics:
          flow_filters:
            - name: FILTER1
          flow_records:
            - name: RECORD1
              collect:
                - count-bytes
                - count-pkts
                - ts-first
                - ts-recent
              match:
                - src-ipv4
                - dst-ipv4
                - src-port
                - dst-port
                - proto
          flow_exporters:
            - name: COLLECTOR1
              destination: 10.1.1.1
              transport_udp: 5640
              dscp: 46
              events_transport_udp: 5695
              source_interface_type: loopback
              source_interface_id: lo0
              version: v9
              vrf: default
          flow_monitors:
            - name: MONITOR1
              record: RECORD1
              exporter_bucket_ids:
                - id: 1
                  hash_low: 0
                  hash_high: 4294967295
                  exporters:
                    - COLLECTOR1
          flow_system_config:
            direction: out
            exporter_id: 201
            switch_latency: true
            traffic_analytics: true
            monitor: MONITOR1
            profile: PROFILE1
            event: EVENTS1
            filter: FILTER1