mirror of
https://github.com/ansible/awx.git
synced 2026-02-21 13:10:11 -03:30
Update documentation for modules, add deprecation warning for role, send and receive modules
Update variables in tower_inventory to be in dict format
This commit is contained in:
@@ -69,6 +69,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -33,6 +33,7 @@ options:
|
||||
- A new name for this group (for renaming)
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
description:
|
||||
description:
|
||||
- The description to use for the group.
|
||||
@@ -57,6 +58,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
@@ -80,7 +82,7 @@ def main():
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
new_name=dict(required=False),
|
||||
description=dict(),
|
||||
description=dict(required=False),
|
||||
inventory=dict(required=True),
|
||||
variables=dict(type='dict', required=False),
|
||||
state=dict(choices=['present', 'absent'], default='present'),
|
||||
|
||||
@@ -33,6 +33,7 @@ options:
|
||||
- To use when changing a hosts's name.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
description:
|
||||
description:
|
||||
- The description to use for the host.
|
||||
@@ -62,6 +63,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
@@ -88,7 +90,7 @@ def main():
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
new_name=dict(required=False),
|
||||
description=dict(default=''),
|
||||
description=dict(required=False),
|
||||
inventory=dict(required=True),
|
||||
enabled=dict(type='bool', default=True),
|
||||
variables=dict(type='dict', required=False),
|
||||
|
||||
@@ -39,8 +39,9 @@ options:
|
||||
type: str
|
||||
variables:
|
||||
description:
|
||||
- Inventory variables. Use C(@) to get from file.
|
||||
type: str
|
||||
- Inventory variables.
|
||||
required: False
|
||||
type: dict
|
||||
kind:
|
||||
description:
|
||||
- The kind field. Cannot be modified after created.
|
||||
@@ -64,6 +65,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
@@ -86,9 +88,9 @@ def main():
|
||||
# Any additional arguments that are not fields of the item can be added here
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
description=dict(default=''),
|
||||
description=dict(required=False),
|
||||
organization=dict(required=True),
|
||||
variables=dict(default=''),
|
||||
variables=dict(type='dict', required=False),
|
||||
kind=dict(choices=['', 'smart'], default=''),
|
||||
host_filter=dict(),
|
||||
state=dict(choices=['present', 'absent'], default='present'),
|
||||
|
||||
@@ -33,6 +33,7 @@ options:
|
||||
- A new name for this assets (will rename the asset)
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
description:
|
||||
description:
|
||||
- The description to use for the inventory source.
|
||||
@@ -127,6 +128,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
@@ -152,7 +154,7 @@ def main():
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
new_name=dict(type='str'),
|
||||
description=dict(),
|
||||
description=dict(required=False),
|
||||
inventory=dict(required=True),
|
||||
#
|
||||
# How do we handle manual and file? Tower does not seem to be able to activate them
|
||||
|
||||
@@ -38,6 +38,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -64,29 +64,35 @@ options:
|
||||
- A specific of the SCM project to run the template on.
|
||||
- This is only applicable if your project allows for branch override.
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
skip_tags:
|
||||
description:
|
||||
- Specific tags to skip from the playbook.
|
||||
type: list
|
||||
elements: str
|
||||
version_added: "3.7"
|
||||
verbosity:
|
||||
description:
|
||||
- Verbosity level for this job run
|
||||
type: int
|
||||
choices: [ 0, 1, 2, 3, 4, 5 ]
|
||||
version_added: "3.7"
|
||||
diff_mode:
|
||||
description:
|
||||
- Show the changes made by Ansible tasks where supported
|
||||
type: bool
|
||||
version_added: "3.7"
|
||||
credential_passwords:
|
||||
description:
|
||||
- Passwords for credentials which are set to prompt on launch
|
||||
type: dict
|
||||
version_added: "3.7"
|
||||
tower_oauthtoken:
|
||||
description:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -46,6 +46,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -27,16 +27,19 @@ options:
|
||||
- The contents of the license file
|
||||
required: True
|
||||
type: dict
|
||||
version_added: "3.7"
|
||||
eula_accepted:
|
||||
description:
|
||||
- Whether or not the EULA is accepted.
|
||||
required: True
|
||||
type: bool
|
||||
version_added: "3.7"
|
||||
tower_oauthtoken:
|
||||
description:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -45,6 +45,7 @@ options:
|
||||
default: "0"
|
||||
type: int
|
||||
required: False
|
||||
version_added: "3.7"
|
||||
state:
|
||||
description:
|
||||
- Desired state of the resource.
|
||||
@@ -56,6 +57,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -56,6 +56,7 @@ options:
|
||||
- The refspec to use for the SCM resource.
|
||||
type: str
|
||||
default: ''
|
||||
version_added: "3.7"
|
||||
scm_credential:
|
||||
description:
|
||||
- Name of the credential to use with this SCM resource.
|
||||
@@ -86,6 +87,7 @@ options:
|
||||
description:
|
||||
- Allow changing the SCM branch or revision in a job template that uses this project.
|
||||
type: bool
|
||||
version_added: "3.7"
|
||||
job_timeout:
|
||||
version_added: "2.8"
|
||||
description:
|
||||
@@ -123,6 +125,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
@@ -175,7 +178,7 @@ def main():
|
||||
# Any additional arguments that are not fields of the item can be added here
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
description=dict(required=False, default=''),
|
||||
description=dict(required=False),
|
||||
scm_type=dict(required=False, choices=['manual', 'git', 'hg', 'svn', 'insights'], default='manual'),
|
||||
scm_url=dict(required=False),
|
||||
local_path=dict(required=False),
|
||||
|
||||
@@ -162,6 +162,8 @@ def main():
|
||||
|
||||
module = TowerModule(argument_spec=argument_spec, supports_check_mode=False)
|
||||
|
||||
module.deprecate(msg="This module is being moved to a different collection. Instead of awx.awx it will be migrated into awx.tower_cli", version="3.7")
|
||||
|
||||
if not HAS_TOWER_CLI:
|
||||
module.fail_json(msg='ansible-tower-cli required for this module')
|
||||
|
||||
|
||||
@@ -141,6 +141,8 @@ def main():
|
||||
|
||||
module = TowerModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||
|
||||
module.deprecate(msg="This module is being moved to a different collection. Instead of awx.awx it will be migrated into awx.tower_cli", version="3.7")
|
||||
|
||||
role_type = module.params.pop('role')
|
||||
state = module.params.pop('state')
|
||||
|
||||
|
||||
@@ -106,6 +106,8 @@ def main():
|
||||
|
||||
module = TowerModule(argument_spec=argument_spec, supports_check_mode=False)
|
||||
|
||||
module.deprecate(msg="This module is being moved to a different collection. Instead of awx.awx it will be migrated into awx.tower_cli", version="3.7")
|
||||
|
||||
if not HAS_TOWER_CLI:
|
||||
module.fail_json(msg='ansible-tower-cli required for this module')
|
||||
|
||||
|
||||
@@ -38,11 +38,13 @@ options:
|
||||
- A data structure to be sent into the settings endpoint
|
||||
required: False
|
||||
type: dict
|
||||
version_added: "3.7"
|
||||
tower_oauthtoken:
|
||||
description:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
@@ -33,9 +33,11 @@ options:
|
||||
- To use when changing a team's name.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
description:
|
||||
description:
|
||||
- The description to use for the team.
|
||||
required: False
|
||||
type: str
|
||||
organization:
|
||||
description:
|
||||
@@ -53,6 +55,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
@@ -75,7 +78,7 @@ def main():
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
new_name=dict(required=False),
|
||||
description=dict(),
|
||||
description=dict(required=False),
|
||||
organization=dict(required=True),
|
||||
state=dict(choices=['present', 'absent'], default='present'),
|
||||
)
|
||||
|
||||
@@ -66,6 +66,7 @@ options:
|
||||
- The Tower OAuth token to use.
|
||||
required: False
|
||||
type: str
|
||||
version_added: "3.7"
|
||||
extends_documentation_fragment: awx.awx.auth
|
||||
'''
|
||||
|
||||
|
||||
Reference in New Issue
Block a user