Module DOCUMENTATION should match argspec (#34895)

* Module DOCUMENTATION should match argspec

Large update of many modules so that DOCUMENTATION option name and
aliases match those defined in the argspec.

Issues identified by https://github.com/ansible/ansible/pull/34809

In addition to many typos and missing aliases, the following notable
changes were made:

* Create `module_docs_fragments/url.py` for `url_argument_spec`
* `dellos*_command` shouldn't have ever had `waitfor` (was incorrectly copied)
* `ce_aaa_server_host.py` `s/raduis_server_type/radius_server_type/g`
* `Junos_lldp` enable should be part of `state`.
This commit is contained in:
John R Barker 2018-01-16 12:18:51 +00:00 committed by GitHub
commit 195beebcb4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
123 changed files with 406 additions and 132 deletions

View file

@ -158,6 +158,8 @@ options:
choices: ['success', 'fail']
default: 'success'
required: false
extends_documentation_fragment:
- aws
requirements:
- "python >= 2.6"
- boto

View file

@ -25,7 +25,9 @@ requirements:
- boto3
author:
- Will Thames (@willthames)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -63,6 +63,7 @@ author:
- 'Michael De La Rue (@mikedlr)'
extends_documentation_fragment:
- aws
- ec2
notes:
- A future version of this module will probably use tags or another
ID so that an API can be create only once.

View file

@ -17,6 +17,9 @@ description:
The connection may later be associated or disassociated with a link aggregation group.
version_added: "2.4"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto3
- botocore
@ -36,7 +39,7 @@ options:
description:
- The ID of the Direct Connect connection. I(name) or I(connection_id) is
required to recreate or delete a connection. Modifying attributes of a
connection with I(force_update) will result in a new Direct Connect connection ID.
connection with I(forced_update) will result in a new Direct Connect connection ID.
location:
description:
- Where the Direct Connect connection is located. Required when I(state=present).
@ -50,7 +53,7 @@ options:
description:
- The ID of the link aggregation group you want to associate with the connection.
This is optional in case a stand-alone connection is desired.
force_update:
forced_update:
description:
- To modify bandwidth or location the connection will need to be deleted and recreated.
By default this will not happen - this option must be set to True.
@ -80,7 +83,7 @@ aws_direct_connect_connection:
name: ansible-test-connection
location: EqDC2
bandwidth: 10Gbps
force_update: True
forced_update: True
# delete the connection
aws_direct_connect_connection:

View file

@ -21,6 +21,9 @@ description:
- Deletes AWS Direct Connect Gateway
- Attaches Virtual Gateways to Direct Connect Gateway
- Detaches Virtual Gateways to Direct Connect Gateway
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3 ]
options:
state:

View file

@ -15,6 +15,9 @@ description:
- Create, delete, or modify a Direct Connect link aggregation group.
version_added: "2.4"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto3
- botocore

View file

@ -143,7 +143,9 @@ requirements: [ "boto3", "botocore" ]
author:
- "Lester Wade (@lwade)"
- "Sloane Hertel (@s-hertel)"
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -32,6 +32,7 @@ options:
choices: [ 'present', 'absent' ]
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -21,7 +21,9 @@ options:
author:
- Mike Mochan (@mmochan)
- Will Thames (@willthames)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -93,7 +93,7 @@ options:
I(domain_name_alias) to be specified.
required: false
default: false
streaming_distribution_configuration:
streaming_distribution_config:
description:
- Get the configuration information about a specified RTMP distribution.
Requires I(distribution_id) or I(domain_name_alias) to be specified.
@ -214,11 +214,11 @@ streaming_distribution:
I(distribution_id) or I(domain_name_alias) to be specified.
returned: only if I(streaming_distribution) is true
type: dict
streaming_distribution_configuration:
streaming_distribution_config:
description: >
Describes the streaming configuration information for the distribution.
Requires I(distribution_id) or I(domain_name_alias) to be specified.
returned: only if I(streaming_distribution_configuration) is true
returned: only if I(streaming_distribution_config) is true
type: dict
summary:
description: Gives a summary of distributions, streaming distributions and origin access identities.

View file

@ -20,6 +20,7 @@ description:
version_added: "2.2"
extends_documentation_fragment:
- aws
- ec2
author: "Jim Dalton (@jsdalton) <jim.dalton@gmail.com>"
requirements:
- python >= 2.6

View file

@ -55,6 +55,7 @@ options:
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3 ]
author:
- "Vincent Viallet (@zbal)"

