Storm Package: synapse-swarm

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

Storm Commands

This package implements the following Storm Commands.

swarm.chan.cull

Cull (remove entries from) swarm work output channels.


Usage: swarm.chan.cull [options] <names>

Options:

  --help                      : Display the command usage.

Arguments:

  <names> [<names> ...]       : The name of channels to cull.

swarm.chan.fini

Remove swarm work output channels.


Usage: swarm.chan.fini [options] <names>

Options:

  --help                      : Display the command usage.

Arguments:

  <names> [<names> ...]       : The name of channels to remove.

swarm.chan.init

Initialize swarm work output channels.


Usage: swarm.chan.init [options] <names>

Options:

  --help                      : Display the command usage.
  --desc <desc>               : Set the channel description.

Arguments:

  <names> [<names> ...]       : The name of channels to be initialized

swarm.chan.list

List swarm work output channels.


Usage: swarm.chan.list [options] <names>

Options:

  --help                      : Display the command usage.

Arguments:

  [<names> ...]               : The name of channels to list.

swarm.job.cancel

Cancel a job within the swarm service.


Usage: swarm.job.cancel [options] <idens>

Options:

  --help                      : Display the command usage.
  --debug                     : No help available.

Arguments:

  <idens> [<idens> ...]       : A list of job IDs to cancel.

swarm.job.cull

Cull jobs by state and type.

This command will delete all jobs matching the state and type arguments,
or all jobs if those arguments are set to null.


Usage: swarm.job.cull [options]

Options:

  --help                      : Display the command usage.
  --state <state>             : Cull jobs in the given state. (default: complete)
  --jobtype <jobtype>         : Cull jobs of a particular type

swarm.job.del

Delete a job within the swarm service.


Usage: swarm.job.del [options] <idens>

Options:

  --help                      : Display the command usage.
  --debug                     : No help available.

Arguments:

  <idens> [<idens> ...]       : A list of job IDs to delete

swarm.job.list

List jobs from the swarm service.


Usage: swarm.job.list [options]

Options:

  --help                      : Display the command usage.
  --debug                     : No help available.
  --state <state>             : List jobs in the given state. (default: running)
  --tag <tag>                 : List jobs by the given tag. (default: None)

swarm.job.queue.list

List the job type queues status.


Usage: swarm.job.queue.list [options]

Options:

  --help                      : Display the command usage.

swarm.status

Print the status of the channel and job queues.


Usage: swarm.status [options]

Options:

  --help                      : Display the command usage.