watcherclient.v1.action module

class watcherclient.v1.action.Action(manager, info, loaded=False)

Bases: Resource

class watcherclient.v1.action.ActionManager(api)

Bases: Manager

get(action_id)

list(action_plan=None, audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)

Retrieve a list of action.

Parameters:

• action_plan – UUID of the action plan

• audit – UUID of the audit

• limit –

  The maximum number of results to return per

  request, if:

  1. limit > 0, the maximum number of actions to return.

  2. limit == 0, return the entire list of actions.

  3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher’s api.max_limit option).

• sort_key – Optional, field used for sorting.

• sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’.

• detail – Optional, boolean whether to return detailed information about actions.

• marker – Optional, UUID of the last action in the previous page.

Returns:

A list of actions.

resource_class

alias of Action