ansible_tower modules doc: fix typos, use formatting functions (#37414)

* fix typos

* use formatting functions

* use 'job template' instead of 'job_template'

* acronyms: user uppercase

* become_enabled param is about privilege escalation
pull/37447/head
Pilou 6 years ago committed by Jordan Borean
parent 4bba66e664
commit c718c42df4

@ -80,12 +80,12 @@ options:
- Unlock password for ssh_key. Use ASK for prompting. - Unlock password for ssh_key. Use ASK for prompting.
authorize: authorize:
description: description:
- Should use authroize for net type. - Should use authorize for net type.
required: False required: False
default: False default: False
authorize_password: authorize_password:
description: description:
- Password for net credentials that require authroize. - Password for net credentials that require authorize.
required: False required: False
default: null default: null
client: client:

@ -38,7 +38,7 @@ options:
required: True required: True
variables: variables:
description: description:
- Variables to use for the group, use '@' for a file. - Variables to use for the group, use C(@) for a file.
required: False required: False
default: null default: null
credential: credential:
@ -74,12 +74,12 @@ options:
default: null default: null
source_script: source_script:
description: description:
- Inventory script to be used when group type is "custom". - Inventory script to be used when group type is C(custom).
required: False required: False
default: null default: null
overwrite: overwrite:
description: description:
- Delete child roups and hosts not found in source. - Delete child groups and hosts not found in source.
required: False required: False
default: False default: False
overwrite_vars: overwrite_vars:

@ -43,7 +43,7 @@ options:
default: True default: True
variables: variables:
description: description:
- Variables to use for the host. Use '@' for a file. - Variables to use for the host. Use C(@) for a file.
state: state:
description: description:
- Desired state of the resource. - Desired state of the resource.

@ -38,7 +38,7 @@ options:
required: True required: True
variables: variables:
description: description:
- Inventory variables. Use '@' to get from file. - Inventory variables. Use C(@) to get from file.
required: False required: False
default: null default: null
state: state:

@ -29,7 +29,7 @@ options:
required: True required: True
fail_if_not_running: fail_if_not_running:
description: description:
- Fail loudly if the job_id does not reference a running job. - Fail loudly if the I(job_id) does not reference a running job.
default: False default: False
extends_documentation_fragment: tower extends_documentation_fragment: tower
''' '''

@ -25,7 +25,7 @@ description:
options: options:
job_template: job_template:
description: description:
- Name of the job_template to use. - Name of the job template to use.
required: True required: True
job_explanation: job_explanation:
description: description:
@ -46,11 +46,11 @@ options:
default: null default: null
extra_vars: extra_vars:
description: description:
- Extra_vars to use for the job_template. Prepend '@' if a file. - Extra_vars to use for the job_template. Prepend C(@) if a file.
default: null default: null
limit: limit:
description: description:
- Limit to use for the job_template. - Limit to use for the I(job_template).
default: null default: null
tags: tags:
description: description:

@ -38,7 +38,7 @@ options:
default: False default: False
query: query:
description: description:
- Query used to further filter the list of jobs. {"foo":"bar"} will be passed at ?foo=bar - Query used to further filter the list of jobs. C({"foo":"bar"}) will be passed at C(?foo=bar)
default: null default: null
extends_documentation_fragment: tower extends_documentation_fragment: tower
''' '''

@ -18,7 +18,7 @@ DOCUMENTATION = '''
module: tower_job_template module: tower_job_template
author: "Wayne Witzel III (@wwitzel3)" author: "Wayne Witzel III (@wwitzel3)"
version_added: "2.3" version_added: "2.3"
short_description: create, update, or destroy Ansible Tower job_template. short_description: create, update, or destroy Ansible Tower job template.
description: description:
- Create, update, or destroy Ansible Tower job templates. See - Create, update, or destroy Ansible Tower job templates. See
U(https://www.ansible.com/tower) for an overview. U(https://www.ansible.com/tower) for an overview.
@ -29,40 +29,40 @@ options:
required: True required: True
description: description:
description: description:
- Description to use for the job_template. - Description to use for the job template.
required: False required: False
default: null default: null
job_type: job_type:
description: description:
- The job_type to use for the job_template. - The job_type to use for the job template.
required: True required: True
choices: ["run", "check", "scan"] choices: ["run", "check", "scan"]
inventory: inventory:
description: description:
- Inventory to use for the job_template. - Inventory to use for the job template.
required: False required: False
default: null default: null
project: project:
description: description:
- Project to use for the job_template. - Project to use for the job template.
required: True required: True
playbook: playbook:
description: description:
- Playbook to use for the job_template. - Playbook to use for the job template.
required: True required: True
machine_credential: machine_credential:
description: description:
- Machine_credential to use for the job_template. - Machine_credential to use for the job template.
required: False required: False
default: null default: null
cloud_credential: cloud_credential:
description: description:
- Cloud_credential to use for the job_template. - Cloud_credential to use for the job template.
required: False required: False
default: null default: null
network_credential: network_credential:
description: description:
- The network_credential to use for the job_template. - The network_credential to use for the job template.
required: False required: False
default: null default: null
forks: forks:
@ -83,12 +83,12 @@ options:
default: null default: null
job_tags: job_tags:
description: description:
- The job_tags to use for the job_template. - The job_tags to use for the job template.
required: False required: False
default: null default: null
skip_tags: skip_tags:
description: description:
- The skip_tags to use for the job_template. - The skip_tags to use for the job template.
required: False required: False
default: null default: null
host_config_key: host_config_key:
@ -98,12 +98,12 @@ options:
default: null default: null
extra_vars_path: extra_vars_path:
description: description:
- Path to the extra_vars yaml file. - Path to the C(extra_vars) YAML file.
required: False required: False
default: null default: null
ask_extra_vars: ask_extra_vars:
description: description:
- Prompt user for extra_vars on launch. - Prompt user for C(extra_vars) on launch.
required: False required: False
default: False default: False
ask_tags: ask_tags:
@ -128,7 +128,7 @@ options:
default: False default: False
become_enabled: become_enabled:
description: description:
- Should become_enabled. - Activate privilege escalation.
required: False required: False
default: False default: False
state: state:

@ -35,13 +35,13 @@ options:
default: null default: null
scm_type: scm_type:
description: description:
- Type of scm resource. - Type of SCM resource.
required: False required: False
default: "manual" default: "manual"
choices: ["manual", "git", "hg", "svn"] choices: ["manual", "git", "hg", "svn"]
scm_url: scm_url:
description: description:
- URL of scm resource. - URL of SCM resource.
required: False required: False
default: null default: null
local_path: local_path:
@ -51,12 +51,12 @@ options:
default: null default: null
scm_branch: scm_branch:
description: description:
- The branch to use for the scm resource. - The branch to use for the SCM resource.
required: False required: False
default: null default: null
scm_credential: scm_credential:
description: description:
- Name of the credential to use with this scm resource. - Name of the credential to use with this SCM resource.
required: False required: False
default: null default: null
scm_clean: scm_clean:

@ -50,7 +50,7 @@ options:
default: null default: null
job_template: job_template:
description: description:
- The job_template the role acts on. - The job template the role acts on.
required: False required: False
default: null default: null
credential: credential:
@ -60,7 +60,7 @@ options:
default: null default: null
organization: organization:
description: description:
- Organiation the role acts on. - Organization the role acts on.
required: False required: False
default: null default: null
project: project:

Loading…
Cancel
Save