Job Template
============

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

This resource is used for managing job template resources in Tower. It is also responsible to associate/disassociate
labels and notification templates to/from an existing job template. There is yet another custom command, ``survey``,
used for getting survey specification of a job template.

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    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|job_type                 |Choices: run,check  |The job_type field.                                                                                                                                             |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|inventory                |Resource inventory  |The inventory field.                                                                                                                                            |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|project                  |Resource project    |The project field.                                                                                                                                              |False     |False  |True       |True     |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|playbook                 |String              |The playbook field.                                                                                                                                             |False     |False  |True       |True     |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|credential               |Resource credential |The credential field.                                                                                                                                           |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|vault_credential         |Resource credential |The vault_credential field.                                                                                                                                     |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|forks                    |int                 |The forks field.                                                                                                                                                |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|limit                    |String              |The limit field.                                                                                                                                                |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|verbosity                |mapped_choice       |The verbosity field.                                                                                                                                            |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|extra_vars               |variables           |Extra variables used by Ansible in YAML or key=value format. Use @ to get YAML from a file.                                                                     |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|job_tags                 |String              |The job_tags field.                                                                                                                                             |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|force_handlers           |bool                |The force_handlers field.                                                                                                                                       |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|skip_tags                |String              |The skip_tags field.                                                                                                                                            |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|start_at_task            |String              |The start_at_task field.                                                                                                                                        |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|timeout                  |int                 |The amount of time (in seconds) to run before the task is canceled.                                                                                             |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|use_fact_cache           |bool                |If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|host_config_key          |String              |Allow Provisioning Callbacks using this host config key                                                                                                         |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_diff_mode_on_launch  |bool                |Ask diff mode on launch.                                                                                                                                        |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_variables_on_launch  |bool                |Prompt user for extra_vars on launch.                                                                                                                           |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_limit_on_launch      |bool                |Prompt user for host limits on launch.                                                                                                                          |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_tags_on_launch       |bool                |Prompt user for job tags on launch.                                                                                                                             |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_skip_tags_on_launch  |bool                |Prompt user for tags to skip on launch.                                                                                                                         |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_job_type_on_launch   |bool                |Prompt user for job type on launch.                                                                                                                             |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_verbosity_on_launch  |bool                |Prompt user for verbosity on launch.                                                                                                                            |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_inventory_on_launch  |bool                |Prompt user for inventory on launch.                                                                                                                            |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|ask_credential_on_launch |bool                |Prompt user for machine credential on launch.                                                                                                                   |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|survey_enabled           |bool                |Prompt user for job type on launch.                                                                                                                             |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|become_enabled           |bool                |The become_enabled field.                                                                                                                                       |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|diff_mode                |bool                |If enabled, textual changes made to any templated files on the host are shown in the standard output.                                                           |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|allow_simultaneous       |bool                |The allow_simultaneous field.                                                                                                                                   |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|survey_spec              |variables           |On write commands, perform extra POST to the survey_spec endpoint.                                                                                              |False     |False  |True       |False    |
+-------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+

.. <table goes here>

API Specification
-----------------
.. autoclass:: tower_cli.resources.job_template.Resource
   :members: copy, create, delete, get, list, modify, survey, associate_label, disassociate_label, associate_notification_template, disassociate_notification_template, associate_credential, disassociate_credential, associate_ig, disassociate_ig, callback
