Storm Package: synapse-maxmind

The following Commands are available from this package. This documentation is generated for version 3.9.0 of the package.

Storm Commands

This package implements the following Storm Commands.

maxmind

Enrich nodes using the MaxMind GeoIP2 metadata.

This commands takes inet:ipv4 or inet:ipv6 nodes as input and enriches them using the MaxMind database
distributed with the service.  Input nodes may have the following secondary properties updated
depending on the results from the MaxMind database:

- :asn
- :loc
- :latlong

inet:asn nodes will also be created if the appropriate data is available from the MaxMind database. These are
yielded if the --yield option is specified.

Examples:

    // Enrich an inet:ipv4 node
    inet:ipv4=129.186.1.100 | maxmind

    // Enrich an inet:ipv6 node
    inet:ipv6=2a02:6b8:b011:6b01:92e2:0:4d58:2f88 | maxmind


Usage: maxmind [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size.
  --yield                     : Yield the newly created nodes.

Storm Modules

This package does not export any Storm APIs.