Package Documentation

Storm Package: synapse-apollo

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

Storm Commands

This package implements the following Storm Commands.

apollo.genorg

Generate an ou:org node from inbound inet:fqdn nodes.

This command may also be safely used to enrich existing ou:org nodes provided their primary
inet:fqdn is mapped into the :dns:mx property.

Examples -

  inet:fqdn=vertex.link | apollo.genorg --debug --yield


Usage: apollo.genorg [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the created/enriched ou:org nodes.
  --asof <asof>               : This argument is deprecated and no longer has any effect.

The command is accessible to users with one or more of the following permissions:

• power-ups.apollo.user

apollo.people.byorgfqdn

Generate ps:contact nodes for any known people associated with an org inet:fqdn.

Examples -

  // Create ps:contact for any known employees of vertex.link

  inet:fqdn=vertex.link | apollo.people.byorgfqdn --yield


Usage: apollo.people.byorgfqdn [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the created/enriched ou:org nodes.
  --size <size>               : Limit the number of ps:contact nodes added. (default: 100)

Inputs:

  inet:fqdn                   : Org FQDNs to search for ps:contacts.

The command is accessible to users with one or more of the following permissions:

• power-ups.apollo.user

apollo.people.bytitle

Generate ps:contact nodes for any people with the given titles.

Examples -

  // Create ps:contact for people with the title "intelligence analyst"

  ou:jobtitle="intelligence analyst" | apollo.people.bytitle --yield


Usage: apollo.people.bytitle [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the created/enriched ou:org nodes.
  --size <size>               : Limit the number of ps:contact nodes added. (default: 100)

Inputs:

  ou:jobtitle                 : Job titles to use when searching for ps:contacts.

The command is accessible to users with one or more of the following permissions:

• power-ups.apollo.user

apollo.setup.apikey

Set the Apollo API key.


Usage: apollo.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set the key as a user variable. If not used, the key is set globally.

Arguments:

  <apikey>                    : The Apollo API key string.

The command is accessible to users with one or more of the following permissions:

• power-ups.apollo.user

Storm Modules

This package does not export any Storm APIs.