archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Module DOCUMENTATION should match argspec (#34895)

Browse Source 
* 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`.
pull/35007/head
John R Barker 7 years ago committed by GitHub
parent c386ae9498
commit 195beebcb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
123 changed files with 406 additions and 132 deletions
Show Stats Download Patch File Download Diff File

2
lib/ansible/modules/cloud/amazon/_ec2_ami_find.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/aws_acm_facts.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/aws_api_gateway.py
Unescape Escape View File

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

9
lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/aws_direct_connect_gateway.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/aws_direct_connect_link_aggregation_group.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/aws_s3.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/aws_s3_cors.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/aws_waf_facts.py
Unescape Escape View File

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

6
lib/ansible/modules/cloud/amazon/cloudfront_facts.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/cloudwatchevent_rule.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/ec2_key.py
Unescape Escape View File

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

2
lib/ansible/modules/cloud/amazon/ec2_lc_find.py
Unescape Escape View File

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

2
lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py
Unescape Escape View File

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

2
lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/ecs_ecr.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/efs_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/elasticache_facts.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/elasticache_snapshot.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/execute_lambda.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/iam.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/iam_group.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/iam_managed_policy.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/iam_role.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/amazon/iam_role_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/lambda_alias.py
Unescape Escape View File

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

2
lib/ansible/modules/cloud/amazon/lambda_event.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/lambda_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/lambda_policy.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/lightsail.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/amazon/rds_param_group.py
Unescape Escape View File

@ -82,6 +82,7 @@ options:
description: 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), - 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. 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: tags:
description: description:
- Dictionary of tags to attach to the parameter group - Dictionary of tags to attach to the parameter group

4
lib/ansible/modules/cloud/amazon/redshift.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/redshift_subnet_group.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/route53_facts.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/sns.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/amazon/sns_topic.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/cloudstack/cs_network_offering.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/digital_ocean/digital_ocean.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/digital_ocean/digital_ocean_certificate.py
Unescape Escape View File

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

3
lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py
Unescape Escape View File

@ -31,10 +31,11 @@ options:
description: description:
- DigitalOcean api token. - DigitalOcean api token.
version_added: "1.9.5" version_added: "1.9.5"
aliases: ['api_token'] aliases: ['API_TOKEN']
id: id:
description: description:
- Numeric, the droplet id you want to operate on. - Numeric, the droplet id you want to operate on.
aliases: ['droplet_id']
name: name:
description: 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. - 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.

1
lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py
Unescape Escape View File

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

1
lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py
Unescape Escape View File

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

6
lib/ansible/modules/cloud/packet/packet_device.py
Unescape Escape View File

@ -98,12 +98,6 @@ options:
description: description:
- Userdata blob made available to the machine - 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: wait_for_public_IPv:
description: description:
- Whether to wait for the instance to be assigned a public IPv4/IPv6 address. - Whether to wait for the instance to be assigned a public IPv4/IPv6 address.

4
lib/ansible/modules/cloud/rackspace/rax_cdb.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_cdb_database.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_cdb_user.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_clb.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_clb_ssl.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_dns.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_dns_record.py
Unescape Escape 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. - 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 - C(PTR) record support was added in version 1.7
author: "Matt Martz (@sivel)" author: "Matt Martz (@sivel)"
extends_documentation_fragment: rackspace extends_documentation_fragment:
- rackspace
- rackspace.openstack
''' '''
EXAMPLES = ''' EXAMPLES = '''

4
lib/ansible/modules/cloud/rackspace/rax_files.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_files_objects.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_queue.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_scaling_group.py
Unescape Escape View File

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

4
lib/ansible/modules/cloud/rackspace/rax_scaling_policy.py
Unescape Escape View File

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

2
lib/ansible/modules/cloud/spotinst/spotinst_aws_elastigroup.py
Unescape Escape View File

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

10
lib/ansible/modules/clustering/openshift/_oc.py
Unescape Escape View File

@ -40,6 +40,7 @@ options:
description: description:
- "The inline definition of the resource. This is mutually exclusive with name, namespace and kind." - "The inline definition of the resource. This is mutually exclusive with name, namespace and kind."
required: false required: false
aliases: ['def', 'definition']
kind: kind:
description: The kind of the resource upon which to take action. description: The kind of the resource upon which to take action.
required: true required: true
@ -53,8 +54,15 @@ options:
required: false required: false
token: token:
description: description:
- "The token with which to authenticate agains the OpenShift cluster." - "The token with which to authenticate against the OpenShift cluster."
required: true required: true
validate_certs:
description:
- If C(no), SSL certificates for the target url will not be validated.
This should only be used on personally controlled sites using
self-signed certificates.
type: bool
default: yes
state: state:
choices: choices:
- present - present

6
lib/ansible/modules/crypto/openssl_certificate.py
Unescape Escape View File

@ -94,7 +94,7 @@ options:
If this value is not specified, certificate will stop being valid 10 years from now. If this value is not specified, certificate will stop being valid 10 years from now.
aliases: [ selfsigned_notAfter ] aliases: [ selfsigned_notAfter ]
acme_accountkey: acme_accountkey_path:
description: description:
- Path to the accountkey for the C(acme) provider - Path to the accountkey for the C(acme) provider
@ -219,7 +219,7 @@ EXAMPLES = '''
path: /etc/ssl/crt/ansible.com.crt path: /etc/ssl/crt/ansible.com.crt
csr_path: /etc/ssl/csr/ansible.com.csr csr_path: /etc/ssl/csr/ansible.com.csr
provider: acme provider: acme
acme_accountkey: /etc/ssl/private/ansible.com.pem acme_accountkey_path: /etc/ssl/private/ansible.com.pem
acme_challenge_path: /etc/ssl/challenges/ansible.com/ acme_challenge_path: /etc/ssl/challenges/ansible.com/
- name: Force (re-)generate a new Let's Encrypt Certificate - name: Force (re-)generate a new Let's Encrypt Certificate
@ -227,7 +227,7 @@ EXAMPLES = '''
path: /etc/ssl/crt/ansible.com.crt path: /etc/ssl/crt/ansible.com.crt
csr_path: /etc/ssl/csr/ansible.com.csr csr_path: /etc/ssl/csr/ansible.com.csr
provider: acme provider: acme
acme_accountkey: /etc/ssl/private/ansible.com.pem acme_accountkey_path: /etc/ssl/private/ansible.com.pem
acme_challenge_path: /etc/ssl/challenges/ansible.com/ acme_challenge_path: /etc/ssl/challenges/ansible.com/
force: True force: True

2
lib/ansible/modules/database/postgresql/postgresql_privs.py
Unescape Escape View File

@ -150,6 +150,8 @@ notes:
- When revoking privileges, C(RESTRICT) is assumed (see PostgreSQL docs). - When revoking privileges, C(RESTRICT) is assumed (see PostgreSQL docs).
- The ssl_rootcert parameter requires at least Postgres version 8.4 and I(psycopg2) version 2.4.3. - The ssl_rootcert parameter requires at least Postgres version 8.4 and I(psycopg2) version 2.4.3.
requirements: [psycopg2] requirements: [psycopg2]
extends_documentation_fragment:
- postgres
author: "Bernhard Weitzhofer (@b6d)" author: "Bernhard Weitzhofer (@b6d)"
""" """

1
lib/ansible/modules/database/vertica/vertica_configuration.py
Unescape Escape View File

@ -24,6 +24,7 @@ options:
description: description:
- Name of the parameter to update. - Name of the parameter to update.
required: true required: true
aliases: [parameter]
value: value:
description: description:
- Value of the parameter to be set. - Value of the parameter to be set.

5
lib/ansible/modules/network/a10/a10_server.py
Unescape Escape View File

@ -25,7 +25,9 @@ description:
author: "Eric Chou (@ericchou) 2016, Mischa Peters (@mischapeters) 2014" author: "Eric Chou (@ericchou) 2016, Mischa Peters (@mischapeters) 2014"
notes: notes:
- Requires A10 Networks aXAPI 2.1. - Requires A10 Networks aXAPI 2.1.
extends_documentation_fragment: a10 extends_documentation_fragment:
- a10
- url
options: options:
partition: partition:
version_added: "2.3" version_added: "2.3"
@ -59,6 +61,7 @@ options:
required when C(state) is C(present). required when C(state) is C(present).
required: false required: false
default: null default: null
aliases: ['port']
state: state:
description: description:
- This is to specify the operation to create, update or remove SLB server. - This is to specify the operation to create, update or remove SLB server.

5
lib/ansible/modules/network/a10/a10_server_axapi3.py
Unescape Escape View File

@ -23,7 +23,9 @@ short_description: Manage A10 Networks AX/SoftAX/Thunder/vThunder devices
description: description:
- Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3. - Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3.
author: "Eric Chou (@ericchou) based on previous work by Mischa Peters (@mischapeters)" author: "Eric Chou (@ericchou) based on previous work by Mischa Peters (@mischapeters)"
extends_documentation_fragment: a10 extends_documentation_fragment:
- a10
- url
options: options:
server_name: server_name:
description: description:
@ -48,6 +50,7 @@ options:
and C(protocol:). and C(protocol:).
required: false required: false
default: null default: null
aliases: ['port']
operation: operation:
description: description:
- Create, Update or Remove SLB server. For create and update operation, we use the IP address and server - Create, Update or Remove SLB server. For create and update operation, we use the IP address and server

10
lib/ansible/modules/network/a10/a10_service_group.py
Unescape Escape View File

@ -26,8 +26,15 @@ author: "Eric Chou (@ericchou) 2016, Mischa Peters (@mischapeters) 2014"
notes: notes:
- Requires A10 Networks aXAPI 2.1. - Requires A10 Networks aXAPI 2.1.
- When a server doesn't exist and is added to the service-group the server will be created. - When a server doesn't exist and is added to the service-group the server will be created.
extends_documentation_fragment: a10 extends_documentation_fragment:
- a10
- url
options: options:
state:
description:
- If the specified service group should exists.
default: present
choices: ['present', 'absent']
partition: partition:
version_added: "2.3" version_added: "2.3"
description: description:
@ -72,6 +79,7 @@ options:
specify the C(status:). See the examples below for details. specify the C(status:). See the examples below for details.
required: false required: false
default: null default: null
aliases: ['server', 'member']
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be used - If C(no), SSL certificates will not be validated. This should only be used

9
lib/ansible/modules/network/a10/a10_virtual_server.py
Unescape Escape View File

@ -25,8 +25,15 @@ description:
author: "Eric Chou (@ericchou) 2016, Mischa Peters (@mischapeters) 2014" author: "Eric Chou (@ericchou) 2016, Mischa Peters (@mischapeters) 2014"
notes: notes:
- Requires A10 Networks aXAPI 2.1. - Requires A10 Networks aXAPI 2.1.
extends_documentation_fragment: a10 extends_documentation_fragment:
- a10
- url
options: options:
state:
description:
- If the specified virtual server should exist.
choices: ['present', 'absent']
default: present
partition: partition:
version_added: "2.3" version_added: "2.3"
description: description:

1
lib/ansible/modules/network/asa/asa_acl.py
Unescape Escape View File

@ -30,6 +30,7 @@ options:
command syntax as some commands are automatically modified by the command syntax as some commands are automatically modified by the
device config parser. device config parser.
required: true required: true
aliases: [commands]
before: before:
description: description:
- The ordered set of commands to push on to the command stack if - The ordered set of commands to push on to the command stack if

70
lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py
Unescape Escape View File

@ -201,7 +201,7 @@ EXAMPLES = '''
ce_aaa_server_host: ce_aaa_server_host:
state: present state: present
radius_group_name: group1 radius_group_name: group1
raduis_server_type: Authentication radius_server_type: Authentication
radius_server_ip: 10.1.10.1 radius_server_ip: 10.1.10.1
radius_server_port: 2000 radius_server_port: 2000
radius_server_mode: Primary-server radius_server_mode: Primary-server
@ -212,7 +212,7 @@ EXAMPLES = '''
ce_aaa_server_host: ce_aaa_server_host:
state: absent state: absent
radius_group_name: group1 radius_group_name: group1
raduis_server_type: Authentication radius_server_type: Authentication
radius_server_ip: 10.1.10.1 radius_server_ip: 10.1.10.1
radius_server_port: 2000 radius_server_port: 2000
radius_server_mode: Primary-server radius_server_mode: Primary-server
@ -1059,7 +1059,7 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ip = module.params['radius_server_ip'] radius_server_ip = module.params['radius_server_ip']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
@ -1099,10 +1099,10 @@ class AaaServerHost(object):
for tmp in result["radius_server_ip_v4"]: for tmp in result["radius_server_ip_v4"]:
if "serverType" in tmp.keys(): if "serverType" in tmp.keys():
if state == "present": if state == "present":
if tmp["serverType"] != raduis_server_type: if tmp["serverType"] != radius_server_type:
need_cfg = True need_cfg = True
else: else:
if tmp["serverType"] == raduis_server_type: if tmp["serverType"] == radius_server_type:
need_cfg = True need_cfg = True
if "serverIPAddress" in tmp.keys(): if "serverIPAddress" in tmp.keys():
if state == "present": if state == "present":
@ -1141,14 +1141,14 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ip = module.params['radius_server_ip'] radius_server_ip = module.params['radius_server_ip']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
radius_vpn_name = module.params['radius_vpn_name'] radius_vpn_name = module.params['radius_vpn_name']
conf_str = CE_MERGE_RADIUS_SERVER_CFG_IPV4 % ( conf_str = CE_MERGE_RADIUS_SERVER_CFG_IPV4 % (
radius_group_name, raduis_server_type, radius_group_name, radius_server_type,
radius_server_ip, radius_server_port, radius_server_ip, radius_server_port,
radius_server_mode, radius_vpn_name) radius_server_mode, radius_vpn_name)
@ -1163,7 +1163,7 @@ class AaaServerHost(object):
cmd = "radius server group %s" % radius_group_name cmd = "radius server group %s" % radius_group_name
cmds.append(cmd) cmds.append(cmd)
if raduis_server_type == "Authentication": if radius_server_type == "Authentication":
cmd = "radius server authentication %s %s" % ( cmd = "radius server authentication %s %s" % (
radius_server_ip, radius_server_port) radius_server_ip, radius_server_port)
@ -1190,14 +1190,14 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ip = module.params['radius_server_ip'] radius_server_ip = module.params['radius_server_ip']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
radius_vpn_name = module.params['radius_vpn_name'] radius_vpn_name = module.params['radius_vpn_name']
conf_str = CE_DELETE_RADIUS_SERVER_CFG_IPV4 % ( conf_str = CE_DELETE_RADIUS_SERVER_CFG_IPV4 % (
radius_group_name, raduis_server_type, radius_group_name, radius_server_type,
radius_server_ip, radius_server_port, radius_server_ip, radius_server_port,
radius_server_mode, radius_vpn_name) radius_server_mode, radius_vpn_name)
@ -1212,7 +1212,7 @@ class AaaServerHost(object):
cmd = "radius server group %s" % radius_group_name cmd = "radius server group %s" % radius_group_name
cmds.append(cmd) cmds.append(cmd)
if raduis_server_type == "Authentication": if radius_server_type == "Authentication":
cmd = "undo radius server authentication %s %s" % ( cmd = "undo radius server authentication %s %s" % (
radius_server_ip, radius_server_port) radius_server_ip, radius_server_port)
@ -1239,7 +1239,7 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ipv6 = module.params['radius_server_ipv6'] radius_server_ipv6 = module.params['radius_server_ipv6']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
@ -1278,10 +1278,10 @@ class AaaServerHost(object):
for tmp in result["radius_server_ip_v6"]: for tmp in result["radius_server_ip_v6"]:
if "serverType" in tmp.keys(): if "serverType" in tmp.keys():
if state == "present": if state == "present":
if tmp["serverType"] != raduis_server_type: if tmp["serverType"] != radius_server_type:
need_cfg = True need_cfg = True
else: else:
if tmp["serverType"] == raduis_server_type: if tmp["serverType"] == radius_server_type:
need_cfg = True need_cfg = True
if "serverIPAddress" in tmp.keys(): if "serverIPAddress" in tmp.keys():
if state == "present": if state == "present":
@ -1313,13 +1313,13 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ipv6 = module.params['radius_server_ipv6'] radius_server_ipv6 = module.params['radius_server_ipv6']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
conf_str = CE_MERGE_RADIUS_SERVER_CFG_IPV6 % ( conf_str = CE_MERGE_RADIUS_SERVER_CFG_IPV6 % (
radius_group_name, raduis_server_type, radius_group_name, radius_server_type,
radius_server_ipv6, radius_server_port, radius_server_ipv6, radius_server_port,
radius_server_mode) radius_server_mode)
@ -1334,7 +1334,7 @@ class AaaServerHost(object):
cmd = "radius server group %s" % radius_group_name cmd = "radius server group %s" % radius_group_name
cmds.append(cmd) cmds.append(cmd)
if raduis_server_type == "Authentication": if radius_server_type == "Authentication":
cmd = "radius server authentication %s %s" % ( cmd = "radius server authentication %s %s" % (
radius_server_ipv6, radius_server_port) radius_server_ipv6, radius_server_port)
@ -1355,13 +1355,13 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ipv6 = module.params['radius_server_ipv6'] radius_server_ipv6 = module.params['radius_server_ipv6']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
conf_str = CE_DELETE_RADIUS_SERVER_CFG_IPV6 % ( conf_str = CE_DELETE_RADIUS_SERVER_CFG_IPV6 % (
radius_group_name, raduis_server_type, radius_group_name, radius_server_type,
radius_server_ipv6, radius_server_port, radius_server_ipv6, radius_server_port,
radius_server_mode) radius_server_mode)
@ -1376,7 +1376,7 @@ class AaaServerHost(object):
cmd = "radius server group %s" % radius_group_name cmd = "radius server group %s" % radius_group_name
cmds.append(cmd) cmds.append(cmd)
if raduis_server_type == "Authentication": if radius_server_type == "Authentication":
cmd = "undo radius server authentication %s %s" % ( cmd = "undo radius server authentication %s %s" % (
radius_server_ipv6, radius_server_port) radius_server_ipv6, radius_server_port)
@ -1397,7 +1397,7 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_name = module.params['radius_server_name'] radius_server_name = module.params['radius_server_name']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
@ -1437,10 +1437,10 @@ class AaaServerHost(object):
for tmp in result["radius_server_name_cfg"]: for tmp in result["radius_server_name_cfg"]:
if "serverType" in tmp.keys(): if "serverType" in tmp.keys():
if state == "present": if state == "present":
if tmp["serverType"] != raduis_server_type: if tmp["serverType"] != radius_server_type:
need_cfg = True need_cfg = True
else: else:
if tmp["serverType"] == raduis_server_type: if tmp["serverType"] == radius_server_type:
need_cfg = True need_cfg = True
if "serverName" in tmp.keys(): if "serverName" in tmp.keys():
if state == "present": if state == "present":
@ -1479,14 +1479,14 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_name = module.params['radius_server_name'] radius_server_name = module.params['radius_server_name']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
radius_vpn_name = module.params['radius_vpn_name'] radius_vpn_name = module.params['radius_vpn_name']
conf_str = CE_MERGE_RADIUS_SERVER_NAME % ( conf_str = CE_MERGE_RADIUS_SERVER_NAME % (
radius_group_name, raduis_server_type, radius_group_name, radius_server_type,
radius_server_name, radius_server_port, radius_server_name, radius_server_port,
radius_server_mode, radius_vpn_name) radius_server_mode, radius_vpn_name)
@ -1500,7 +1500,7 @@ class AaaServerHost(object):
cmd = "radius server group %s" % radius_group_name cmd = "radius server group %s" % radius_group_name
cmds.append(cmd) cmds.append(cmd)
if raduis_server_type == "Authentication": if radius_server_type == "Authentication":
cmd = "radius server authentication hostname %s %s" % ( cmd = "radius server authentication hostname %s %s" % (
radius_server_name, radius_server_port) radius_server_name, radius_server_port)
@ -1527,14 +1527,14 @@ class AaaServerHost(object):
module = kwargs["module"] module = kwargs["module"]
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_name = module.params['radius_server_name'] radius_server_name = module.params['radius_server_name']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
radius_server_mode = module.params['radius_server_mode'] radius_server_mode = module.params['radius_server_mode']
radius_vpn_name = module.params['radius_vpn_name'] radius_vpn_name = module.params['radius_vpn_name']
conf_str = CE_DELETE_RADIUS_SERVER_NAME % ( conf_str = CE_DELETE_RADIUS_SERVER_NAME % (
radius_group_name, raduis_server_type, radius_group_name, radius_server_type,
radius_server_name, radius_server_port, radius_server_name, radius_server_port,
radius_server_mode, radius_vpn_name) radius_server_mode, radius_vpn_name)
@ -1548,7 +1548,7 @@ class AaaServerHost(object):
cmd = "radius server group %s" % radius_group_name cmd = "radius server group %s" % radius_group_name
cmds.append(cmd) cmds.append(cmd)
if raduis_server_type == "Authentication": if radius_server_type == "Authentication":
cmd = "undo radius server authentication hostname %s %s" % ( cmd = "undo radius server authentication hostname %s %s" % (
radius_server_name, radius_server_port) radius_server_name, radius_server_port)
@ -2319,7 +2319,7 @@ def main():
local_user_level=dict(type='str'), local_user_level=dict(type='str'),
local_user_group=dict(type='str'), local_user_group=dict(type='str'),
radius_group_name=dict(type='str'), radius_group_name=dict(type='str'),
raduis_server_type=dict(choices=['Authentication', 'Accounting']), radius_server_type=dict(choices=['Authentication', 'Accounting']),
radius_server_ip=dict(type='str'), radius_server_ip=dict(type='str'),
radius_server_ipv6=dict(type='str'), radius_server_ipv6=dict(type='str'),
radius_server_port=dict(type='str'), radius_server_port=dict(type='str'),
@ -2366,7 +2366,7 @@ def main():
# radius para # radius para
radius_group_name = module.params['radius_group_name'] radius_group_name = module.params['radius_group_name']
raduis_server_type = module.params['raduis_server_type'] radius_server_type = module.params['radius_server_type']
radius_server_ip = module.params['radius_server_ip'] radius_server_ip = module.params['radius_server_ip']
radius_server_ipv6 = module.params['radius_server_ipv6'] radius_server_ipv6 = module.params['radius_server_ipv6']
radius_server_port = module.params['radius_server_port'] radius_server_port = module.params['radius_server_port']
@ -2406,8 +2406,8 @@ def main():
proposed["local_user_group"] = local_user_group proposed["local_user_group"] = local_user_group
if radius_group_name: if radius_group_name:
proposed["radius_group_name"] = radius_group_name proposed["radius_group_name"] = radius_group_name
if raduis_server_type: if radius_server_type:
proposed["raduis_server_type"] = raduis_server_type proposed["radius_server_type"] = radius_server_type
if radius_server_ip: if radius_server_ip:
proposed["radius_server_ip"] = radius_server_ip proposed["radius_server_ip"] = radius_server_ip
if radius_server_ipv6: if radius_server_ipv6:
@ -2480,9 +2480,9 @@ def main():
module.fail_json( module.fail_json(
msg='Error: Please do not input radius_server_ip and radius_server_ipv6 at the same time.') msg='Error: Please do not input radius_server_ip and radius_server_ipv6 at the same time.')
if not raduis_server_type or not radius_server_port or not radius_server_mode or not radius_vpn_name: if not radius_server_type or not radius_server_port or not radius_server_mode or not radius_vpn_name:
module.fail_json( module.fail_json(
msg='Error: Please input raduis_server_type radius_server_port radius_server_mode radius_vpn_name.') msg='Error: Please input radius_server_type radius_server_port radius_server_mode radius_vpn_name.')
if radius_server_ip: if radius_server_ip:
rds_server_ipv4_result = ce_aaa_server_host.get_radius_server_cfg_ipv4( rds_server_ipv4_result = ce_aaa_server_host.get_radius_server_cfg_ipv4(

2
lib/ansible/modules/network/dellos10/dellos10_command.py
Unescape Escape View File

@ -173,7 +173,7 @@ def main():
# { command: <str>, prompt: <str>, response: <str> } # { command: <str>, prompt: <str>, response: <str> }
commands=dict(type='list', required=True), commands=dict(type='list', required=True),
wait_for=dict(type='list', aliases=['waitfor']), wait_for=dict(type='list'),
match=dict(default='all', choices=['all', 'any']), match=dict(default='all', choices=['all', 'any']),
retries=dict(default=10, type='int'), retries=dict(default=10, type='int'),

2
lib/ansible/modules/network/dellos6/dellos6_command.py
Unescape Escape View File

@ -174,7 +174,7 @@ def main():
# { command: <str>, prompt: <str>, response: <str> } # { command: <str>, prompt: <str>, response: <str> }
commands=dict(type='list', required=True), commands=dict(type='list', required=True),
wait_for=dict(type='list', aliases=['waitfor']), wait_for=dict(type='list'),
match=dict(default='all', choices=['all', 'any']), match=dict(default='all', choices=['all', 'any']),
retries=dict(default=10, type='int'), retries=dict(default=10, type='int'),

2
lib/ansible/modules/network/dellos9/dellos9_command.py
Unescape Escape View File

@ -178,7 +178,7 @@ def main():
# { command: <str>, prompt: <str>, response: <str> } # { command: <str>, prompt: <str>, response: <str> }
commands=dict(type='list', required=True), commands=dict(type='list', required=True),
wait_for=dict(type='list', aliases=['waitfor']), wait_for=dict(type='list'),
match=dict(default='all', choices=['all', 'any']), match=dict(default='all', choices=['all', 'any']),
retries=dict(default=10, type='int'), retries=dict(default=10, type='int'),

1
lib/ansible/modules/network/eos/eos_config.py
Unescape Escape View File

@ -45,6 +45,7 @@ options:
command syntax as some commands are automatically modified by the command syntax as some commands are automatically modified by the
device config parser. device config parser.
required: false required: false
aliases: ['commands']
default: null default: null
parents: parents:
description: description:

1
lib/ansible/modules/network/eos/eos_system.py
Unescape Escape View File

@ -52,6 +52,7 @@ options:
append to the hostname for the purpose of doing name resolution. append to the hostname for the purpose of doing name resolution.
This argument accepts a list of names and will be reconciled This argument accepts a list of names and will be reconciled
with the current active configuration on the running node. with the current active configuration on the running node.
aliases: ['domain_list']
lookup_source: lookup_source:
description: description:
- Provides one or more source - Provides one or more source

3
lib/ansible/modules/network/eos/eos_user.py
Unescape Escape View File

@ -42,7 +42,8 @@ options:
- The set of username objects to be configured on the remote - The set of username objects to be configured on the remote
Arista EOS device. The list entries can either be the username Arista EOS device. The list entries can either be the username
or a hash of username and properties. This argument is mutually or a hash of username and properties. This argument is mutually
exclusive with the C(username) argument. alias C(users). exclusive with the C(username) argument.
aliases: ['users', 'collection']
version_added: "2.4" version_added: "2.4"
name: name:
description: description:

2
lib/ansible/modules/network/illumos/dladm_iptun.py
Unescape Escape View File

@ -26,7 +26,6 @@ options:
description: description:
- IP tunnel interface name. - IP tunnel interface name.
required: true required: true
aliases: [ "tunnel", "link" ]
temporary: temporary:
description: description:
- Specifies that the IP tunnel interface is temporary. Temporary IP tunnel - Specifies that the IP tunnel interface is temporary. Temporary IP tunnel
@ -39,6 +38,7 @@ options:
required: false required: false
default: "ipv4" default: "ipv4"
choices: [ "ipv4", "ipv6", "6to4" ] choices: [ "ipv4", "ipv6", "6to4" ]
aliases: ['tunnel_type']
local_address: local_address:
description: description:
- Literat IP address or hostname corresponding to the tunnel source. - Literat IP address or hostname corresponding to the tunnel source.

2
lib/ansible/modules/network/illumos/flowadm.py
Unescape Escape View File

@ -36,7 +36,7 @@ options:
description: description:
- Identifies a network flow by the local IP address. - Identifies a network flow by the local IP address.
required: false required: false
remove_ip: remote_ip:
description: description:
- Identifies a network flow by the remote IP address. - Identifies a network flow by the remote IP address.
required: false required: false

2
lib/ansible/modules/network/illumos/ipadm_addrprop.py
Unescape Escape View File

@ -191,7 +191,7 @@ class AddrProp(object):
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
addrobj=dict(required=True, default=None, aliases=['nic, interface']), addrobj=dict(required=True, default=None, aliases=['nic', 'interface']),
property=dict(required=True, aliases=['name']), property=dict(required=True, aliases=['name']),
value=dict(required=False), value=dict(required=False),
temporary=dict(default=False, type='bool'), temporary=dict(default=False, type='bool'),

4
lib/ansible/modules/network/ios/ios_user.py
Unescape Escape View File

@ -43,7 +43,8 @@ options:
- The set of username objects to be configured on the remote - The set of username objects to be configured on the remote
Cisco IOS device. The list entries can either be the username Cisco IOS device. The list entries can either be the username
or a hash of username and properties. This argument is mutually or a hash of username and properties. This argument is mutually
exclusive with the C(name) argument. alias C(users). exclusive with the C(name) argument.
aliases: ['users']
name: name:
description: description:
- The username to be configured on the Cisco IOS device. - The username to be configured on the Cisco IOS device.
@ -76,6 +77,7 @@ options:
device running configuration. The argument accepts a string value device running configuration. The argument accepts a string value
defining the view name. This argument does not check if the view defining the view name. This argument does not check if the view
has been configured on the device. has been configured on the device.
aliases: ['role']
nopassword: nopassword:
description: description:
- Defines the username without assigning - Defines the username without assigning

6
lib/ansible/modules/network/iosxr/iosxr_user.py
Unescape Escape View File

@ -35,7 +35,8 @@ options:
- The set of username objects to be configured on the remote - The set of username objects to be configured on the remote
Cisco IOS XR device. The list entries can either be the username Cisco IOS XR device. The list entries can either be the username
or a hash of username and properties. This argument is mutually or a hash of username and properties. This argument is mutually
exclusive with the C(name) argument, alias C(users). exclusive with the C(name) argument.
aliases: ['users', 'collection']
name: name:
description: description:
- The username to be configured on the Cisco IOS XR device. - The username to be configured on the Cisco IOS XR device.
@ -62,7 +63,8 @@ options:
- Configures the group for the username in the - Configures the group for the username in the
device running configuration. The argument accepts a string value device running configuration. The argument accepts a string value
defining the group name. This argument does not check if the group defining the group name. This argument does not check if the group
has been configured on the device, alias C(role). has been configured on the device.
aliases: ['role']
groups: groups:
version_added: "2.5" version_added: "2.5"
description: description:

6
lib/ansible/modules/network/junos/junos_lldp.py
Unescape Escape View File

@ -35,12 +35,6 @@ options:
- Specify the number of seconds that LLDP information is held before it is - Specify the number of seconds that LLDP information is held before it is
discarded. The multiplier value is used in combination with the discarded. The multiplier value is used in combination with the
C(interval) value. C(interval) value.
enable:
description:
- If value is C(True) it enable LLDP protocol on remote device, if value
is C(False) it disables LLDP protocol.
default: present
choices: [True, False]
state: state:
description: description:
- Value of C(present) ensures given LLDP configuration - Value of C(present) ensures given LLDP configuration

3
lib/ansible/modules/network/junos/junos_user.py
Unescape Escape View File

@ -32,10 +32,11 @@ options:
on the remote device. The list of users will be compared against on the remote device. The list of users will be compared against
the current users and only changes will be added or removed from the current users and only changes will be added or removed from
the device configuration. This argument is mutually exclusive with the device configuration. This argument is mutually exclusive with
the name argument. alias C(users). the name argument.
version_added: "2.4" version_added: "2.4"
required: False required: False
default: null default: null
aliases: ['users', 'collection']
name: name:
description: description:
- The C(name) argument defines the username of the user to be created - The C(name) argument defines the username of the user to be created

5
lib/ansible/modules/network/nxos/_nxos_ip_interface.py
Unescape Escape View File

@ -73,6 +73,11 @@ options:
required: false required: false
default: false default: false
version_added: "2.4" version_added: "2.4"
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: true
type: bool
state: state:
description: description:
- Specify desired state of the resource. - Specify desired state of the resource.

5
lib/ansible/modules/network/nxos/_nxos_portchannel.py
Unescape Escape View File

@ -68,6 +68,11 @@ options:
required: false required: false
choices: ['true', 'false'] choices: ['true', 'false']
default: false default: false
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: false
type: bool
state: state:
description: description:
- Manage the state of the resource. - Manage the state of the resource.

7
lib/ansible/modules/network/nxos/nxos_acl.py
Unescape Escape View File

@ -172,7 +172,7 @@ options:
required: false required: false
default: null default: null
choices: ['enable'] choices: ['enable']
time-range: time_range:
description: description:
- Name of time-range to apply. - Name of time-range to apply.
required: false required: false
@ -192,6 +192,11 @@ options:
choices: ['af11', 'af12', 'af13', 'af21', 'af22', 'af23','af31','af32', choices: ['af11', 'af12', 'af13', 'af21', 'af22', 'af23','af31','af32',
'af33', 'af41', 'af42', 'af43', 'cs1', 'cs2', 'cs3', 'cs4', 'af33', 'af41', 'af42', 'af43', 'cs1', 'cs2', 'cs3', 'cs4',
'cs5', 'cs6', 'cs7', 'default', 'ef'] 'cs5', 'cs6', 'cs7', 'default', 'ef']
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: false
type: bool
state: state:
description: description:
- Specify desired state of the resource. - Specify desired state of the resource.

5
lib/ansible/modules/network/nxos/nxos_evpn_vni.py
Unescape Escape View File

@ -74,6 +74,11 @@ options:
- Sets the route-target 'import' extended communities. - Sets the route-target 'import' extended communities.
required: false required: false
default: null default: null
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: true
type: bool
state: state:
description: description:
- Determines whether the config should be present or not - Determines whether the config should be present or not

5
lib/ansible/modules/network/nxos/nxos_igmp.py
Unescape Escape View File

@ -59,6 +59,11 @@ options:
required: false required: false
default: null default: null
choices: ['true', 'false'] choices: ['true', 'false']
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: false
type: bool
state: state:
description: description:
- Manages desired state of the resource. - Manages desired state of the resource.

5
lib/ansible/modules/network/nxos/nxos_igmp_interface.py
Unescape Escape View File

@ -159,6 +159,11 @@ options:
required: false required: false
choices: ['true', 'false'] choices: ['true', 'false']
default: null default: null
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: true
type: bool
state: state:
description: description:
- Manages desired state of the resource. - Manages desired state of the resource.

5
lib/ansible/modules/network/nxos/nxos_interface_ospf.py
Unescape Escape View File

@ -111,6 +111,11 @@ options:
- Specifies the message_digest password. Valid value is a string. - Specifies the message_digest password. Valid value is a string.
required: false required: false
default: null default: null
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: true
type: bool
state: state:
description: description:
- Determines whether the config should be present or not - Determines whether the config should be present or not

5
lib/ansible/modules/network/nxos/nxos_ospf.py
Unescape Escape View File

@ -41,6 +41,11 @@ options:
required: false required: false
default: present default: present
choices: ['present','absent'] choices: ['present','absent']
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: true
type: bool
''' '''
EXAMPLES = ''' EXAMPLES = '''

5
lib/ansible/modules/network/nxos/nxos_ospf_vrf.py
Unescape Escape View File

@ -120,6 +120,11 @@ options:
required: false required: false
choices: ['true','false'] choices: ['true','false']
default: null default: null
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: true
type: bool
''' '''
EXAMPLES = ''' EXAMPLES = '''

5
lib/ansible/modules/network/nxos/nxos_rollback.py
Unescape Escape View File

@ -50,6 +50,11 @@ options:
with checkpoint_file. with checkpoint_file.
required: false required: false
default: null default: null
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: false
type: bool
''' '''
EXAMPLES = ''' EXAMPLES = '''

6
lib/ansible/modules/network/nxos/nxos_user.py
Unescape Escape View File

@ -40,14 +40,15 @@ options:
- The set of username objects to be configured on the remote - The set of username objects to be configured on the remote
Cisco Nexus device. The list entries can either be the username Cisco Nexus device. The list entries can either be the username
or a hash of username and properties. This argument is mutually or a hash of username and properties. This argument is mutually
exclusive with the C(name) argument. alias C(users). exclusive with the C(name) argument.
aliases: ['users', 'collection']
version_added: "2.4" version_added: "2.4"
required: false required: false
default: null default: null
name: name:
description: description:
- The username to be configured on the remote Cisco Nexus - The username to be configured on the remote Cisco Nexus
device. This argument accepts a stringv value and is mutually device. This argument accepts a string value and is mutually
exclusive with the C(aggregate) argument. exclusive with the C(aggregate) argument.
required: false required: false
default: null default: null
@ -76,6 +77,7 @@ options:
has been configured on the device. has been configured on the device.
required: false required: false
default: null default: null
aliases: ['roles']
sshkey: sshkey:
description: description:
- The C(sshkey) argument defines the SSH public key to configure - The C(sshkey) argument defines the SSH public key to configure

5
lib/ansible/modules/network/nxos/nxos_vrrp.py
Unescape Escape View File

@ -71,6 +71,11 @@ options:
choices: ['shutdown', 'no shutdown'] choices: ['shutdown', 'no shutdown']
default: no shutdown default: no shutdown
version_added: "2.2" version_added: "2.2"
include_defaults:
description:
- Specify if the complete running configuration for module operations should be used.
default: false
type: bool
state: state:
description: description:
- Specify desired state of the resource. - Specify desired state of the resource.

Some files were not shown because too many files have changed in this diff Show More

Write Preview
Loading…
Cancel
Save