Package Documentation

Storm Package: synapse-psl

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

Storm Commands

This package implements the following Storm Commands.

psl.ingest

Download and ingest the Public Suffix List.

This command will download the Public Suffix List and create inet:fqdn
nodes with :issuffix=True for the listed suffixes.

Examples:

  // Ingest the Public Suffix List and yield the created nodes
  psl.ingest --yield

  // Ingest the Public Suffix List without applying tags
  psl.ingest --no-tags

  // Create a cron job to update the Public Suffix List every day
  cron.add --name psl.ingest --hour 5 { psl.ingest }


Usage: psl.ingest [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --yield                     : Yield the newly created nodes.
  --no-tags                   : Do not apply tags to created nodes.

psl.setup.tag

Set the tag used when ingesting the Public Suffix List.

The default tag is "rep.psl.suffix" if not specified. This tag will be
applied, with the value set to the time the command was run, to any inet:fqdn
nodes created for suffixes in the list.


Usage: psl.setup.tag [options] <tagname>

Options:

  --help                      : Display the command usage.

Arguments:

  <tagname>                   : The tag to use.

Storm Modules

This package does not export any Storm APIs.