SNMP trap input plugin

The SNMPv1 and SNMPv2c communities to listen for. To allow any community, set this config value to empty community => [].

Examples

Listen for public and guest communities

input {
  snmptrap {
    community => ["public", "guest"]
  }
}

Listen for all communities

input {
  snmptrap {
    community => []
  }
}

Controls this plugin’s compatibility with the Elastic Common Schema (ECS).

The address to listen on.

The mib_paths option specifies the location of one or more imported MIB files. The value can be either a dir path containing the imported MIB (.dic, .yaml) files or a file path to a single MIB file.

Defines the mapping textual representation of an OID in the Logstash event: * default translates every identifier, using the MIBs resolved names, separated by dots. Example: 1.3.6.1.2.1.1.2.0 is mapped as iso.org.dod.internet.mgmt.mib-2.system.sysObjectID.0 * ruby_snmp produces field names prefixed by the MIBs module name, followed by the latest resolved identifier name and unknowns values. Example: 1.3.6.1.2.1.1.2.0 is mapped as SNMPv2-MIB::sysObjectID.0. * dotted_string maps fields using the standard dotted string representation, Example: 1.3.6.1.2.1.1.2.0 is mapped as 1.3.6.1.2.1.1.2.0

Defines if the Logstash event fields values, which types are OID, are mapped using the configured OID textual representation set on the oid_mapping_format option.

The oid_root_skip option specifies the number of OID root digits to ignore in the event field name. For example, in a numeric OID like "1.3.6.1.2.1.1.1.0" the first 5 digits could be ignored by setting oid_root_skip => 5 which would result in a field name "1.1.1.0". Similarly when a MIB is used an OID such "1.3.6.1.2.mib-2.system.sysDescr.0" would become "mib-2.system.sysDescr.0"

The oid_path_length option specifies the number of OID root digits to retain in the event field name. For example, in a numeric OID like "1.3.6.1.2.1.1.1.0" the last 2 digits could be retained by setting oid_path_length => 2 which would result in a field name "1.0". Similarly when a MIB is used an OID such "1.3.6.1.2.mib-2.system.sysDescr.0" would become "sysDescr.0"

The port to listen on. Remember that ports less than 1024 (privileged ports) may require root to use. hence the default of 1062.

The supported transport protocols to listen on.

SNMP was originally designed for use with UDP as transport protocol and is the official recommendation. TCP is an optional transport mapping and can be enabled if needed. For more details on SNMP over TCP, please refer to the RFC-3430.

The supported SNMP protocol versions to listen on. SNMP messages for versions that are either unsupported and/or disabled are automatically discarded.

The name of the field under which SNMP payloads are assigned. If not specified data will be stored in the root of the event.

Setting a target is recommended when ecs_compatibility is enabled.

The number of threads to use for processing the received SNMP trap messages.

This plugin provides all IETF MIBs (management information bases), publicly available in the libsmi version 0.5.0. When enabled, it automatically loads the bundled MIBs and provides mapping of the numeric OIDs to MIB field names in the resulting event.

directory of YAML MIB maps (same format ruby-snmp uses)

The auth_pass option specifies the SNMPv3 authentication passphrase or password.

The auth_protocol option specifies the SNMPv3 authentication protocol or type

The priv_pass option specifies the SNMPv3 encryption password.

The priv_protocol option specifies the SNMPv3 privacy/encryption protocol.

The security_level option specifies the SNMPv3 security level between Authentication, No Privacy; Authentication, Privacy; or no Authentication, no Privacy.

The security_name option specifies the SNMPv3 security name or user name.

Add a field to an event

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 snmptrap inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {
  snmptrap {
    id => "my_plugin_id"
  }
}

Add any number of arbitrary tags to your event.

This can help with processing later.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.