View file

@ -51,6 +51,8 @@ options:
requirements:
- "python >= 2.6"
- boto3
extends_documentation_fragment:
- aws
"""
EXAMPLES = '''

View file

@ -26,6 +26,8 @@ description:
The module must be called from within the EC2 instance itself.
notes:
- Parameters to filter on ec2_metadata_facts may be added later.
extends_documentation_fragment:
- url
'''
EXAMPLES = '''

View file

@ -108,7 +108,9 @@ options:
default: present
choices: [ 'absent', 'present' ]
version_added: "2.1"
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto
"""

View file

@ -33,7 +33,7 @@ options:
- Provide this value as a list
required: false
default: None
aliases: ['DhcpOptionsIds']
aliases: ['DhcpOptionIds']
extends_documentation_fragment:
- aws
- ec2

View file

@ -39,7 +39,9 @@ options:
required: false
default: None
author: Karen Cheng(@Etherdaemon)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -63,7 +63,9 @@ options:
choices: ['present', 'absent']
default: present
author: Mike Mochan(@mmochan)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements: [ botocore, boto3, json ]
'''

View file

@ -51,7 +51,9 @@ options:
default: present
choices: ['present', 'absent', 'accept', 'reject']
author: Mike Mochan(@mmochan)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements: [ botocore, boto3, json ]
'''

View file

@ -31,7 +31,9 @@ options:
required: false
default: None
author: Karen Cheng(@Etherdaemon)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -59,7 +59,6 @@ options:
aliases: [ "resource_tags" ]
author: Nick Aslanidis (@naslanidis)
extends_documentation_fragment:
- aws
- ec2
'''

View file

@ -15,6 +15,9 @@ description:
- This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters
option or specifying the VPN connection identifier.
version_added: "2.4"
extends_documentation_fragment:
- ec2
- aws
requirements: ['boto3', 'botocore']
author: "Sloane Hertel (@s-hertel)"
options:

View file

@ -52,7 +52,9 @@ options:
default: 'present'
author:
- David M. Lee (@leedm777)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -45,7 +45,8 @@ options:
required: false
default: None
extends_documentation_fragment:
- aws
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -19,7 +19,9 @@ options:
author:
- Will Thames (@willthames)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -28,6 +28,9 @@ description:
- Returns information about the specified cache cluster.
version_added: "2.3"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3, botocore ]
options:
group_family:

View file

@ -20,6 +20,9 @@ description:
- Returns information about the specified snapshot.
version_added: "2.3"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3, botocore ]
options:
name:

View file

@ -29,6 +29,7 @@ description:
version_added: "2.2"
extends_documentation_fragment:
- aws
- ec2
author: "Ryan Scott Brown (@ryansb) <ryansb@redhat.com>"
requirements:
- python >= 2.6

View file

@ -99,7 +99,9 @@ notes:
author:
- "Jonathan I. Davila (@defionscode)"
- "Paul Seiffert (@seiffert)"
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -57,6 +57,7 @@ options:
requirements: [ botocore, boto3 ]
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -45,6 +45,9 @@ options:
default: null
choices: [ "present", "absent" ]
author: "Dan Kozlowski (@dkhenry)"
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto3
- botocore

View file

@ -66,6 +66,7 @@ options:
requirements: [ botocore, boto3 ]
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -37,7 +37,8 @@ options:
required: false
default: None
extends_documentation_fragment:
- aws
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -52,8 +52,8 @@ options:
requirements:
- boto3
extends_documentation_fragment:
- aws
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -66,7 +66,7 @@ requirements:
- boto3
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -52,8 +52,8 @@ author: Pierre Jodouin (@pjodouin)
requirements:
- boto3
extends_documentation_fragment:
- aws
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -91,8 +91,8 @@ options:
requirements:
- boto3
extends_documentation_fragment:
- aws
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -69,7 +69,9 @@ requirements:
- "python >= 2.6"
- boto3
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

View file

@ -82,6 +82,7 @@ options:
description:
- Map of parameter names and values. Numeric values may be represented as K for kilo (1024), M for mega (1024^2), G for giga (1024^3),
or T for tera (1024^4), and these values will be expanded into the appropriate number before being set in the parameter group.
aliases: [parameters]
tags:
description:
- Dictionary of tags to attach to the parameter group

View file

@ -144,7 +144,9 @@ options:
- how long before wait gives up, in seconds
default: 300
requirements: [ 'boto' ]
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -45,7 +45,9 @@ options:
default: null
aliases: ['subnets']
requirements: [ 'boto' ]
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -111,7 +111,9 @@ options:
]
default: 'list'
author: Karen Cheng(@Etherdaemon)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''
EXAMPLES = '''

