Group

Description

This resource is used for managing group resources in Tower. It can also associate/disassociate one group to/from another group.

Fields Table

name type help_text read_only unique filterable required
name String The name field. False True True True
description String The description field. False False True False
inventory Resource inventory The inventory field. False False True True
variables variables Group variables, use “@” to get from file. False False True False

API Specification

class tower_cli.resources.group.Resource[source]

A resource for groups.

associate(group, parent, **kwargs)[source]

Associate this group with the specified group.

Parameters:
  • group (str) – Primary key or name of the child group to associate.
  • parent (str) – Primary key or name of the parent group to associate to.
  • inventory (str) – Primary key or name of the inventory the association should happen in.
Returns:

Dictionary of only one key “changed”, which indicates whether the association succeeded.
Return type:

dict
copy(pk=None, new_name=None, **kwargs)[source]

Copy an object.

Parameters:
  • pk (int) – Primary key of the resource object to be copied
  • new_name – The new name to give the resource if deep copying via the API
  • **kwargs – Keyword arguments of fields whose given value will override the original value.
Returns:

loaded JSON of the copied new resource object.
Return type:

dict
create(fail_on_found=False, force_on_exists=False, **kwargs)[source]

Create a group.

Parameters:
  • parent (str) – Primary key or name of the group which will be the parent of created group.
  • fail_on_found (bool) – Flag that if set, the operation fails if an object matching the unique criteria already exists.
  • force_on_exists (bool) – Flag that if set, then if a match is found on unique fields, other fields will be updated to the provided values.; If unset, a match causes the request to be a no-op.
  • **kwargs – Keyword arguments which, all together, will be used as POST body to create the resource object.
Returns:

A dictionary combining the JSON output of the created resource, as well as two extra fields: “changed”, a flag indicating if the resource is created successfully; “id”, an integer which is the primary key of the created object.
Return type:

dict
Raises:

tower_cli.exceptions.UsageError – When inventory is not provided in **kwargs and parent is not provided.
delete(pk=None, fail_on_missing=False, **kwargs)

Remove the given object.

Parameters:
  • pk (int) – Primary key of the resource to be deleted.
  • fail_on_missing (bool) – Flag that if set, the object’s not being found is considered a failure; otherwise, a success with no change is reported.
  • **kwargs – Keyword arguments used to look up resource object to delete if pk is not provided.
Returns:

dictionary of only one field “changed”, which is a flag indicating whether the specified resource is successfully deleted.
Return type:

dict
disassociate(group, parent, **kwargs)[source]

Disassociate this group with the specified group.

Parameters:
  • group (str) – Primary key or name of the child group to disassociate.
  • parent (str) – Primary key or name of the parent group to disassociate from.
  • inventory (str) – Primary key or name of the inventory the disassociation should happen in.
Returns:

Dictionary of only one key “changed”, which indicates whether the disassociation succeeded.
Return type:

dict
get(pk=None, **kwargs)

Retrieve one and exactly one object.

Parameters:
  • pk (int) – Primary key of the resource to be read. Tower CLI will only attempt to read that object if pk is provided (not None).
  • **kwargs – Keyword arguments used to look up resource object to retrieve if pk is not provided.
Returns:

loaded JSON of the retrieved resource object.
Return type:

dict
list(root=False, **kwargs)[source]

Retrieve a list of groups.

Parameters:
  • root (bool) – Flag that if set, only root groups of a specific inventory will be listed.
  • parent (str) – Primary key or name of the group whose child groups will be listed.
  • all_pages (bool) – Flag that if set, collect all pages of content from the API when returning results.
  • page (int) – The page to show. Ignored if all_pages is set.
  • query (list) – Contains 2-tuples used as query parameters to filter resulting resource objects.
  • **kwargs – Keyword arguments list of available fields used for searching resource objects.
Returns:

A JSON object containing details of all resource objects returned by Tower backend.
Return type:

dict
Raises:

tower_cli.exceptions.UsageError – When root flag is on and inventory is not present in **kwargs.
modify(pk=None, create_on_missing=False, **kwargs)[source]

Modify an already existing object.

Parameters:
  • pk (int) – Primary key of the resource to be modified.
  • create_on_missing (bool) – Flag that if set, a new object is created if pk is not set and objects matching the appropriate unique criteria is not found.
  • **kwargs – Keyword arguments which, all together, will be used as PATCH body to modify the resource object. if pk is not set, key-value pairs of **kwargs which are also in resource’s identity will be used to lookup existing reosource.
Returns:

A dictionary combining the JSON output of the modified resource, as well as two extra fields: “changed”, a flag indicating if the resource is successfully updated; “id”, an integer which is the primary key of the updated object.
Return type:

dict