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`.
2025-07-25 14:20:22 -07:00 · 2018-01-16 12:18:51 +00:00 · 2018-01-16 12:18:51 +00:00 · 195beebcb4
commit 195beebcb4
parent c386ae9498
123 changed files with 406 additions and 132 deletions
--- a/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py
+++ b/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py
@ -158,6 +158,8 @@ options:
    choices: ['success', 'fail']
    default: 'success'
    required: false
+extends_documentation_fragment:
+    - aws
 requirements:
  - "python >= 2.6"
  - boto
--- a/lib/ansible/modules/cloud/amazon/aws_acm_facts.py
+++ b/lib/ansible/modules/cloud/amazon/aws_acm_facts.py
@ -25,7 +25,9 @@ requirements:
  - boto3
 author:
  - Will Thames (@willthames)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/aws_api_gateway.py
+++ b/lib/ansible/modules/cloud/amazon/aws_api_gateway.py
@ -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.
--- a/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
+++ b/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
@ -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:
--- a/lib/ansible/modules/cloud/amazon/aws_direct_connect_gateway.py
+++ b/lib/ansible/modules/cloud/amazon/aws_direct_connect_gateway.py
@ -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:
--- a/lib/ansible/modules/cloud/amazon/aws_direct_connect_link_aggregation_group.py
+++ b/lib/ansible/modules/cloud/amazon/aws_direct_connect_link_aggregation_group.py
@ -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
--- a/lib/ansible/modules/cloud/amazon/aws_s3.py
+++ b/lib/ansible/modules/cloud/amazon/aws_s3.py
@ -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 = '''
--- a/lib/ansible/modules/cloud/amazon/aws_s3_cors.py
+++ b/lib/ansible/modules/cloud/amazon/aws_s3_cors.py
@ -32,6 +32,7 @@ options:
    choices: [ 'present', 'absent' ]
 extends_documentation_fragment:
    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/aws_waf_facts.py
+++ b/lib/ansible/modules/cloud/amazon/aws_waf_facts.py
@ -21,7 +21,9 @@ options:
 author:
  - Mike Mochan (@mmochan)
  - Will Thames (@willthames)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/cloudfront_facts.py
+++ b/lib/ansible/modules/cloud/amazon/cloudfront_facts.py
@ -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.
--- a/lib/ansible/modules/cloud/amazon/cloudwatchevent_rule.py
+++ b/lib/ansible/modules/cloud/amazon/cloudwatchevent_rule.py
@ -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
--- a/lib/ansible/modules/cloud/amazon/ec2_key.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_key.py
@ -55,6 +55,7 @@ options:

 extends_documentation_fragment:
  - aws
+  - ec2
 requirements: [ boto3 ]
 author:
  - "Vincent Viallet (@zbal)"
--- a/lib/ansible/modules/cloud/amazon/ec2_lc_find.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_lc_find.py
@ -51,6 +51,8 @@ options:
 requirements:
  - "python >= 2.6"
  - boto3
+extends_documentation_fragment:
+    - aws
 """

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py
@ -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 = '''
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py
@ -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
 """
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py
@ -33,7 +33,7 @@ options:
      - Provide this value as a list
    required: false
    default: None
-    aliases: ['DhcpOptionsIds']
+    aliases: ['DhcpOptionIds']
 extends_documentation_fragment:
    - aws
    - ec2
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py
@ -39,7 +39,9 @@ options:
    required: false
    default: None
 author: Karen Cheng(@Etherdaemon)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py
@ -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 ]
 '''

--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py
@ -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 ]
 '''

--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py
@ -31,7 +31,9 @@ options:
    required: false
    default: None
 author: Karen Cheng(@Etherdaemon)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py
@ -59,7 +59,6 @@ options:
    aliases: [ "resource_tags" ]
 author: Nick Aslanidis (@naslanidis)
 extends_documentation_fragment:
-  - aws
  - ec2
 '''

--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py
@ -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:
--- a/lib/ansible/modules/cloud/amazon/ecs_ecr.py
+++ b/lib/ansible/modules/cloud/amazon/ecs_ecr.py
@ -52,7 +52,9 @@ options:
        default: 'present'
 author:
 - David M. Lee (@leedm777)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/efs_facts.py
+++ b/lib/ansible/modules/cloud/amazon/efs_facts.py
@ -45,7 +45,8 @@ options:
        required: false
        default: None
 extends_documentation_fragment:
-    - aws
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/elasticache_facts.py
+++ b/lib/ansible/modules/cloud/amazon/elasticache_facts.py
@ -19,7 +19,9 @@ options:

 author:
  - Will Thames (@willthames)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py
+++ b/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py
@ -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:
--- a/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py
+++ b/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py
@ -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:
--- a/lib/ansible/modules/cloud/amazon/execute_lambda.py
+++ b/lib/ansible/modules/cloud/amazon/execute_lambda.py
@ -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
--- a/lib/ansible/modules/cloud/amazon/iam.py
+++ b/lib/ansible/modules/cloud/amazon/iam.py
@ -99,7 +99,9 @@ notes:
 author:
    - "Jonathan I. Davila (@defionscode)"
    - "Paul Seiffert (@seiffert)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/iam_group.py
+++ b/lib/ansible/modules/cloud/amazon/iam_group.py
@ -57,6 +57,7 @@ options:
 requirements: [ botocore, boto3 ]
 extends_documentation_fragment:
  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/iam_managed_policy.py
+++ b/lib/ansible/modules/cloud/amazon/iam_managed_policy.py
@ -45,6 +45,9 @@ options:
    default: null
    choices: [ "present", "absent" ]
 author: "Dan Kozlowski (@dkhenry)"
+extends_documentation_fragment:
+  - aws
+  - ec2
 requirements:
    - boto3
    - botocore
--- a/lib/ansible/modules/cloud/amazon/iam_role.py
+++ b/lib/ansible/modules/cloud/amazon/iam_role.py
@ -66,6 +66,7 @@ options:
 requirements: [ botocore, boto3 ]
 extends_documentation_fragment:
  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/iam_role_facts.py
+++ b/lib/ansible/modules/cloud/amazon/iam_role_facts.py
@ -37,7 +37,8 @@ options:
        required: false
        default: None
 extends_documentation_fragment:
-    - aws
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/lambda_alias.py
+++ b/lib/ansible/modules/cloud/amazon/lambda_alias.py
@ -52,8 +52,8 @@ options:
 requirements:
    - boto3
 extends_documentation_fragment:
-    - aws
-
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/lambda_event.py
+++ b/lib/ansible/modules/cloud/amazon/lambda_event.py
@ -66,7 +66,7 @@ requirements:
    - boto3
 extends_documentation_fragment:
    - aws
-
+    - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/lambda_facts.py
+++ b/lib/ansible/modules/cloud/amazon/lambda_facts.py
@ -52,8 +52,8 @@ author: Pierre Jodouin (@pjodouin)
 requirements:
    - boto3
 extends_documentation_fragment:
-    - aws
-
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/lambda_policy.py
+++ b/lib/ansible/modules/cloud/amazon/lambda_policy.py
@ -91,8 +91,8 @@ options:
 requirements:
    - boto3
 extends_documentation_fragment:
-    - aws
-
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/lightsail.py
+++ b/lib/ansible/modules/cloud/amazon/lightsail.py
@ -69,7 +69,9 @@ requirements:
  - "python >= 2.6"
  - boto3

-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''


--- a/lib/ansible/modules/cloud/amazon/rds_param_group.py
+++ b/lib/ansible/modules/cloud/amazon/rds_param_group.py
@ -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
--- a/lib/ansible/modules/cloud/amazon/redshift.py
+++ b/lib/ansible/modules/cloud/amazon/redshift.py
@ -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 = '''
--- a/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py
+++ b/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py
@ -45,7 +45,9 @@ options:
    default: null
    aliases: ['subnets']
 requirements: [ 'boto' ]
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/route53_facts.py
+++ b/lib/ansible/modules/cloud/amazon/route53_facts.py
@ -111,7 +111,9 @@ options:
        ]
    default: 'list'
 author: Karen Cheng(@Etherdaemon)
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/cloud/amazon/sns.py
+++ b/lib/ansible/modules/cloud/amazon/sns.py
@ -84,7 +84,9 @@ options:
    required: true
    default: json
    choices: ['json', 'string']
-
+extends_documentation_fragment:
+ - ec2
+ - aws
 requirements:
    - "boto"
 """
--- a/lib/ansible/modules/cloud/amazon/sns_topic.py
+++ b/lib/ansible/modules/cloud/amazon/sns_topic.py
@ -63,7 +63,9 @@ options:
        Blame Amazon."
    required: False
    default: True
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+  - aws
+  - ec2
 requirements: [ "boto" ]
 """