Skip to main content
Version: 6.3

SNMP

Overview​

Flow records generally include the index of ingress and egress interfaces by which the network traffic traversed the exporting device. The Unified Flow Collector will attempt to determine the names, and additional attributes, of these interfaces as learned by polling the exporting device using SNMP.

EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE​

This setting determines whether SNMP polls will be used to gather these network interface attributes.

  • Valid Values
    • true, false
  • Default
    • false

EF_PROCESSOR_ENRICH_NETIF_SNMP_PORT​

If SNMP polling of attributes is enabled (EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE is true), this setting specifies the UDP port that is used for such polls.

  • Default
    • 161 (the default SNMP port number)

EF_PROCESSOR_ENRICH_NETIF_SNMP_VERSION​

If SNMP polling of attributes is enabled (EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE is true), this setting specifies the SNMP version that is used for such polls.

info

All network devices which may be polled MUST support this version of SNMP.

  • Valid Values
    • 1 - use SNMPv1
    • 2 - use SNMPv2c
    • 3 - use SNMPv3
  • Default
    • 2

EF_PROCESSOR_ENRICH_NETIF_SNMP_COMMUNITIES​

If SNMP polling of attributes is enabled (EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE is true), this setting specifies the SNMP community strings that may be used for such polls. If a comma-separated list is specified, the collector will try each community in the order specified. Once a community returns a successful response the collector will remember this community for future polls of the device.

info

All network devices which may be polled MUST be configured to all visibility of collected attributes using this community. It may be necessary to specify a view associated with this community. The documentation for your devices should contain the necessary information that you will need for determining the correct configuration steps.

  • Example
    • public,private,whatever
  • Default
    • public

EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_USERNAME​

The username used to authenticate with the device using SNMPv3.

  • Default
    • ''

EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_AUTHENTICATION_PROTOCOL​

The authentication protocol used to authenticate the username with the device using SNMPv3.

  • Valid Values
    • noauth, md5, sha, sha224, sha256, sha384, sha512
  • Default
    • noauth

EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_AUTHENTICATION_PASSPHRASE​

The authentication passphrase used to authenticate the username with the device using SNMPv3.

  • Default
    • ''

EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_PRIVACY_PROTOCOL​

The privacy protocol used to encrypt SNMPv3 traffic between the SNMP input and the device.

  • Valid Values
    • nopriv, des, aes, aes192, aes256, aes192c, aes256c
  • Default
    • nopriv

EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_PRIVACY_PASSPHRASE​

The privacy passphrase used to encrypt SNMPv3 traffic between the SNMP input and the device.

  • Default
    • ''

EF_PROCESSOR_ENRICH_NETIF_SNMP_TIMEOUT​

If SNMP polling of attributes is enabled (EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE is true), this setting specifies the number of seconds to wait for the polled device to respond.

  • Default
    • 2

EF_PROCESSOR_ENRICH_NETIF_SNMP_RETRIES​

If SNMP polling of attributes is enabled (EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE is true), this setting specifies the number of retries to attempt after the initial poll has timed out or otherwise fail. The timeout period will be doubled for each retry.

  • Default
    • 1