Inventory

Description

This resource is used for managing inventory resources in Tower.

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
organization Resource organization The organization field. False False True True
variables variables Inventory variables, use “@” to get from file. False False True False
kind Choices: ,smart The kind field. Cannot be modified after created. False False True False
host_filter String The host_filter field. Only useful when kind=smart. False False True False
insights_credential Resource credential The insights_credential field. False False True False

API Specification

class tower_cli.resources.inventory.Resource[source]

A resource for inventories.

associate_ig(**kwargs)

Associate an ig with this inventory.

Parameters:
  • inventory (str) – Primary key or name of the inventory to associate to.
  • instance_group (str) – Primary key or name of the instance_group to be associated.
Returns:

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

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

Update all related inventory sources of the given inventory.

Parameters:
  • pk (int) – Primary key of the given inventory.
  • **kwargs – Keyword arguments list of available fields used for searching resource objects.
Returns:

A JSON object of update status of the given inventory.
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(**kwargs)[source]

Create an object.

Parameters:
  • 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
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_ig(**kwargs)

Disassociate an ig with this inventory.

Parameters:
  • inventory (str) – Primary key or name of the inventory to disassociate to.
  • instance_group (str) – Primary key or name of the instance_group to be disassociated.
Returns:

Dictionary of only one key “changed”, which indicates whether the disassociate 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(all_pages=False, **kwargs)

Retrieve a list of objects.

Parameters:
  • 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
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