mirror of
https://github.com/ansible/awx.git
synced 2026-05-12 03:47:36 -02:30
Docs: Avoid use of 'default: null' (#45795)
Various modules document the default 'null' value, but it causes None to be shown in the documentation explicitly.
This commit is contained in:
@@ -1,7 +1,7 @@
|
|||||||
#!/usr/bin/python
|
#!/usr/bin/python
|
||||||
# coding: utf-8 -*-
|
# coding: utf-8 -*-
|
||||||
|
|
||||||
# (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
|
# Copyright: (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
|
||||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
from __future__ import absolute_import, division, print_function
|
from __future__ import absolute_import, division, print_function
|
||||||
@@ -74,13 +74,9 @@ options:
|
|||||||
client:
|
client:
|
||||||
description:
|
description:
|
||||||
- Client or application ID for azure_rm type.
|
- Client or application ID for azure_rm type.
|
||||||
required: False
|
|
||||||
default: null
|
|
||||||
security_token:
|
security_token:
|
||||||
description:
|
description:
|
||||||
- STS token for aws type.
|
- STS token for aws type.
|
||||||
required: False
|
|
||||||
default: null
|
|
||||||
version_added: "2.6"
|
version_added: "2.6"
|
||||||
secret:
|
secret:
|
||||||
description:
|
description:
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
#!/usr/bin/python
|
#!/usr/bin/python
|
||||||
# coding: utf-8 -*-
|
# coding: utf-8 -*-
|
||||||
#
|
|
||||||
# (c) 2018, Adrien Fleury <fleu42@gmail.com>
|
# Copyright: (c) 2018, Adrien Fleury <fleu42@gmail.com>
|
||||||
# GNU General Public License v3.0+
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
||||||
|
|
||||||
from __future__ import absolute_import, division, print_function
|
from __future__ import absolute_import, division, print_function
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
@@ -31,8 +30,6 @@ options:
|
|||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- The description to use for the inventory source.
|
- The description to use for the inventory source.
|
||||||
required: False
|
|
||||||
default: null
|
|
||||||
inventory:
|
inventory:
|
||||||
description:
|
description:
|
||||||
- The inventory the source is linked to.
|
- The inventory the source is linked to.
|
||||||
@@ -58,7 +55,6 @@ options:
|
|||||||
credential:
|
credential:
|
||||||
description:
|
description:
|
||||||
- Credential to use to retrieve the inventory from.
|
- Credential to use to retrieve the inventory from.
|
||||||
required: False
|
|
||||||
source_vars:
|
source_vars:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
@@ -66,24 +62,20 @@ options:
|
|||||||
file. For example with Openstack, specifying *private: false* would
|
file. For example with Openstack, specifying *private: false* would
|
||||||
change the output of the openstack.py script. It has to be YAML or
|
change the output of the openstack.py script. It has to be YAML or
|
||||||
JSON.
|
JSON.
|
||||||
required: False
|
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
- Number in seconds after which the Tower API methods will time out.
|
- Number in seconds after which the Tower API methods will time out.
|
||||||
source_project:
|
source_project:
|
||||||
description:
|
description:
|
||||||
- Use a *project* as a source for the *inventory*.
|
- Use a *project* as a source for the *inventory*.
|
||||||
required: False
|
|
||||||
source_path:
|
source_path:
|
||||||
description:
|
description:
|
||||||
- Path to the file to use as a source in the selected *project*.
|
- Path to the file to use as a source in the selected *project*.
|
||||||
required: False
|
|
||||||
update_on_project_update:
|
update_on_project_update:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
That parameter will sync the inventory when the project is synced. It
|
That parameter will sync the inventory when the project is synced. It
|
||||||
can only be used with a SCM source.
|
can only be used with a SCM source.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
source_regions:
|
source_regions:
|
||||||
description:
|
description:
|
||||||
@@ -91,27 +83,23 @@ options:
|
|||||||
List of regions for your cloud provider. You can include multiple all
|
List of regions for your cloud provider. You can include multiple all
|
||||||
regions. Only Hosts associated with the selected regions will be
|
regions. Only Hosts associated with the selected regions will be
|
||||||
updated. Refer to Ansible Tower documentation for more detail.
|
updated. Refer to Ansible Tower documentation for more detail.
|
||||||
required: False
|
|
||||||
instance_filters:
|
instance_filters:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
Provide a comma-separated list of filter expressions. Hosts are
|
Provide a comma-separated list of filter expressions. Hosts are
|
||||||
imported when all of the filters match. Refer to Ansible Tower
|
imported when all of the filters match. Refer to Ansible Tower
|
||||||
documentation for more detail.
|
documentation for more detail.
|
||||||
required: False
|
|
||||||
group_by:
|
group_by:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
Specify which groups to create automatically. Group names will be
|
Specify which groups to create automatically. Group names will be
|
||||||
created similar to the options selected. If blank, all groups above
|
created similar to the options selected. If blank, all groups above
|
||||||
are created. Refer to Ansible Tower documentation for more detail.
|
are created. Refer to Ansible Tower documentation for more detail.
|
||||||
required: False
|
|
||||||
source_script:
|
source_script:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
The source custom script to use to build the inventory. It needs to
|
The source custom script to use to build the inventory. It needs to
|
||||||
exist.
|
exist.
|
||||||
required: False
|
|
||||||
overwrite:
|
overwrite:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
@@ -123,7 +111,6 @@ options:
|
|||||||
left in the "all" default group for the inventory. When not checked,
|
left in the "all" default group for the inventory. When not checked,
|
||||||
local child hosts and groups not found on the external source will
|
local child hosts and groups not found on the external source will
|
||||||
remain untouched by the inventory update process.
|
remain untouched by the inventory update process.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
overwrite_vars:
|
overwrite_vars:
|
||||||
description:
|
description:
|
||||||
@@ -132,14 +119,12 @@ options:
|
|||||||
and replaced by those found on the external source. When not checked,
|
and replaced by those found on the external source. When not checked,
|
||||||
a merge will be performed, combining local variables with those found
|
a merge will be performed, combining local variables with those found
|
||||||
on the external source.
|
on the external source.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
update_on_launch:
|
update_on_launch:
|
||||||
description:
|
description:
|
||||||
- >-
|
- >-
|
||||||
Each time a job runs using this inventory, refresh the inventory from
|
Each time a job runs using this inventory, refresh the inventory from
|
||||||
the selected source before executing job tasks.
|
the selected source before executing job tasks.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
update_cache_timeout:
|
update_cache_timeout:
|
||||||
description:
|
description:
|
||||||
@@ -148,17 +133,14 @@ options:
|
|||||||
job runs and callbacks the task system will evaluate the timestamp of
|
job runs and callbacks the task system will evaluate the timestamp of
|
||||||
the latest sync. If it is older than Cache Timeout, it is not
|
the latest sync. If it is older than Cache Timeout, it is not
|
||||||
considered current, and a new inventory sync will be performed.
|
considered current, and a new inventory sync will be performed.
|
||||||
required: False
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Desired state of the resource.
|
- Desired state of the resource.
|
||||||
required: False
|
|
||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
tower_verify_ssl:
|
tower_verify_ssl:
|
||||||
description:
|
description:
|
||||||
- Tower option to avoid certificates check.
|
- Tower option to avoid certificates check.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
extends_documentation_fragment: tower
|
extends_documentation_fragment: tower
|
||||||
'''
|
'''
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
#!/usr/bin/python
|
#!/usr/bin/python
|
||||||
# coding: utf-8 -*-
|
# coding: utf-8 -*-
|
||||||
#
|
|
||||||
# (c) 2018, Adrien Fleury <fleu42@gmail.com>
|
# Copyright: (c) 2018, Adrien Fleury <fleu42@gmail.com>
|
||||||
# GNU General Public License v3.0+
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
||||||
|
|
||||||
from __future__ import absolute_import, division, print_function
|
from __future__ import absolute_import, division, print_function
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
@@ -27,18 +26,13 @@ options:
|
|||||||
allow_simultaneous:
|
allow_simultaneous:
|
||||||
description:
|
description:
|
||||||
- If enabled, simultaneous runs of this job template will be allowed.
|
- If enabled, simultaneous runs of this job template will be allowed.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- The description to use for the workflow.
|
- The description to use for the workflow.
|
||||||
required: False
|
|
||||||
default: null
|
|
||||||
extra_vars:
|
extra_vars:
|
||||||
description:
|
description:
|
||||||
- >
|
- Extra variables used by Ansible in YAML or key=value format.
|
||||||
Extra variables used by Ansible in YAML or key=value format.
|
|
||||||
required: False
|
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The name to use for the workflow.
|
- The name to use for the workflow.
|
||||||
@@ -46,28 +40,23 @@ options:
|
|||||||
organization:
|
organization:
|
||||||
description:
|
description:
|
||||||
- The organization the workflow is linked to.
|
- The organization the workflow is linked to.
|
||||||
required: False
|
|
||||||
schema:
|
schema:
|
||||||
description:
|
description:
|
||||||
- >
|
- >
|
||||||
The schema is a JSON- or YAML-formatted string defining the
|
The schema is a JSON- or YAML-formatted string defining the
|
||||||
hierarchy structure that connects the nodes. Refer to Tower
|
hierarchy structure that connects the nodes. Refer to Tower
|
||||||
documentation for more information.
|
documentation for more information.
|
||||||
required: False
|
|
||||||
survey_enabled:
|
survey_enabled:
|
||||||
description:
|
description:
|
||||||
- Setting that variable will prompt the user for job type on the
|
- Setting that variable will prompt the user for job type on the
|
||||||
workflow launch.
|
workflow launch.
|
||||||
required: False
|
|
||||||
type: bool
|
type: bool
|
||||||
survey:
|
survey:
|
||||||
description:
|
description:
|
||||||
- The definition of the survey associated to the workflow.
|
- The definition of the survey associated to the workflow.
|
||||||
required: False
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Desired state of the resource.
|
- Desired state of the resource.
|
||||||
required: False
|
|
||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
extends_documentation_fragment: tower
|
extends_documentation_fragment: tower
|
||||||
|
|||||||
Reference in New Issue
Block a user