1
0
mirror of https://github.com/ansible/tower-cli.git synced 2026-02-07 03:47:37 +01:00
Files
tower-cli/docs/source/api_ref/resources/inventory.rst
Aaron Tan bb80b53bd3 Prepare for 3.2.0 release
Specifically, updated docs, version number and release notes.

Signed-off-by: Aaron Tan <jangsutsr@gmail.com>
2017-10-04 12:27:47 -04:00

37 lines
2.7 KiB
ReStructuredText

Inventory
=========
Description
-----------
This resource is used for managing inventory resources in Tower.
Fields Table
------------
.. <table goes here>
+--------------------+----------------------+----------------------------------------------------+----------+-------+-----------+---------+
|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 |
+--------------------+----------------------+----------------------------------------------------+----------+-------+-----------+---------+
.. <table goes here>
API Specification
-----------------
.. autoclass:: tower_cli.resources.inventory.Resource
:members: copy, create, delete, get, list, modify, associate_ig, disassociate_ig, batch_update