Inventory Source
================

Description
-----------

This resource is used for managing and executing inventory sources via Tower. Note inventory updates are triggered
via ``update`` method.

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    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|inventory                |Resource inventory                                                                      |The inventory field.                       |False     |False  |True       |True     |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|source                   |Choices: ,file,scm,ec2,vmware,gce,azure,azure_rm,openstack,satellite6,cloudforms,custom |The type of inventory source in use.       |False     |False  |True       |True     |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|credential               |Resource credential                                                                     |The credential field.                      |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|source_vars              |String                                                                                  |The source_vars field.                     |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|timeout                  |int                                                                                     |The timeout field (in seconds).            |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|source_project           |Resource project                                                                        |Use project files as source for inventory. |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|source_path              |String                                                                                  |File in SCM Project to use as source.      |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|update_on_project_update |bool                                                                                    |The update_on_project_update field.        |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|source_regions           |String                                                                                  |The source_regions field.                  |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|instance_filters         |String                                                                                  |The instance_filters field.                |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|group_by                 |String                                                                                  |The group_by field.                        |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|source_script            |Resource inventory_script                                                               |The source_script field.                   |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|overwrite                |bool                                                                                    |The overwrite field.                       |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|overwrite_vars           |bool                                                                                    |The overwrite_vars field.                  |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|update_on_launch         |bool                                                                                    |The update_on_launch field.                |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+
|update_cache_timeout     |int                                                                                     |The update_cache_timeout field.            |False     |False  |True       |False    |
+-------------------------+----------------------------------------------------------------------------------------+-------------------------------------------+----------+-------+-----------+---------+

.. <table goes here>

API Specification
-----------------
.. autoclass:: tower_cli.resources.inventory_source.Resource
   :members: copy, create, delete, get, list, modify, monitor, status, update, wait