View file

@ -84,7 +84,9 @@ options:
required: true
default: json
choices: ['json', 'string']
extends_documentation_fragment:
- ec2
- aws
requirements:
- "boto"
"""

View file

@ -63,7 +63,9 @@ options:
Blame Amazon."
required: False
default: True
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements: [ "boto" ]
"""

View file

@ -83,10 +83,11 @@ options:
service_offering:
description:
- The service offering name or ID used by virtual router provider.
service_provider_list:
service_provider:
description:
- Provider to service mapping.
- If not specified, the provider for the service will be mapped to the default provider on the physical network.
aliases: [service_provider]
specify_ip_ranges:
description:
- Wheter the network offering supports specifying IP ranges.

View file

@ -39,6 +39,7 @@ options:
id:
description:
- Numeric, the droplet id you want to operate on.
aliases: ['droplet_id']
name:
description:
- String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key.

View file

@ -43,6 +43,7 @@ options:
description:
- DigitalOcean OAuth token.
required: true
aliases: ['DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN']
notes:
- Two environment variables can be used, DO_API_KEY, DO_OAUTH_TOKEN and DO_API_TOKEN.

View file

@ -31,10 +31,11 @@ options:
description:
- DigitalOcean api token.
version_added: "1.9.5"
aliases: ['api_token']
aliases: ['API_TOKEN']
id:
description:
- Numeric, the droplet id you want to operate on.
aliases: ['droplet_id']
name:
description:
- String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key, or the name of a domain.

View file

@ -33,6 +33,7 @@ options:
required: false
default: None
version_added: 2.4
aliases: ['id']
name:
description:
- The name for the SSH key

View file

@ -31,6 +31,7 @@ options:
description:
- The ID of the resource to operate on.
- The data type of resource_id is changed from integer to string, from version 2.5.
aliases: ['droplet_id']
resource_type:
description:
- The type of resource to operate on. Currently, only tagging of

View file

@ -98,12 +98,6 @@ options:
description:
- Userdata blob made available to the machine
wait:
description:
- Whether to wait for the instance to be assigned IP address before returning.
- This option has been deprecated in favor of C(wait_for_public_IPv).
default: false
wait_for_public_IPv:
description:
- Whether to wait for the instance to be assigned a public IPv4/IPv6 address.

View file

@ -60,7 +60,9 @@ options:
- how long before wait gives up, in seconds
default: 300
author: "Simon JAILLET (@jails)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -40,7 +40,9 @@ options:
choices: ['present', 'absent']
default: present
author: "Simon JAILLET (@jails)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -47,7 +47,9 @@ options:
choices: ['present', 'absent']
default: present
author: "Simon JAILLET (@jails)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -101,7 +101,9 @@ options:
author:
- "Christopher H. Laco (@claco)"
- "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -77,7 +77,9 @@ options:
description:
- Weight of node
author: "Lukasz Kawczynski (@neuroid)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -67,7 +67,9 @@ options:
- How long before "wait" gives up, in seconds.
default: 300
author: Ash Wilson
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -44,7 +44,9 @@ notes:
C(serial: 1) to avoid exceeding the API request limit imposed by
the Rackspace CloudDNS API"
author: "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -87,7 +87,9 @@ notes:
- As of version 1.7, the C(type) field is required and no longer defaults to an C(A) record.
- C(PTR) record support was added in version 1.7
author: "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -70,7 +70,9 @@ options:
description:
- Sets an object to be presented as the HTTP index page when accessed by the CDN URL
author: "Paul Durivage (@angstwad)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -86,7 +86,9 @@ options:
- meta
default: file
author: "Paul Durivage (@angstwad)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -33,7 +33,9 @@ options:
author:
- "Christopher H. Laco (@claco)"
- "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -113,7 +113,9 @@ options:
- how long before wait gives up, in seconds
default: 300
author: "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -69,7 +69,9 @@ options:
- absent
default: present
author: "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace
extends_documentation_fragment:
- rackspace
- rackspace.openstack
'''
EXAMPLES = '''

View file

@ -311,7 +311,7 @@ options:
In case of update it will override the existing Security Group with the new given array
required: true
shut_down_script:
shutdown_script:
description:
- (String) The Base64-encoded shutdown script that executes prior to instance termination.
Encode before setting.