APIv6 provides the Action API facade for version 6.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Action"
VERSION: number = 6
_transport: Transport
NAME: string = "Action"
VERSION: number = 6

Methods

  • Actions takes a list of ActionTags, and returns the full Action for each ID.

    Parameters

    Returns Promise<ActionResults>

  • Cancel attempts to cancel enqueued Actions from running.

    Parameters

    Returns Promise<ActionResults>

  • Enqueue takes a list of Actions and queues them up to be executed by the designated ActionReceiver, returning the params.Action for each enqueued Action, or an error if there was a problem enqueueing the Action.

    Parameters

    Returns Promise<ActionResults>

  • EnqueueOperation takes a list of Actions and queues them up to be executed as an operation, each action running as a task on the the designated ActionReceiver. We return the ID of the overall operation and each individual task.

    Parameters

    Returns Promise<EnqueuedActions>

  • FindActionTagsByPrefix takes a list of string prefixes and finds corresponding ActionTags that match that prefix. TODO(juju3) - rename API method since we only need prefix matching for UUIDs

    Parameters

    Returns Promise<FindTagsResults>

  • ListAll takes a list of Entities representing ActionReceivers and returns all of the Actions that have been enqueued or run by each of those Entities.

    Parameters

    Returns Promise<ActionsByReceivers>

  • ListCompleted takes a list of Entities representing ActionReceivers and returns all of the Actions that have been run on each of those Entities.

    Parameters

    Returns Promise<ActionsByReceivers>

  • ListPending takes a list of Entities representing ActionReceivers and returns all of the Actions that are enqueued for each of those Entities.

    Parameters

    Returns Promise<ActionsByReceivers>

  • ListRunning takes a list of Entities representing ActionReceivers and returns all of the Actions that have are running on each of those Entities.

    Parameters

    Returns Promise<ActionsByReceivers>

  • Run the commands specified on the machines identified through the list of machines, units and services.

    Parameters

    Returns Promise<ActionResults>

  • RunOnAllMachines attempts to run the specified command on all the machines.

    Parameters

    Returns Promise<ActionResults>

Generated using TypeDoc