Storm Package: synapse-rapid7-sonar-rdns

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

Storm Commands

This package implements the following Storm Commands.

rapid7.sonar.rdns.download

Download SonarRDNS data files from Rapid7.

This command queues RDNS data files matching a specified pattern for download
from Rapid7 into the configured Axon, then indexing the uncompressed data into
the service's local storage.

Examples:

  rapid7.sonar.rdns.download 2020-11-25


Usage: rapid7.sonar.rdns.download [options] <pattern>

Options:

  --help                      : Display the command usage.
  --yield                     : Yield the newly created nodes.
  --debug                     : Enable debug output.
  --size <size>               : Limit the total output. This may be per node. (default: None)
  --timeout <timeout>         : Specify a timeout in seconds to apply to each file download. (default: 0)

Arguments:

  <pattern>                   : Download files matching a specified pattern.

rapid7.sonar.rdns.enrich

Enrich nodes with Rapid7 RDNS data.

This command takes inet:ipv4 nodes as input and searches the Rapid7 Sonar RDNS
data for matching records.

The results of the query are used to create inet:dns:rev nodes, with their .seen
property set to the timestamp of the matching record, which will also be used to
update the :dns:rev property of the inbound inet:ipv4 node.

Examples:

    inet:ipv4=1.2.3.4 | rapid7.sonar.rdns.enrich


Usage: rapid7.sonar.rdns.enrich [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the newly created nodes.
  --debug                     : Enable debug output.
  --size <size>               : Limit the total output. This may be per node. (default: None)

rapid7.sonar.rdns.files

List SonarRDNS data files available for download from Rapid7.

Usage: rapid7.sonar.rdns.files [options]

Options:

  --help                      : Display the command usage.

rapid7.sonar.rdns.setup.apikey

Set your Rapid7 SonarRDNS API key.

Usage: rapid7.sonar.rdns.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --show-apikey               : Display the API key value.
  --remove                    : Remove the configured API key.

Arguments:

  [apikey]                    : The Rapid7 SonarRDNS API key string.

Storm Modules

This package does not export any Storm APIs.