watcherclient.v1 package

Submodules

Module contents

class watcherclient.v1.Action(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.ActionManager(api)[source]

Bases: Manager

get(action_id)[source]
list(action_plan=None, audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]

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

class watcherclient.v1.ActionPlan(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.ActionPlanManager(api)[source]

Bases: Manager

cancel(action_plan_id)[source]
delete(action_plan_id)[source]
get(action_plan_id)[source]
list(audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]

Retrieve a list of action plan.

Parameters:

  • audit – Name of the audit

  • limit –

    The maximum number of results to return per

    request, if:

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

    2. limit == 0, return the entire list of action plans.

    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 action plans.

  • marker – The last actionplan UUID of the previous page; displays list of actionplans after “marker”.

Returns:

A list of action plans.

resource_class

alias of ActionPlan

start(action_plan_id)[source]
update(action_plan_id, patch)[source]
class watcherclient.v1.Audit(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.AuditManager(api)[source]

Bases: Manager

create(**kwargs)[source]
delete(audit)[source]
get(audit)[source]
list(audit_template=None, limit=None, sort_key=None, sort_dir=None, detail=False, goal=None, strategy=None, marker=None)[source]

Retrieve a list of audit.

Parameters:

  • audit_template – Name of the audit template

  • limit –

    The maximum number of results to return per

    request, if:

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

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

    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 audits.

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

Returns:

A list of audits.

resource_class

alias of Audit

update(audit, patch)[source]
class watcherclient.v1.AuditTemplate(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.AuditTemplateManager(api)[source]

Bases: Manager

create(**kwargs)[source]
delete(audit_template_id)[source]
get(audit_template_id)[source]
list(name=None, goal=None, strategy=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]

Retrieve a list of audit template.

Parameters:

  • name – Name of the audit template

  • limit –

    The maximum number of results to return per

    request, if:

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

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

    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 audit_templates.

  • marker – Optional, UUID of the last audit template of the previous page.

Returns:

A list of audit templates.

resource_class

alias of AuditTemplate

update(audit_template_id, patch)[source]
class watcherclient.v1.DataModel(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.DataModelManager(api)[source]

Bases: Manager

list(data_model_type='compute', audit=None)[source]

Retrieve a list of data model.

Parameters:

  • data_model_type – The type of data model user wants to list. Supported values: compute. Future support values: storage, baremetal. The default value is compute.

  • audit – The UUID of the audit, used to filter data model by the scope in audit.

Returns:

A list of data model.

resource_class

alias of DataModel

class watcherclient.v1.Goal(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.GoalManager(api)[source]

Bases: Manager

get(goal)[source]
list(limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]

Retrieve a list of goal.

Parameters:

  • limit –

    The maximum number of results to return per

    request, if:

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

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

    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 audits.

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

Returns:

A list of goals.

resource_class

alias of Goal

class watcherclient.v1.ScoringEngine(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.ScoringEngineManager(api)[source]

Bases: Manager

get(scoring_engine_name)[source]
list(limit=None, sort_key=None, sort_dir=None, detail=False)[source]

Retrieve a list of scoring engines.

Parameters:

  • limit –

    The maximum number of results to return per

    request, if:

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

    2. limit == 0, return the entire list of scoring engines.

    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 scoring engines.

Returns:

A list of scoring engines.

resource_class

alias of ScoringEngine

class watcherclient.v1.Service(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.ServiceManager(api)[source]

Bases: Manager

get(service)[source]
list(limit=None, sort_key=None, sort_dir=None, detail=False)[source]

Retrieve a list of services.

Parameters:

  • limit –

    The maximum number of results to return per

    request, if:

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

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

    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 services.

Returns:

A list of services.

resource_class

alias of Service

class watcherclient.v1.Strategy(manager, info, loaded=False)[source]

Bases: Resource

class watcherclient.v1.StrategyManager(api)[source]

Bases: Manager

get(strategy)[source]
list(goal=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]

Retrieve a list of strategy.

Parameters:

  • goal – The UUID of the goal to filter by

  • limit –

    The maximum number of results to return per

    request, if:

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

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

    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 audits.

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

Returns:

A list of audits.

resource_class

alias of Strategy

state(strategy)[source]