diff options
| author | Dag Wieers <dag@wieers.com> | 2018-03-15 22:15:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-15 22:15:24 +0100 |
| commit | cdd21e2170b9a47d84624c8c2f792a66f2b0fe57 (patch) | |
| tree | 29a518e9b19c8e43f9ef7eeccb6114e5ad9a5d55 /lib/ansible/modules/cloud | |
| parent | 58eb2e849d6e1b7c23b0f4b25e4dd3af1a1fd4d4 (diff) | |
| download | ansible-cdd21e2170b9a47d84624c8c2f792a66f2b0fe57.tar.gz | |
Clean up module documentation (#36909)
* Clean up module documentation
This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required
* Fix remaining (new) validation issues
Diffstat (limited to 'lib/ansible/modules/cloud')
220 files changed, 507 insertions, 3171 deletions
diff --git a/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py b/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py index 6bd6e3436a..f4d8569dba 100644 --- a/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py +++ b/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py @@ -44,49 +44,31 @@ options: - You can include wildcards in many of the search options. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash (\) before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. - required: false - default: null ami_id: description: - An AMI ID to match. - default: null - required: false ami_tags: description: - A hash/dictionary of tags to match for the AMI. - default: null - required: false architecture: description: - An architecture type to match (e.g. x86_64). - default: null - required: false hypervisor: description: - A hypervisor type type to match (e.g. xen). - default: null - required: false is_public: description: - Whether or not the image(s) are public. - choices: ['yes', 'no'] - default: null - required: false + type: bool name: description: - An AMI name to match. - default: null - required: false platform: description: - Platform type to match. - default: null - required: false product_code: description: - Marketplace product code to match. - default: null - required: false version_added: "2.3" sort: description: @@ -110,48 +92,34 @@ options: - 'root_device_type' - 'state' - 'virtualization_type' - default: null - required: false sort_tag: description: - Tag name with which to sort results. - Required when specifying 'sort=tag'. - default: null - required: false sort_order: description: - Order in which to sort results. - Only used when the 'sort' parameter is specified. choices: ['ascending', 'descending'] default: 'ascending' - required: false sort_start: description: - Which result to start with (when sorting). - Corresponds to Python slice notation. - default: null - required: false sort_end: description: - Which result to end with (when sorting). - Corresponds to Python slice notation. - default: null - required: false state: description: - AMI state to match. default: 'available' - required: false virtualization_type: description: - Virtualization type to match (e.g. hvm). - default: null - required: false root_device_type: description: - Root device type to match (e.g. ebs, instance-store). - default: null - required: false version_added: "2.5" no_result_action: description: @@ -160,7 +128,6 @@ options: - "'fail' causes the module to report failure" choices: ['success', 'fail'] default: 'success' - required: false extends_documentation_fragment: - aws requirements: diff --git a/lib/ansible/modules/cloud/amazon/_ec2_remote_facts.py b/lib/ansible/modules/cloud/amazon/_ec2_remote_facts.py index a3aece7a15..25393237ec 100644 --- a/lib/ansible/modules/cloud/amazon/_ec2_remote_facts.py +++ b/lib/ansible/modules/cloud/amazon/_ec2_remote_facts.py @@ -27,8 +27,6 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) for possible filters. - required: false - default: null author: - "Michael Schuett (@michaeljs1990)" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/_ec2_vpc.py b/lib/ansible/modules/cloud/amazon/_ec2_vpc.py index f6765f7ef1..b27e4b7a1a 100644 --- a/lib/ansible/modules/cloud/amazon/_ec2_vpc.py +++ b/lib/ansible/modules/cloud/amazon/_ec2_vpc.py @@ -27,25 +27,21 @@ options: cidr_block: description: - "The cidr block representing the VPC, e.g. C(10.0.0.0/16), required when I(state=present)." - required: false instance_tenancy: description: - "The supported tenancy options for instances launched into the VPC." - required: false default: "default" choices: [ "default", "dedicated" ] dns_support: description: - Toggles the "Enable DNS resolution" flag. - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' dns_hostnames: description: - Toggles the "Enable DNS hostname support for instances" flag. - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' subnets: description: - 'A dictionary array of subnets to add of the form C({ cidr: ..., az: ... , resource_tags: ... }).' @@ -54,13 +50,9 @@ options: - C(resource_tags) see resource_tags for VPC below. The main difference is subnet tags not specified here will be deleted. - All VPC subnets not in this list will be removed as well. - As of 1.8, if the subnets parameter is not specified, no existing subnets will be modified.' - required: false - default: null vpc_id: description: - A VPC id to terminate when I(state=absent). - required: false - default: null resource_tags: description: - 'A dictionary array of resource tags of the form C({ tag1: value1, tag2: value2 }). @@ -72,9 +64,8 @@ options: internet_gateway: description: - Toggle whether there should be an Internet gateway attached to the VPC. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' route_tables: description: - > @@ -86,14 +77,11 @@ options: This module is currently unable to affect the "main" route table due to some limitations in boto, so you must explicitly define the associated subnets or they will be attached to the main table implicitly. As of 1.8, if the route_tables parameter is not specified, no existing routes will be modified. - required: false - default: null wait: description: - Wait for the VPC to be in state 'available' before returning. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' wait_timeout: description: - How long before wait gives up, in seconds. diff --git a/lib/ansible/modules/cloud/amazon/aws_s3_cors.py b/lib/ansible/modules/cloud/amazon/aws_s3_cors.py index 553c3bcb25..8b7fe8f870 100644 --- a/lib/ansible/modules/cloud/amazon/aws_s3_cors.py +++ b/lib/ansible/modules/cloud/amazon/aws_s3_cors.py @@ -19,11 +19,9 @@ options: description: - Name of the s3 bucket required: true - default: null rules: description: - Cors rules to put on the s3 bucket - required: false state: description: - Create or remove cors on the s3 bucket diff --git a/lib/ansible/modules/cloud/amazon/cloudformation.py b/lib/ansible/modules/cloud/amazon/cloudformation.py index 728dab49a8..bba669861b 100644 --- a/lib/ansible/modules/cloud/amazon/cloudformation.py +++ b/lib/ansible/modules/cloud/amazon/cloudformation.py @@ -28,14 +28,12 @@ options: disable_rollback: description: - If a stacks fails to form, rollback will remove the stack - required: false - default: "false" - choices: [ "true", "false" ] + type: bool + default: 'no' template_parameters: description: - - a list of hashes of all the template variables for the stack. The value can be a string or a dict. - Dict can be used to set additional template parameter attributes like UsePreviousValue (see example) - required: false + - A list of hashes of all the template variables for the stack. The value can be a string or a dict. + - Dict can be used to set additional template parameter attributes like UsePreviousValue (see example). default: {} state: description: @@ -43,7 +41,6 @@ options: If state is "absent", stack will be removed. default: present choices: [ present, absent ] - required: false template: description: - The local path of the cloudformation template. @@ -52,26 +49,18 @@ options: - If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url' must be specified (but only one of them). If 'state' ispresent, the stack does exist, and neither 'template', 'template_body' nor 'template_url' are specified, the previous template will be reused. - required: false - default: null notification_arns: description: - The Simple Notification Service (SNS) topic ARNs to publish stack related events. - required: false - default: null version_added: "2.0" stack_policy: description: - the path of the cloudformation stack policy. A policy cannot be removed once placed, but it can be modified. (for instance, [allow all updates](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051) - required: false - default: null version_added: "1.9" tags: description: - Dictionary of tags to associate with stack and its resources during stack creation. Can be updated later, updating tags removes previous entries. - required: false - default: null version_added: "1.4" template_url: description: @@ -80,7 +69,6 @@ options: - If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url' must be specified (but only one of them). If 'state' ispresent, the stack does exist, and neither 'template', 'template_body' nor 'template_url' are specified, the previous template will be reused. - required: false version_added: "2.0" create_changeset: description: @@ -88,16 +76,13 @@ options: See the AWS Change Sets docs U(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html). WARNING: if the stack does not exist, it will be created without changeset. If the state is absent, the stack will be deleted immediately with no changeset." - required: false - default: false + default: 'no' version_added: "2.4" changeset_name: description: - Name given to the changeset when creating a changeset, only used when create_changeset is true. By default a name prefixed with Ansible-STACKNAME is generated based on input parameters. See the AWS Change Sets docs U(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) - required: false - default: null version_added: "2.4" template_format: description: @@ -105,14 +90,11 @@ options: This parameter is ignored since Ansible 2.3. default: json choices: [ json, yaml ] - required: false version_added: "2.0" role_arn: description: - The role that AWS CloudFormation assumes to create the stack. See the AWS CloudFormation Service Role docs U(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html) - required: false - default: null version_added: "2.3" termination_protection: description: @@ -124,7 +106,6 @@ options: - If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url' must be specified (but only one of them). If 'state' ispresent, the stack does exist, and neither 'template', 'template_body' nor 'template_url' are specified, the previous template will be reused. - required: false version_added: "2.5" author: "James S. Martin (@jsmartin)" diff --git a/lib/ansible/modules/cloud/amazon/cloudformation_facts.py b/lib/ansible/modules/cloud/amazon/cloudformation_facts.py index adcfd99b5f..106d67c4d2 100644 --- a/lib/ansible/modules/cloud/amazon/cloudformation_facts.py +++ b/lib/ansible/modules/cloud/amazon/cloudformation_facts.py @@ -26,33 +26,26 @@ options: stack_name: description: - The name or id of the CloudFormation stack. Gathers facts for all stacks by default. - required: false - default: null all_facts: description: - Get all stack information for the stack - required: false - default: false + default: 'no' stack_events: description: - Get stack events for the stack - required: false - default: false + default: 'no' stack_template: description: - Get stack template body for the stack - required: false - default: false + default: 'no' stack_resources: description: - Get stack resources for the stack - required: false - default: false + default: 'no' stack_policy: description: - Get stack policy for the stack - required: false - default: false + default: 'no' extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/data_pipeline.py b/lib/ansible/modules/cloud/amazon/data_pipeline.py index 2a5e9c6066..85dbcfdcde 100644 --- a/lib/ansible/modules/cloud/amazon/data_pipeline.py +++ b/lib/ansible/modules/cloud/amazon/data_pipeline.py @@ -80,7 +80,6 @@ options: tags: description: - A dict of key:value pair(s) to add to the pipeline. - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/amazon/dynamodb_table.py b/lib/ansible/modules/cloud/amazon/dynamodb_table.py index 838af01878..fc820a9a2d 100644 --- a/lib/ansible/modules/cloud/amazon/dynamodb_table.py +++ b/lib/ansible/modules/cloud/amazon/dynamodb_table.py @@ -28,7 +28,6 @@ options: state: description: - Create or delete the table - required: false choices: ['present', 'absent'] default: 'present' name: @@ -39,34 +38,26 @@ options: description: - Name of the hash key. - Required when C(state=present). - required: false - default: null hash_key_type: description: - Type of the hash key. - required: false choices: ['STRING', 'NUMBER', 'BINARY'] default: 'STRING' range_key_name: description: - Name of the range key. - required: false - default: null range_key_type: description: - Type of the range key. - required: false choices: ['STRING', 'NUMBER', 'BINARY'] default: 'STRING' read_capacity: description: - Read throughput capacity (units) to provision. - required: false default: 1 write_capacity: description: - Write throughput capacity (units) to provision. - required: false default: 1 indexes: description: @@ -74,20 +65,16 @@ options: - "required options: ['name', 'type', 'hash_key_name']" - "valid types: ['all', 'global_all', 'global_include', 'global_keys_only', 'include', 'keys_only']" - "other options: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity']" - required: false default: [] version_added: "2.1" tags: version_added: "2.4" description: - a hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag; '{"key":"value"}' and '{"key":"value","key":"value"}' - required: false - default: null wait_for_active_timeout: version_added: "2.4" description: - how long before wait gives up, in seconds. only used when tags is set - required: false default: 60 extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2.py b/lib/ansible/modules/cloud/amazon/ec2.py index cb440ebb76..476afb9cd1 100644 --- a/lib/ansible/modules/cloud/amazon/ec2.py +++ b/lib/ansible/modules/cloud/amazon/ec2.py @@ -30,8 +30,6 @@ options: key_name: description: - key pair to use on the instance - required: false - default: null aliases: ['keypair'] id: version_added: "1.1" @@ -39,196 +37,134 @@ options: - identifier for this instance or set of instances, so that the module will be idempotent with respect to EC2 instances. This identifier is valid for at least 24 hours after the termination of the instance, and should not be reused for another call later on. For details, see the description of client token at U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). - required: false - default: null - aliases: [] group: description: - security group (or list of groups) to use with the instance - required: false - default: null aliases: [ 'groups' ] group_id: version_added: "1.1" description: - security group id (or list of ids) to use with the instance - required: false - default: null - aliases: [] region: version_added: "1.2" description: - The AWS region to use. Must be specified if ec2_url is not used. If not specified then the value of the EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) - required: false - default: null aliases: [ 'aws_region', 'ec2_region' ] zone: version_added: "1.2" description: - AWS availability zone in which to launch the instance - required: false - default: null aliases: [ 'aws_zone', 'ec2_zone' ] instance_type: description: - instance type to use for the instance, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) required: true - default: null - aliases: [] tenancy: version_added: "1.9" description: - An instance with a tenancy of "dedicated" runs on single-tenant hardware and can only be launched into a VPC. Note that to use dedicated tenancy you MUST specify a vpc_subnet_id as well. Dedicated tenancy is not available for EC2 "micro" instances. - required: false default: default choices: [ "default", "dedicated" ] - aliases: [] spot_price: version_added: "1.5" description: - Maximum spot price to bid, If not set a regular on-demand instance is requested. A spot request is made with this maximum bid. When it is filled, the instance is started. - required: false - default: null - aliases: [] spot_type: version_added: "2.0" description: - Type of spot request; one of "one-time" or "persistent". Defaults to "one-time" if not supplied. - required: false default: "one-time" choices: [ "one-time", "persistent" ] - aliases: [] image: description: - I(ami) ID to use for the instance required: true - default: null - aliases: [] kernel: description: - kernel I(eki) to use for the instance - required: false - default: null - aliases: [] ramdisk: description: - ramdisk I(eri) to use for the instance - required: false - default: null - aliases: [] wait: description: - wait for the instance to reach its desired state before returning. Does not wait for SSH, see 'wait_for' example for details. - required: false - default: "no" - choices: [ "yes", "no" ] - aliases: [] + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds default: 300 - aliases: [] spot_wait_timeout: version_added: "1.5" description: - how long to wait for the spot instance request to be fulfilled default: 600 - aliases: [] count: description: - number of instances to launch - required: False default: 1 - aliases: [] monitoring: version_added: "1.1" description: - enable detailed monitoring (CloudWatch) for instance - required: false - default: no - choices: [ "yes", "no" ] - aliases: [] + type: bool + default: 'no' user_data: version_added: "0.9" description: - opaque blob of data which is made available to the ec2 instance - required: false - default: null - aliases: [] instance_tags: version_added: "1.0" description: - a hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag; '{"key":"value"}' and '{"key":"value","key":"value"}' - required: false - default: null - aliases: [] placement_group: version_added: "1.3" description: - placement group for the instance when using EC2 Clustered Compute - required: false - default: null - aliases: [] vpc_subnet_id: version_added: "1.1" description: - the subnet ID in which to launch the instance (VPC) - required: false - default: null - aliases: [] assign_public_ip: version_added: "1.5" description: - when provisioning within vpc, assign a public IP address. Boto library must be 2.13.0+ - required: false - default: no - choices: [ "yes", "no" ] - aliases: [] + type: bool + default: 'no' private_ip: version_added: "1.2" description: - the private ip address to assign the instance (from the vpc subnet) - required: false - default: null - aliases: [] instance_profile_name: version_added: "1.3" description: - Name of the IAM instance profile to use. Boto library must be 2.5.0+ - required: false - default: null - aliases: [] instance_ids: version_added: "1.3" description: - "list of instance ids, currently used for states: absent, running, stopped" - required: false - default: null aliases: ['instance_id'] source_dest_check: version_added: "1.6" description: - Enable or Disable the Source/Destination checks (for NAT instances and Virtual Routers) - required: false - default: yes - choices: [ "yes", "no" ] + type: bool + default: 'yes' termination_protection: version_added: "2.0" description: - Enable or Disable the Termination Protection - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' instance_initiated_shutdown_behavior: version_added: "2.2" description: - Set whether AWS will Stop or Terminate an instance on shutdown. This parameter is ignored when using instance-store images (which require termination on shutdown). - required: false default: 'stop' choices: [ "stop", "terminate" ] state: @@ -238,7 +174,6 @@ options: The state 'restarted' was added in 2.2 required: false default: 'present' - aliases: [] choices: ['present', 'absent', 'running', 'restarted', 'stopped'] volumes: version_added: "1.5" @@ -247,47 +182,33 @@ options: are - device_name (str; required), delete_on_termination (bool; False), device_type (deprecated), ephemeral (str), encrypted (bool; False), snapshot (str), volume_type (str), iops (int) - device_type is deprecated use volume_type, iops must be set when volume_type='io1', ephemeral and snapshot are mutually exclusive. - required: false - default: null - aliases: [] ebs_optimized: version_added: "1.6" description: - whether instance is using optimized EBS volumes, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) - required: false - default: 'false' + default: 'no' exact_count: version_added: "1.5" description: - An integer value which indicates how many instances that match the 'count_tag' parameter should be running. Instances are either created or terminated based on this value. - required: false - default: null - aliases: [] count_tag: version_added: "1.5" description: - Used with 'exact_count' to determine how many nodes based on a specific tag criteria should be running. This can be expressed in multiple ways and is shown in the EXAMPLES section. For instance, one can request 25 servers that are tagged with "class=webserver". The specified tag must already exist or be passed in as the 'instance_tags' option. - required: false - default: null - aliases: [] network_interfaces: version_added: "2.0" description: - A list of existing network interfaces to attach to the instance at launch. When specifying existing network interfaces, none of the assign_public_ip, private_ip, vpc_subnet_id, group, or group_id parameters may be used. (Those parameters are for creating a new network interface at launch.) - required: false - default: null aliases: ['network_interface'] spot_launch_group: version_added: "2.1" description: - Launch group for spot request, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group) - required: false - default: null author: - "Tim Gerla (@tgerla)" diff --git a/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py b/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py index ffe6445be6..a447b07b86 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py +++ b/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py @@ -39,41 +39,30 @@ options: name: description: - The name of the new AMI to copy. (As of 2.3 the default is 'default', in prior versions it was 'null'.) - required: false default: "default" description: description: - An optional human-readable string describing the contents and purpose of the new AMI. - required: false - default: null encrypted: description: - Whether or not the destination snapshots of the copied AMI should be encrypted. - required: false - default: null version_added: "2.2" kms_key_id: description: - KMS key id used to encrypt image. If not specified, uses default EBS Customer Master Key (CMK) for your account. - required: false - default: null version_added: "2.2" wait: description: - Wait for the copied AMI to be in state 'available' before returning. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' wait_timeout: description: - How long before wait gives up, in seconds. (As of 2.3 this option is deprecated. See boto3 Waiters) - required: false default: 1200 tags: description: - A hash/dictionary of tags to add to the new copied AMI; '{"key":"value"}' and '{"key":"value","key":"value"}' - required: false - default: null author: "Amir Moulavi <amir.moulavi@gmail.com>, Tim C <defunct@defunct.io>" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_asg.py b/lib/ansible/modules/cloud/amazon/ec2_asg.py index a6b2725065..8bc69f864b 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_asg.py +++ b/lib/ansible/modules/cloud/amazon/ec2_asg.py @@ -32,7 +32,6 @@ options: state: description: - register or deregister the instance - required: false choices: ['present', 'absent'] default: present name: @@ -42,7 +41,6 @@ options: load_balancers: description: - List of ELB names to use for the group. Use for classic load balancers. - required: false target_group_arns: description: - List of target group ARNs to use for the group. Use for application load balancers. @@ -50,7 +48,6 @@ options: availability_zones: description: - List of availability zone names in which to create the group. Defaults to all the availability zones in the region if vpc_zone_identifier is not set. - required: false launch_config_name: description: - Name of the Launch configuration to use for the group. See the ec2_lc module for managing these. @@ -59,27 +56,21 @@ options: min_size: description: - Minimum number of instances in group, if unspecified then the current group value will be used. - required: false max_size: description: - Maximum number of instances in group, if unspecified then the current group value will be used. - required: false placement_group: description: - Physical location of your cluster placement group created in Amazon EC2. - required: false version_added: "2.3" - default: None desired_capacity: description: - Desired number of instances in group, if unspecified then the current group value will be used. - required: false replace_all_instances: description: - In a rolling fashion, replace all instances with an old launch configuration with one from the current launch configuration. - required: false version_added: "1.8" - default: False + default: 'no' replace_batch_size: description: - Number of instances you'd like to replace at a time. Used with replace_all_instances. @@ -90,25 +81,18 @@ options: description: - List of instance_ids belonging to the named ASG that you would like to terminate and be replaced with instances matching the current launch configuration. - required: false version_added: "1.8" - default: None lc_check: description: - Check to make sure instances that are being replaced with replace_instances do not already have the current launch_config. - required: false version_added: "1.8" - default: True + default: 'yes' vpc_zone_identifier: description: - List of VPC subnets to use - required: false - default: None tags: description: - A list of tags to add to the Auto Scale Group. Optional key is 'propagate_at_launch', which defaults to true. - required: false - default: None version_added: "1.7" health_check_period: description: @@ -126,7 +110,6 @@ options: default_cooldown: description: - The number of seconds after a scaling activity completes before another can begin. - required: false default: 300 seconds version_added: "2.0" wait_timeout: @@ -139,22 +122,18 @@ options: - Wait for the ASG instances to be in a ready state before exiting. If instances are behind an ELB, it will wait until the ELB determines all instances have a lifecycle_state of "InService" and a health_status of "Healthy". version_added: "1.9" - default: yes - required: False + default: 'yes' termination_policies: description: - An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity. - For 'Default', when used to create a new autoscaling group, the "Default"i value is used. When used to change an existent autoscaling group, the current termination policies are maintained. - required: false default: Default choices: ['OldestInstance', 'NewestInstance', 'OldestLaunchConfiguration', 'ClosestToNextInstanceHour', 'Default'] version_added: "2.0" notification_topic: description: - A SNS topic ARN to send auto scaling notifications to. - default: None - required: false version_added: "2.2" notification_types: description: @@ -169,15 +148,14 @@ options: suspend_processes: description: - A list of scaling processes to suspend. - required: False default: [] choices: ['Launch', 'Terminate', 'HealthCheck', 'ReplaceUnhealthy', 'AZRebalance', 'AlarmNotification', 'ScheduledActions', 'AddToLoadBalancer'] version_added: "2.3" metrics_collection: description: - Enable ASG metrics collection - default: False type: bool + default: 'no' version_added: "2.5" metrics_granularity: description: diff --git a/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py b/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py index 5033410212..f56baa52b8 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py +++ b/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py @@ -37,8 +37,6 @@ options: bgp_asn: description: - Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when state=present. - required: false - default: null ip_address: description: - Internet-routable IP address for customers gateway, must be a static address. @@ -56,7 +54,6 @@ options: state: description: - Create or terminate the Customer Gateway. - required: false default: present choices: [ 'present', 'absent' ] extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/ec2_customer_gateway_facts.py b/lib/ansible/modules/cloud/amazon/ec2_customer_gateway_facts.py index c476486b75..01eca20c53 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_customer_gateway_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_customer_gateway_facts.py @@ -20,13 +20,9 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCustomerGateways.html) for possible filters. - required: false - default: None customer_gateway_ids: description: - Get details of a specific customer gateways using customer gateway ID/IDs. This value should be provided as a list. - required: false - default: None extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/ec2_eip.py b/lib/ansible/modules/cloud/amazon/ec2_eip.py index d1ad4c4cd4..92726ed097 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_eip.py +++ b/lib/ansible/modules/cloud/amazon/ec2_eip.py @@ -31,45 +31,37 @@ options: - The IP address of a previously allocated EIP. - If present and device is specified, the EIP is associated with the device. - If absent and device is specified, the EIP is disassociated from the device. - required: false aliases: [ ip ] state: description: - If present, allocate an EIP or associate an existing EIP with a device. - If absent, disassociate the EIP from the device and optionally release it. - required: false choices: ['present', 'absent'] default: present in_vpc: description: - Allocate an EIP inside a VPC or not. Required if specifying an ENI. - required: false - default: false + default: 'no' version_added: "1.4" reuse_existing_ip_allowed: description: - Reuse an EIP that is not associated to a device (when available), instead of allocating a new one. - required: false - default: false + default: 'no' version_added: "1.6" release_on_disassociation: description: - whether or not to automatically release the EIP when it is disassociated - required: false - default: false + default: 'no' version_added: "2.0" private_ip_address: description: - The primary or secondary private IP address to associate with the Elastic IP address. - required: False - default: None version_added: "2.3" allow_reassociation: description: - Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface. - required: false - default: false + default: 'no' version_added: "2.5" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_elb.py b/lib/ansible/modules/cloud/amazon/ec2_elb.py index 7133c1f4bf..102153b8dd 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_elb.py +++ b/lib/ansible/modules/cloud/amazon/ec2_elb.py @@ -36,34 +36,27 @@ options: ec2_elbs: description: - List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register. - required: false - default: None enable_availability_zone: description: - Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB. - required: false - default: yes - choices: [ "yes", "no" ] + type: bool + default: 'yes' wait: description: - Wait for instance registration or deregistration to complete successfully before returning. - required: false - default: yes - choices: [ "yes", "no" ] + type: bool + default: 'yes' validate_certs: description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'yes' version_added: "1.5" wait_timeout: description: - Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no. - required: false default: 0 version_added: "1.6" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/ec2_elb_facts.py b/lib/ansible/modules/cloud/amazon/ec2_elb_facts.py index ead2a9bb41..ae19d04fda 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_elb_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_elb_facts.py @@ -32,8 +32,6 @@ options: names: description: - List of ELB names to gather facts about. Pass this option to gather facts about a set of ELBs, otherwise, all ELBs are returned. - required: false - default: null aliases: ['elb_ids', 'ec2_elbs'] extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py b/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py index 116a9898bf..2ba440036b 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py +++ b/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py @@ -38,19 +38,19 @@ options: purge_listeners: description: - Purge existing listeners on ELB that are not found in listeners - required: false - default: true + type: bool + default: 'yes' instance_ids: description: - List of instance ids to attach to this ELB - required: false - default: false + type: bool + default: 'no' version_added: "2.1" purge_instance_ids: description: - Purge existing instance ids on ELB that are not found in instance_ids - required: false - default: false + type: bool + default: 'no' version_added: "2.1" zones: description: @@ -59,43 +59,31 @@ options: purge_zones: description: - Purge existing availability zones on ELB that are not found in zones - required: false - default: false + type: bool + default: 'no' security_group_ids: description: - A list of security groups to apply to the elb - required: false - default: None version_added: "1.6" security_group_names: description: - A list of security group names to apply to the elb - required: false - default: None version_added: "2.0" health_check: description: - An associative array of health check configuration settings (see example) - required: false - default: None access_logs: description: - An associative array of access logs configuration settings (see example) - required: false - default: None version_added: "2.0" subnets: description: - A list of VPC subnets to use when creating ELB. Zones should be empty if using this. - required: false - default: None - aliases: [] version_added: "1.7" purge_subnets: description: - Purge existing subnet on ELB that are not found in subnets - required: false - default: false + default: 'no' version_added: "1.7" scheme: description: @@ -103,60 +91,48 @@ options: If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must use the option wait. choices: ["internal", "internet-facing"] - required: false default: 'internet-facing' version_added: "1.7" validate_certs: description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'yes' version_added: "1.5" connection_draining_timeout: description: - Wait a specified timeout allowing connections to drain before terminating an instance - required: false - aliases: [] version_added: "1.8" idle_timeout: description: - ELB connections from clients and to servers are timed out after this amount of time - required: false version_added: "2.0" cross_az_load_balancing: description: - Distribute load across all configured Availability Zones - required: false - default: "no" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'no' version_added: "1.8" stickiness: description: - An associative array of stickiness policy settings. Policy will be applied to all listeners ( see example ) - required: false version_added: "2.0" wait: description: - When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS. - required: false - default: no - choices: ["yes", "no"] + type: bool + default: 'no' version_added: "2.1" wait_timeout: description: - Used in conjunction with wait. Number of seconds to wait for the elb to be terminated. A maximum of 600 seconds (10 minutes) is allowed. - required: false default: 60 version_added: "2.1" tags: description: - An associative array of tags. To delete all tags, supply an empty dict. - required: false version_added: "2.1" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/ec2_eni.py b/lib/ansible/modules/cloud/amazon/ec2_eni.py index ac2f3de3d1..babbcb445e 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_eni.py +++ b/lib/ansible/modules/cloud/amazon/ec2_eni.py @@ -32,58 +32,43 @@ options: eni_id: description: - The ID of the ENI (to modify); if null and state is present, a new eni will be created. - required: false - default: null instance_id: description: - Instance ID that you wish to attach ENI to. Since version 2.2, use the 'attached' parameter to attach or detach an ENI. Prior to 2.2, to detach an ENI from an instance, use 'None'. - required: false - default: null private_ip_address: description: - Private IP address. - required: false - default: null subnet_id: description: - ID of subnet in which to create the ENI. - required: false description: description: - Optional description of the ENI. - required: false - default: null security_groups: description: - List of security groups associated with the interface. Only used when state=present. Since version 2.2, you can specify security groups by ID or by name or a combination of both. Prior to 2.2, you can specify only by ID. - required: false - default: null state: description: - Create or delete ENI - required: false default: present choices: [ 'present', 'absent' ] device_index: description: - The index of the device for the network interface attachment on the instance. - required: false default: 0 attached: description: - Specifies if network interface should be attached or detached from instance. If ommited, attachment status won't change - required: false - default: yes + default: 'yes' version_added: 2.2 force_detach: description: - Force detachment of the interface. This applies either when explicitly detaching the interface by setting instance_id to None or when deleting an interface with state=absent. - required: false - default: no + default: 'no' delete_on_termination: description: - Delete the interface when the instance it is attached to is terminated. You can only specify this flag when the @@ -104,8 +89,7 @@ options: description: - To be used with I(secondary_private_ip_addresses) to determine whether or not to remove any secondary IP addresses other than those specified. Set secondary_private_ip_addresses to an empty list to purge all secondary addresses. - required: false - default: False + default: no version_added: 2.5 secondary_private_ip_address_count: description: diff --git a/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py b/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py index 8d0155dac0..908fd845f1 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py @@ -32,9 +32,6 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html) for possible filters. - required: false - default: null - extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc.py b/lib/ansible/modules/cloud/amazon/ec2_lc.py index 9610d48eb4..857d94fd83 100755 --- a/lib/ansible/modules/cloud/amazon/ec2_lc.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc.py @@ -54,8 +54,6 @@ options: description: - Instance type to use for the instance required: true - default: null - aliases: [] image_id: description: - The AMI unique identifier to be used for the group @@ -87,7 +85,8 @@ options: instance_monitoring: description: - Specifies whether instances are launched with detailed monitoring. - default: false + type: bool + default: 'no' assign_public_ip: description: - Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud. Specifies whether to assign a public IP address diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py b/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py index bff65108e2..62303b0320 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py @@ -25,33 +25,25 @@ options: name: description: - A name or a list of name to match. - required: false default: [] sort: description: - Optional attribute which with to sort the results. choices: ['launch_configuration_name', 'image_id', 'created_time', 'instance_type', 'kernel_id', 'ramdisk_id', 'key_name'] - default: null - required: false sort_order: description: - Order in which to sort results. - Only used when the 'sort' parameter is specified. choices: ['ascending', 'descending'] default: 'ascending' - required: false sort_start: description: - Which result to start with (when sorting). - Corresponds to Python slice notation. - default: null - required: false sort_end: description: - Which result to end with (when sorting). - Corresponds to Python slice notation. - default: null - required: false extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc_find.py b/lib/ansible/modules/cloud/amazon/ec2_lc_find.py index c126647367..4349589af7 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_lc_find.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc_find.py @@ -41,13 +41,10 @@ options: - Order in which to sort results. choices: ['ascending', 'descending'] default: 'ascending' - required: false limit: description: - How many results to show. - Corresponds to Python slice notation like list[:limit]. - default: null - required: false requirements: - "python >= 2.6" - boto3 diff --git a/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py b/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py index 9cfc5bc3d8..5152639e72 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py +++ b/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py @@ -28,29 +28,22 @@ options: description: description: - An optional human-readable string describing purpose of the new Snapshot. - required: false - default: null encrypted: description: - Whether or not the destination Snapshot should be encrypted. - required: false - default: False + type: bool + default: 'no' kms_key_id: description: - KMS key id used to encrypt snapshot. If not specified, defaults to EBS Customer Master Key (CMK) for that account. - required: false - default: null wait: description: - Wait for the copied Snapshot to be in 'Available' state before returning. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' tags: description: - A hash/dictionary of tags to add to the new Snapshot; '{"key":"value"}' and '{"key":"value","key":"value"}' - required: false - default: null author: "Deepak Kothandan <deepak.kdy@gmail.com>" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_tag.py b/lib/ansible/modules/cloud/amazon/ec2_tag.py index b27bcf9d46..feb6115e0a 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_tag.py +++ b/lib/ansible/modules/cloud/amazon/ec2_tag.py @@ -24,21 +24,15 @@ options: description: - The EC2 resource id. required: true - default: null - aliases: [] state: description: - Whether the tags should be present or absent on the resource. Use list to interrogate the tags of an instance. - required: false default: present choices: ['present', 'absent', 'list'] - aliases: [] tags: description: - a hash/dictionary of tags to add to the resource; '{"key":"value"}' and '{"key":"value","key":"value"}' required: true - default: null - aliases: [] author: "Lester Wade (@lwade)" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/ec2_vol.py b/lib/ansible/modules/cloud/amazon/ec2_vol.py index d0ab999b69..2b5977bd63 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vol.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vol.py @@ -24,90 +24,69 @@ options: instance: description: - instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach. - required: false - default: null name: description: - volume Name tag if you wish to attach an existing volume (requires instance) - required: false - default: null version_added: "1.6" id: description: - volume id if you wish to attach an existing volume (requires instance) or remove an existing volume - required: false - default: null version_added: "1.6" volume_size: description: - size of volume (in GB) to create. - required: false - default: null volume_type: description: - Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD). "Standard" is the old EBS default and continues to remain the Ansible default for backwards compatibility. - required: false default: standard version_added: "1.9" iops: description: - the provisioned IOPs you want to associate with this volume (integer). - required: false default: 100 version_added: "1.3" encrypted: description: - Enable encryption at rest for this volume. - default: false + default: 'no' version_added: "1.8" kms_key_id: description: - Specify the id of the KMS key to use. - default: null version_added: "2.3" device_name: description: - device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows. - required: false - default: null delete_on_termination: description: - When set to "yes", the volume will be deleted upon instance termination. - required: false - default: "no" - choices: ["yes", "no"] + type: bool + default: 'no' version_added: "2.1" zone: description: - zone in which to create the volume, if unset uses the zone the instance is in (if set) - required: false - default: null aliases: ['aws_zone', 'ec2_zone'] snapshot: description: - snapshot ID on which to base the volume - required: false - default: null version_added: "1.5" validate_certs: description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" - choices: ["yes", "no"] + type: bool + default: 'yes' version_added: "1.5" state: description: - whether to ensure the volume is present or absent, or to list existing volumes (The C(list) option was added in version 1.8). - required: false default: present choices: ['absent', 'present', 'list'] version_added: "1.6" tags: description: - tag:value pairs to add to the volume after creation - required: false default: {} version_added: "2.3" author: "Lester Wade (@lwade)" diff --git a/lib/ansible/modules/cloud/amazon/ec2_vol_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vol_facts.py index 275602890a..465abec2da 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vol_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vol_facts.py @@ -24,8 +24,6 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVolumes.html) for possible filters. - required: false - default: null extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py index a439b6f14a..7199236eaf 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py @@ -35,38 +35,26 @@ options: domain_name: description: - The domain name to set in the DHCP option sets - required: false - default: None dns_servers: description: - A list of hosts to set the DNS servers for the VPC to. (Should be a list of IP addresses rather than host names.) - required: false - default: None ntp_servers: description: - List of hosts to advertise as NTP servers for the VPC. - required: false - default: None netbios_name_servers: description: - List of hosts to advertise as NetBIOS servers. - required: false - default: None netbios_node_type: description: - NetBIOS node type to advertise in the DHCP options. The AWS recommendation is to use 2 (when using netbios name services) http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html - required: false - default: None vpc_id: description: - VPC ID to associate with the requested DHCP option set. If no vpc id is provided, and no matching option set is found then a new DHCP option set is created. - required: false - default: None delete_old: description: - Whether to delete the old VPC DHCP option set when associating a new one. @@ -74,21 +62,19 @@ options: want to quickly roll back to the old option set. Note that this setting will be ignored, and the old DHCP option set will be preserved, if it is in use by any other VPC. (Otherwise, AWS will return an error.) - required: false - default: true + type: bool + default: 'yes' inherit_existing: description: - For any DHCP options not specified in these parameters, whether to inherit them from the options set already applied to vpc_id, or to reset them to be empty. - required: false - default: false + type: bool + default: 'no' tags: description: - Tags to be applied to a VPC options set if a new one is created, or if the resource_id is provided. (options must match) - required: False - default: None aliases: [ 'resource_tags'] version_added: "2.1" dhcp_options_id: @@ -96,15 +82,12 @@ options: - The resource_id of an existing DHCP options set. If this is specified, then it will override other settings, except tags (which will be updated to match) - required: False - default: None version_added: "2.1" state: description: - create/assign or remove the DHCP options. If state is set to absent, then a DHCP options set matched either by id, or tags and options will be removed if possible. - required: False default: present choices: [ 'absent', 'present' ] version_added: "2.1" diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py index 4f32e79209..eef3e50b9a 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py @@ -25,14 +25,10 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html) for possible filters. - required: false - default: null dhcp_options_ids: description: - Get details of specific DHCP Option ID - Provide this value as a list - required: false - default: None aliases: ['DhcpOptionIds'] extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py index 5ae77257b9..02b2439bfd 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py @@ -29,15 +29,11 @@ options: description: - Get details of specific endpoint IDs - Provide this value as a list - required: false - default: None filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html) for possible filters. - required: false - default: None author: Karen Cheng(@Etherdaemon) extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_igw.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_igw.py index b34e3c7097..cfe6476ebd 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_igw.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_igw.py @@ -24,18 +24,14 @@ options: description: - The VPC ID for the VPC in which to manage the Internet Gateway. required: true - default: null tags: description: - "A dict of tags to apply to the internet gateway. Any tags currently applied to the internet gateway and not present here will be removed." - required: false - default: null aliases: [ 'resource_tags' ] version_added: "2.4" state: description: - Create or terminate the IGW - required: false default: present choices: [ 'present', 'absent' ] extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py index 7f912704f7..55697ae1d8 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_igw_facts.py @@ -25,13 +25,9 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html) for possible filters. - required: false - default: null internet_gateway_ids: description: - Get details of specific Internet Gateway ID. Provide this value as a list. - required: false - default: None extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py index d4fd1f3b93..139fe86df0 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py @@ -23,33 +23,25 @@ options: state: description: - Ensure NAT Gateway is present or absent. - required: false default: "present" choices: ["present", "absent"] nat_gateway_id: description: - The id AWS dynamically allocates to the NAT Gateway on creation. This is required when the absent option is present. - required: false - default: None subnet_id: description: - The id of the subnet to create the NAT Gateway in. This is required with the present option. - required: false - default: None allocation_id: description: - The id of the elastic IP allocation. If this is not passed and the eip_address is not passed. An EIP is generated for this NAT Gateway. - required: false - default: None eip_address: description: - The elastic IP address of the EIP you want attached to this NAT Gateway. If this is not passed and the allocation_id is not passed, an EIP is generated for this NAT Gateway. - required: false if_exist_do_not_create: description: - if a NAT Gateway exists already in the subnet_id, then do not create a new one. @@ -60,25 +52,20 @@ options: - Deallocate the EIP from the VPC. - Option is only valid with the absent state. - You should use this with the wait option. Since you can not release an address while a delete operation is happening. - required: false - default: true + default: 'yes' wait: description: - Wait for operation to complete before returning. - required: false - default: false + default: 'no' wait_timeout: description: - How many seconds to wait for an operation to complete before timing out. - required: false default: 300 client_token: description: - Optional unique token to be used during create to ensure idempotency. When specifying this option, ensure you specify the eip_address parameter as well otherwise any subsequent runs will fail. - required: false - author: - "Allen Sanabria (@linuxdynasty)" - "Jon Hadfield (@jonhadfield)" diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway_facts.py index a7b29576af..8749d2c668 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway_facts.py @@ -22,15 +22,11 @@ options: nat_gateway_ids: description: - Get details of specific nat gateway IDs - required: false - default: None filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html) for possible filters. - required: false - default: None author: Karen Cheng(@Etherdaemon) extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py index b87efe93df..6cb430bbc7 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py @@ -21,15 +21,11 @@ options: peer_connection_ids: description: - Get details of specific vpc peer IDs - required: false - default: None filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html) for possible filters. - required: false - default: None author: Karen Cheng(@Etherdaemon) extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py index 29c33c7fc1..389ab702f8 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py @@ -38,11 +38,11 @@ options: choices: [ 'tag', 'id' ] propagating_vgw_ids: description: Enable route propagation from virtual gateways specified by ID. - default: None purge_routes: version_added: "2.3" description: Purge existing routes that are not found in routes. - default: 'true' + type: bool + default: 'yes' purge_subnets: version_added: "2.3" description: Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied. @@ -50,7 +50,8 @@ options: purge_tags: version_added: "2.5" description: Purge existing tags that are not found in route table - default: 'false' + type: bool + default: 'no' route_table_id: description: The ID of the route table to update or delete. routes: @@ -59,7 +60,6 @@ options: 'instance_id', 'interface_id', or 'vpc_peering_connection_id'. If 'gateway_id' is specified, you can refer to the VPC's IGW by using the value 'igw'. Routes are required for present states. - default: None state: description: Create or destroy the VPC route table default: present diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table_facts.py index 839c1fcb56..30465da9bd 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table_facts.py @@ -24,8 +24,6 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html) for possible filters. - required: false - default: null extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py index ea56343e30..9d0425f1cd 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py @@ -24,66 +24,55 @@ options: az: description: - "The availability zone for the subnet." - required: false - default: null cidr: description: - "The CIDR block for the subnet. E.g. 192.0.2.0/24." - required: false - default: null ipv6_cidr: description: - "The IPv6 CIDR block for the subnet. The VPC must have a /56 block assigned and this value must be a valid IPv6 /64 that falls in the VPC range." - "Required if I(assign_instances_ipv6=true)" - required: false - default: null version_added: "2.5" tags: description: - "A dict of tags to apply to the subnet. Any tags currently applied to the subnet and not present here will be removed." - required: false - default: null aliases: [ 'resource_tags' ] state: description: - "Create or remove the subnet" - required: false default: present choices: [ 'present', 'absent' ] vpc_id: description: - "VPC ID of the VPC in which to create or delete the subnet." required: true - default: null map_public: description: - - "Specify true to indicate that instances launched into the subnet should be assigned public IP address by default." - required: false - default: false + - "Specify C(yes) to indicate that instances launched into the subnet should be assigned public IP address by default." + type: bool + default: 'no' version_added: "2.4" assign_instances_ipv6: description: - - "Specify true to indicate that instances launched into the subnet should be automatically assigned an IPv6 address." - required: false - default: false + - "Specify C(yes) to indicate that instances launched into the subnet should be automatically assigned an IPv6 address." + type: bool + default: 'no' version_added: "2.5" wait: description: - "When specified,I(state=present) module will wait for subnet to be in available state before continuing." - required: false - default: true + type: bool + default: 'yes' version_added: "2.5" wait_timeout: description: - "Number of seconds to wait for subnet to become available I(wait=True)." - required: false default: 300 version_added: "2.5" purge_tags: description: - - Whether or not to remove tags that do not appear in the I(tags) list. Defaults to true. - required: false - default: true + - Whether or not to remove tags that do not appear in the I(tags) list. + type: bool + default: 'yes' version_added: "2.5" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py index a2d2793ffd..b545a4b182 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py @@ -26,36 +26,28 @@ options: description: - present to ensure resource is created. - absent to remove resource - required: false default: present choices: [ "present", "absent"] name: description: - name of the vgw to be created or deleted - required: false type: description: - type of the virtual gateway to be created - required: false choices: [ "ipsec.1" ] vpn_gateway_id: description: - vpn gateway id of an existing virtual gateway - required: false vpc_id: description: - the vpc-id of a vpc to attach or detach - required: false wait_timeout: description: - number of seconds to wait for status during vpc attach and detach - required: false default: 320 tags: description: - dictionary of resource tags - required: false - default: null aliases: [ "resource_tags" ] author: Nick Aslanidis (@naslanidis) extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw_facts.py index 182817996a..d5d54f0128 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw_facts.py @@ -24,13 +24,9 @@ options: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html) for possible filters. - required: false - default: None vpn_gateway_ids: description: - Get details of a specific Virtual Gateway ID. This value should be provided as a list. - required: false - default: None author: "Nick Aslanidis (@naslanidis)" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/ec2_win_password.py b/lib/ansible/modules/cloud/amazon/ec2_win_password.py index 40657140ca..7fa65fe437 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_win_password.py +++ b/lib/ansible/modules/cloud/amazon/ec2_win_password.py @@ -34,20 +34,16 @@ options: description: - The passphrase for the instance key pair. The key must use DES or 3DES encryption for this module to decrypt it. You can use openssl to convert your password protected keys if they do not use DES or 3DES. ex) C(openssl rsa -in current_key -out new_key -des3). - required: false - default: null wait: version_added: "2.0" description: - Whether or not to wait for the password to be available before returning. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' wait_timeout: version_added: "2.0" description: - Number of seconds to wait before giving up. - required: false default: 120 extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/efs.py b/lib/ansible/modules/cloud/amazon/efs.py index 072215a49a..c1d6053724 100644 --- a/lib/ansible/modules/cloud/amazon/efs.py +++ b/lib/ansible/modules/cloud/amazon/efs.py @@ -27,53 +27,42 @@ options: description: - A boolean value that, if true, creates an encrypted file system. This can not be modfied after the file system is created. - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' version_added: 2.5 kms_key_id: description: - The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN. - required: false version_added: 2.5 purge_tags: description: - If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified. - required: false - default: yes - choices: [ 'yes', 'no' ] + type: bool + default: 'yes' version_added: 2.5 state: description: - Allows to create, search and destroy Amazon EFS file system - required: false default: 'present' choices: ['present', 'absent'] name: description: - Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete. - required: false - default: None id: description: - ID of Amazon EFS. Either name or ID required for delete. - required: false - default: None performance_mode: description: - File system's performance mode to use. Only takes effect during creation. - required: false default: 'general_purpose' choices: ['general_purpose', 'max_io'] tags: description: - "List of tags of Amazon EFS. Should be defined as dictionary In case of 'present' state with list of tags and existing EFS (matched by 'name'), tags of EFS will be replaced with provided data." - required: false - default: None targets: description: - "List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: @@ -81,19 +70,15 @@ options: - ip_address - Optional. A valid IPv4 address within the address range of the specified subnet. - security_groups - Optional. List of security group IDs, of the form 'sg-xxxxxxxx'. These must be for the same VPC as subnet specified This data may be modified for existing EFS using state 'present' and new list of mount targets." - required: false - default: None wait: description: - "In case of 'present' state should wait for EFS 'available' life cycle state (of course, if current state not 'deleting' or 'deleted') In case of 'absent' state should wait for EFS 'deleted' life cycle state" - required: false - default: "no" - choices: ["yes", "no"] + type: bool + default: 'no' wait_timeout: description: - How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary. - required: false default: 0 extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/efs_facts.py b/lib/ansible/modules/cloud/amazon/efs_facts.py index 49c595d775..debd0ddc52 100644 --- a/lib/ansible/modules/cloud/amazon/efs_facts.py +++ b/lib/ansible/modules/cloud/amazon/efs_facts.py @@ -25,25 +25,17 @@ options: name: description: - Creation Token of Amazon EFS file system. - required: false - default: None id: description: - ID of Amazon EFS. - required: false - default: None tags: description: - List of tags of Amazon EFS. Should be defined as dictionary - required: false - default: None targets: description: - list of targets on which to filter the returned results - result must match all of the specified targets, each of which can be a security group ID, a subnet ID or an IP address - required: false - default: None extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/elasticache.py b/lib/ansible/modules/cloud/amazon/elasticache.py index 416d5a8c3c..84ddd6ca36 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache.py +++ b/lib/ansible/modules/cloud/amazon/elasticache.py @@ -32,70 +32,51 @@ options: engine: description: - Name of the cache engine to be used. - required: false default: memcached choices: ['redis', 'memcached'] cache_engine_version: description: - The version number of the cache engine - required: false - default: None node_type: description: - The compute and memory capacity of the nodes in the cache cluster - required: false default: cache.m1.small num_nodes: description: - The initial number of cache nodes that the cache cluster will have. Required when state=present. - required: false cache_port: description: - The port number on which each of the cache nodes will accept connections - required: false - default: None cache_parameter_group: description: - The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used. - required: false - default: None version_added: "2.0" aliases: [ 'parameter_group' ] cache_subnet_group: description: - The subnet group name to associate with. Only use if inside a vpc. Required if inside a vpc - required: false - default: None version_added: "2.0" security_group_ids: description: - A list of vpc security group names to associate with this cache cluster. Only use if inside a vpc - required: false - default: None version_added: "1.6" cache_security_groups: description: - A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc - required: false - default: None zone: description: - The EC2 Availability Zone in which the cache cluster will be created - required: false - default: None wait: description: - Wait for cache cluster result before returning - required: false - default: yes - choices: [ "yes", "no" ] + type: bool + default: 'yes' hard_modify: description: - Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py b/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py index 5d65db0deb..ea22b92726 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py +++ b/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py @@ -38,7 +38,6 @@ options: - The name of the cache parameter group family that the cache parameter group can be used with. Required when creating a cache parameter group. choices: ['memcached1.4', 'redis2.6', 'redis2.8', 'redis3.2'] - required: no name: description: - A user-specified name for the cache parameter group. @@ -54,8 +53,6 @@ options: values: description: - A user-specified dictionary of parameters to reset or modify for the cache parameter group. - required: no - default: None """ EXAMPLES = """ diff --git a/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py b/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py index 30aa884bed..64b9cdc863 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py +++ b/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py @@ -36,23 +36,15 @@ options: replication_id: description: - The name of the existing replication group to make the snapshot. - required: no - default: null cluster_id: description: - The name of an existing cache cluster in the replication group to make the snapshot. - required: no - default: null target: description: - The name of a snapshot copy - required: no - default: null bucket: description: - The s3 bucket to which the snapshot is exported - required: no - default: null """ EXAMPLES = """ diff --git a/lib/ansible/modules/cloud/amazon/elasticache_subnet_group.py b/lib/ansible/modules/cloud/amazon/elasticache_subnet_group.py index 867f0a70fb..cbb1dcd26d 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache_subnet_group.py +++ b/lib/ansible/modules/cloud/amazon/elasticache_subnet_group.py @@ -32,13 +32,9 @@ options: description: description: - Elasticache subnet group description. Only set when a new group is added. - required: false - default: null subnets: description: - List of subnet IDs that make up the Elasticache subnet group. - required: false - default: null author: "Tim Mahoney (@timmahoney)" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/elb_classic_lb.py b/lib/ansible/modules/cloud/amazon/elb_classic_lb.py index 4db1b735f0..747ea528ef 100644 --- a/lib/ansible/modules/cloud/amazon/elb_classic_lb.py +++ b/lib/ansible/modules/cloud/amazon/elb_classic_lb.py @@ -34,68 +34,53 @@ options: listeners: description: - List of ports/protocols for this ELB to listen on (see example) - required: false purge_listeners: description: - Purge existing listeners on ELB that are not found in listeners - required: false - default: true + type: bool + default: 'yes' instance_ids: description: - List of instance ids to attach to this ELB - required: false - default: false version_added: "2.1" purge_instance_ids: description: - Purge existing instance ids on ELB that are not found in instance_ids - required: false - default: false + type: bool + default: 'no' version_added: "2.1" zones: description: - List of availability zones to enable on this ELB - required: false purge_zones: description: - Purge existing availability zones on ELB that are not found in zones - required: false - default: false + type: bool + default: 'no' security_group_ids: description: - A list of security groups to apply to the elb - required: false - default: None version_added: "1.6" security_group_names: description: - A list of security group names to apply to the elb - required: false - default: None version_added: "2.0" health_check: description: - An associative array of health check configuration settings (see example) - required: false - default: None access_logs: description: - An associative array of access logs configuration settings (see example) - required: false - default: None version_added: "2.0" subnets: description: - A list of VPC subnets to use when creating ELB. Zones should be empty if using this. - required: false - default: None - aliases: [] version_added: "1.7" purge_subnets: description: - Purge existing subnet on ELB that are not found in subnets - required: false - default: false + type: bool + default: 'no' version_added: "1.7" scheme: description: @@ -103,60 +88,48 @@ options: If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must use the option wait. choices: ["internal", "internet-facing"] - required: false default: 'internet-facing' version_added: "1.7" validate_certs: description: - - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" - choices: ["yes", "no"] - aliases: [] + - When set to C(no), SSL certificates will not be validated for boto versions >= 2.6.0. + type: bool + default: 'yes' version_added: "1.5" connection_draining_timeout: description: - Wait a specified timeout allowing connections to drain before terminating an instance - required: false - aliases: [] version_added: "1.8" idle_timeout: description: - ELB connections from clients and to servers are timed out after this amount of time - required: false version_added: "2.0" cross_az_load_balancing: description: - Distribute load across all configured Availability Zones - required: false - default: "no" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'no' version_added: "1.8" stickiness: description: - An associative array of stickiness policy settings. Policy will be applied to all listeners ( see example ) - required: false version_added: "2.0" wait: description: - When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS. - required: false - default: no - choices: ["yes", "no"] + type: bool + default: 'no' version_added: "2.1" wait_timeout: description: - Used in conjunction with wait. Number of seconds to wait for the elb to be terminated. A maximum of 600 seconds (10 minutes) is allowed. - required: false default: 60 version_added: "2.1" tags: description: - An associative array of tags. To delete all tags, supply an empty dict. - required: false version_added: "2.1" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/elb_classic_lb_facts.py b/lib/ansible/modules/cloud/amazon/elb_classic_lb_facts.py index 73756f9030..90e9a02098 100644 --- a/lib/ansible/modules/cloud/amazon/elb_classic_lb_facts.py +++ b/lib/ansible/modules/cloud/amazon/elb_classic_lb_facts.py @@ -32,8 +32,6 @@ options: names: description: - List of ELB names to gather facts about. Pass this option to gather facts about a set of ELBs, otherwise, all ELBs are returned. - required: false - default: null aliases: ['elb_ids', 'ec2_elbs'] extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/elb_instance.py b/lib/ansible/modules/cloud/amazon/elb_instance.py index c6193f5938..c5b577d0db 100644 --- a/lib/ansible/modules/cloud/amazon/elb_instance.py +++ b/lib/ansible/modules/cloud/amazon/elb_instance.py @@ -36,34 +36,27 @@ options: ec2_elbs: description: - List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register. - required: false - default: None enable_availability_zone: description: - Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB. - required: false - default: yes - choices: [ "yes", "no" ] + type: bool + default: 'yes' wait: description: - Wait for instance registration or deregistration to complete successfully before returning. - required: false - default: yes - choices: [ "yes", "no" ] + type: bool + default: 'yes' validate_certs: description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'yes' version_added: "1.5" wait_timeout: description: - Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no. - required: false default: 0 version_added: "1.6" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/execute_lambda.py b/lib/ansible/modules/cloud/amazon/execute_lambda.py index 880f476a67..357ff303c5 100644 --- a/lib/ansible/modules/cloud/amazon/execute_lambda.py +++ b/lib/ansible/modules/cloud/amazon/execute_lambda.py @@ -44,48 +44,42 @@ options: - The name of the function to be invoked. This can only be used for invocations within the calling account. To invoke a function in another account, use I(function_arn) to specify the full ARN. - required: false - default: None function_arn: description: - The name of the function to be invoked - required: false - default: None tail_log: description: - - If C(tail_log=true), the result of the task will include the last 4 KB + - If C(tail_log=yes), the result of the task will include the last 4 KB of the CloudWatch log for the function execution. Log tailing only - works if you use synchronous invocation C(wait=true). This is usually + works if you use synchronous invocation C(wait=yes). This is usually used for development or testing Lambdas. - required: false - default: false + type: bool + default: 'no' wait: description: - - Whether to wait for the function results or not. If I(wait) is false, + - Whether to wait for the function results or not. If I(wait) is C(no), the task will not return any results. To wait for the Lambda function - to complete, set C(wait=true) and the result will be available in the + to complete, set C(wait=yes) and the result will be available in the I(output) key. - required: false - default: true + type: bool + default: 'yes' dry_run: description: - Do not *actually* invoke the function. A C(DryRun) call will check that the caller has permissions to call the function, especially for checking cross-account permissions. - required: false - default: False + type: bool + default: 'no' version_qualifier: description: - Which version/alias of the function to run. This defaults to the C(LATEST) revision, but can be set to any existing version or alias. See https;//docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html for details. - required: false default: LATEST payload: description: - A dictionary in any form to be provided as input to the Lambda function. - required: false default: {} ''' diff --git a/lib/ansible/modules/cloud/amazon/iam.py b/lib/ansible/modules/cloud/amazon/iam.py index 8d48141486..385af9540d 100644 --- a/lib/ansible/modules/cloud/amazon/iam.py +++ b/lib/ansible/modules/cloud/amazon/iam.py @@ -22,8 +22,6 @@ options: iam_type: description: - Type of IAM resource - required: true - default: null choices: ["user", "group", "role"] name: description: @@ -32,47 +30,34 @@ options: new_name: description: - When state is update, will replace name with new_name on IAM resource - required: false - default: null new_path: description: - When state is update, will replace the path with new_path on the IAM resource - required: false - default: null state: description: - Whether to create, delete or update the IAM resource. Note, roles cannot be updated. required: true - default: null choices: [ "present", "absent", "update" ] path: description: - When creating or updating, specify the desired path of the resource. If state is present, it will replace the current path to match what is passed in when they do not match. - required: false default: "/" trust_policy: description: - The inline (JSON or YAML) trust policy document that grants an entity permission to assume the role. Mutually exclusive with C(trust_policy_filepath). - required: false - default: null version_added: "2.2" trust_policy_filepath: description: - The path to the trust policy document that grants an entity permission to assume the role. Mutually exclusive with C(trust_policy). - required: false - default: null version_added: "2.2" access_key_state: description: - When type is user, it creates, removes, deactivates or activates a user's access key(s). Note that actions apply only to keys specified. - required: false - default: null choices: [ "create", "remove", "active", "inactive"] key_count: description: - When access_key_state is create it will ensure this quantity of keys are present. Defaults to 1. - required: false default: '1' access_key_ids: description: @@ -80,15 +65,10 @@ options: groups: description: - A list of groups the user should belong to. When update, will gracefully remove groups not listed. - required: false - default: null password: description: - When type is user and state is present, define the users login password. Also works with update. Note that always returns changed. - required: false - default: null update_password: - required: false default: always choices: ['always', 'on_create'] description: diff --git a/lib/ansible/modules/cloud/amazon/iam_managed_policy.py b/lib/ansible/modules/cloud/amazon/iam_managed_policy.py index d8e8cffbc7..595b50693a 100644 --- a/lib/ansible/modules/cloud/amazon/iam_managed_policy.py +++ b/lib/ansible/modules/cloud/amazon/iam_managed_policy.py @@ -36,13 +36,12 @@ options: only_version: description: - Remove all other non default revisions, if this is used with C(make_default) it will result in all other versions of this policy being deleted. - required: False - default: False + type: bool + default: 'no' state: description: - Should this managed policy be present or absent. Set to absent to detach all entities from this policy and remove it if found. required: True - default: null choices: [ "present", "absent" ] author: "Dan Kozlowski (@dkhenry)" extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/iam_mfa_device_facts.py b/lib/ansible/modules/cloud/amazon/iam_mfa_device_facts.py index 6e61dc51c6..0322cd4081 100644 --- a/lib/ansible/modules/cloud/amazon/iam_mfa_device_facts.py +++ b/lib/ansible/modules/cloud/amazon/iam_mfa_device_facts.py @@ -23,8 +23,6 @@ options: user_name: description: - The name of the user whose MFA devices will be listed - required: false - default: null extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/iam_policy.py b/lib/ansible/modules/cloud/amazon/iam_policy.py index 9a79871034..d45dafabda 100644 --- a/lib/ansible/modules/cloud/amazon/iam_policy.py +++ b/lib/ansible/modules/cloud/amazon/iam_policy.py @@ -30,7 +30,6 @@ options: description: - Type of IAM resource required: true - default: null choices: [ "user", "group", "role"] iam_name: description: @@ -43,23 +42,19 @@ options: policy_document: description: - The path to the properly json formatted policy file (mutually exclusive with C(policy_json)) - required: false policy_json: description: - A properly json formatted policy as string (mutually exclusive with C(policy_document), see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 on how to use it properly) - required: false state: description: - Whether to create or delete the IAM policy. required: true - default: null choices: [ "present", "absent"] skip_duplicates: description: - By default the module looks for any policies that match the document you pass in, if there is a match it will not make a new policy object with the same rules. You can override this by specifying false which would allow for two policy objects with different names but same rules. - required: false default: "/" notes: diff --git a/lib/ansible/modules/cloud/amazon/iam_role_facts.py b/lib/ansible/modules/cloud/amazon/iam_role_facts.py index 8eb673d55f..1b499627f3 100644 --- a/lib/ansible/modules/cloud/amazon/iam_role_facts.py +++ b/lib/ansible/modules/cloud/amazon/iam_role_facts.py @@ -26,16 +26,12 @@ options: description: - Name of a role to search for - Mutually exclusive with C(prefix) - required: false - default: None aliases: - role_name path_prefix: description: - Prefix of role I(path) to restrict IAM role search for - Mutually exclusive with C(name) - required: false - default: None extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/kinesis_stream.py b/lib/ansible/modules/cloud/amazon/kinesis_stream.py index 1543f0072a..95649d2d55 100644 --- a/lib/ansible/modules/cloud/amazon/kinesis_stream.py +++ b/lib/ansible/modules/cloud/amazon/kinesis_stream.py @@ -27,60 +27,46 @@ options: name: description: - "The name of the Kinesis Stream you are managing." - default: None required: true shards: description: - "The number of shards you want to have with this stream." - "This is required when state == present" - required: false - default: None retention_period: description: - "The default retention period is 24 hours and can not be less than 24 hours." - "The retention period can be modified during any point in time." - required: false - default: None state: description: - "Create or Delete the Kinesis Stream." - required: false default: present choices: [ 'present', 'absent' ] wait: description: - Wait for operation to complete before returning. - required: false default: true wait_timeout: description: - How many seconds to wait for an operation to complete before timing out. - required: false default: 300 tags: description: - "A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }." - required: false - default: null aliases: [ "resource_tags" ] encryption_state: description: - "Enable or Disable encryption on the Kinesis Stream." - required: false choices: [ 'enabled', 'disabled' ] version_added: "2.5" encryption_type: description: - "The type of encryption." - required: false default: KMS version_added: "2.5" key_id: description: - "The GUID or alias for the KMS key." - required: false - default: None version_added: "2.5" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/lambda.py b/lib/ansible/modules/cloud/amazon/lambda.py index 8d91872e9f..b172468246 100644 --- a/lib/ansible/modules/cloud/amazon/lambda.py +++ b/lib/ansible/modules/cloud/amazon/lambda.py @@ -51,76 +51,53 @@ options: handler: description: - The function within your code that Lambda calls to begin execution - default: null zip_file: description: - A .zip file containing your deployment package - If C(state=present) then either zip_file or s3_bucket must be present. - required: false - default: null aliases: [ 'src' ] s3_bucket: description: - Amazon S3 bucket name where the .zip file containing your deployment package is stored - If C(state=present) then either zip_file or s3_bucket must be present. - s3_bucket and s3_key are required together - required: false - default: null s3_key: description: - The Amazon S3 object (the deployment package) key name you want to upload - s3_bucket and s3_key are required together - required: false - default: null s3_object_version: description: - The Amazon S3 object (the deployment package) version you want to upload. - required: false - default: null description: description: - A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit. - required: false - default: null timeout: description: - The function execution time at which Lambda should terminate the function. - required: false default: 3 memory_size: description: - The amount of memory, in MB, your Lambda function is given - required: false default: 128 vpc_subnet_ids: description: - List of subnet IDs to run Lambda function in. Use this option if you need to access resources in your VPC. Leave empty if you don't want to run the function in a VPC. - required: false - default: None vpc_security_group_ids: description: - List of VPC security group IDs to associate with the Lambda function. Required when vpc_subnet_ids is used. - required: false - default: None environment_variables: description: - A dictionary of environment variables the Lambda function is given. - required: false - default: None aliases: [ 'environment' ] version_added: "2.3" dead_letter_arn: description: - The parent object that contains the target Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. - required: false - default: None version_added: "2.3" tags: description: - tag dict to apply to the function (requires botocore 1.5.40 or above) - required: false - default: None version_added: "2.5" author: - 'Steyn Huizinga (@steynovich)' diff --git a/lib/ansible/modules/cloud/amazon/lambda_facts.py b/lib/ansible/modules/cloud/amazon/lambda_facts.py index 71137e099e..d3636a3410 100644 --- a/lib/ansible/modules/cloud/amazon/lambda_facts.py +++ b/lib/ansible/modules/cloud/amazon/lambda_facts.py @@ -40,14 +40,10 @@ options: function_name: description: - The name of the lambda function for which facts are requested. - required: false - default: null aliases: [ "function", "name"] event_source_arn: description: - For query type 'mappings', this is the Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream. - default: null - required: false author: Pierre Jodouin (@pjodouin) requirements: - boto3 diff --git a/lib/ansible/modules/cloud/amazon/lightsail.py b/lib/ansible/modules/cloud/amazon/lightsail.py index 03a647f905..275e9dc67b 100644 --- a/lib/ansible/modules/cloud/amazon/lightsail.py +++ b/lib/ansible/modules/cloud/amazon/lightsail.py @@ -29,37 +29,26 @@ options: description: - Name of the instance required: true - default : null zone: description: - AWS availability zone in which to launch the instance. Required when state='present' - required: false - default: null blueprint_id: description: - ID of the instance blueprint image. Required when state='present' - required: false - default: null bundle_id: description: - Bundle of specification info for the instance. Required when state='present' - required: false - default: null user_data: description: - Launch script that can configure the instance with additional data - required: false - default: null key_pair_name: description: - Name of the key pair to use with the instance - required: false - default: null wait: description: - Wait for the instance to be in state 'running' before returning. If wait is "no" an ip_address may not be returned - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' wait_timeout: description: - How long before wait gives up, in seconds. diff --git a/lib/ansible/modules/cloud/amazon/rds.py b/lib/ansible/modules/cloud/amazon/rds.py index 2ac178b440..19669c44a5 100644 --- a/lib/ansible/modules/cloud/amazon/rds.py +++ b/lib/ansible/modules/cloud/amazon/rds.py @@ -29,42 +29,28 @@ options: instance_name: description: - Database instance identifier. Required except when using command=facts or command=delete on just a snapshot - required: false - default: null source_instance: description: - Name of the database to replicate. Used only when command=replicate. - required: false - default: null db_engine: description: - The type of database. Used only when command=create. - mariadb was added in version 2.2 - required: false - default: null choices: ['mariadb', 'MySQL', 'oracle-se1', 'oracle-se2', 'oracle-se', 'oracle-ee', 'sqlserver-ee', 'sqlserver-se', 'sqlserver-ex', 'sqlserver-web', 'postgres', 'aurora'] size: description: - Size in gigabytes of the initial storage for the DB instance. Used only when command=create or command=modify. - required: false - default: null instance_type: description: - The instance type of the database. Must be specified when command=create. Optional when command=replicate, command=modify or command=restore. If not specified then the replica inherits the same instance type as the source instance. - required: false - default: null username: description: - Master database username. Used only when command=create. - required: false - default: null password: description: - Password for the master database username. Used only when command=create or command=modify. - required: false - default: null region: description: - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used. @@ -73,119 +59,83 @@ options: db_name: description: - Name of a database to create within the instance. If not specified then no database is created. Used only when command=create. - required: false - default: null engine_version: description: - Version number of the database engine to use. Used only when command=create. If not specified then the current Amazon RDS default engine version is used - required: false - default: null parameter_group: description: - Name of the DB parameter group to associate with this instance. If omitted then the RDS default DBParameterGroup will be used. Used only when command=create or command=modify. - required: false - default: null license_model: description: - The license model for this DB instance. Used only when command=create or command=restore. - required: false - default: null choices: [ 'license-included', 'bring-your-own-license', 'general-public-license', 'postgresql-license' ] multi_zone: description: - Specifies if this is a Multi-availability-zone deployment. Can not be used in conjunction with zone parameter. Used only when command=create or command=modify. - choices: [ "yes", "no" ] - required: false - default: null + type: bool iops: description: - Specifies the number of IOPS for the instance. Used only when command=create or command=modify. Must be an integer greater than 1000. - required: false - default: null security_groups: description: - Comma separated list of one or more security groups. Used only when command=create or command=modify. - required: false - default: null vpc_security_groups: description: - Comma separated list of one or more vpc security group ids. Also requires `subnet` to be specified. Used only when command=create or command=modify. - required: false - default: null port: description: - Port number that the DB instance uses for connections. Used only when command=create or command=replicate. - Prior to 2.0 it always defaults to null and the API would use 3306, it had to be set to other DB default values when not using MySql. Starting at 2.0 it automatically defaults to what is expected for each C(db_engine). - required: false default: 3306 for mysql, 1521 for Oracle, 1433 for SQL Server, 5432 for PostgreSQL. upgrade: description: - Indicates that minor version upgrades should be applied automatically. Used only when command=create or command=replicate. - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' option_group: description: - The name of the option group to use. If not specified then the default option group is used. Used only when command=create. - required: false - default: null maint_window: description: - > Maintenance window in format of ddd:hh24:mi-ddd:hh24:mi. (Example: Mon:22:00-Mon:23:15) If not specified then a random maintenance window is assigned. Used only when command=create or command=modify. - required: false - default: null backup_window: description: - Backup window in format of hh24:mi-hh24:mi. If not specified then a random backup window is assigned. Used only when command=create or command=modify. - required: false - default: null backup_retention: description: - > Number of days backups are retained. Set to 0 to disable backups. Default is 1 day. Valid range: 0-35. Used only when command=create or command=modify. - required: false - default: null zone: description: - availability zone in which to launch the instance. Used only when command=create, command=replicate or command=restore. - required: false - default: null aliases: ['aws_zone', 'ec2_zone'] subnet: description: - VPC subnet group. If specified then a VPC instance is created. Used only when command=create. - required: false - default: null snapshot: description: - Name of snapshot to take. When command=delete, if no snapshot name is provided then no snapshot is taken. If used with command=delete with no instance_name, the snapshot is deleted. Used with command=facts, command=delete or command=snapshot. - required: false - default: null aws_secret_key: description: - AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. - required: false aliases: [ 'ec2_secret_key', 'secret_key' ] aws_access_key: description: - AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used. - required: false - default: null aliases: [ 'ec2_access_key', 'access_key' ] wait: description: - When command=create, replicate, modify or restore then wait for the database to enter the 'available' state. When command=delete wait for the database to be terminated. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds @@ -194,38 +144,29 @@ options: description: - Used only when command=modify. If enabled, the modifications will be applied as soon as possible rather than waiting for the next preferred maintenance window. - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' force_failover: description: - Used only when command=reboot. If enabled, the reboot is done using a MultiAZ failover. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.0" new_instance_name: description: - Name to rename an instance to. Used only when command=modify. - required: false - default: null version_added: "1.5" character_set_name: description: - Associate the DB instance with a specified character set. Used with command=create. - required: false - default: null version_added: "1.9" publicly_accessible: description: - explicitly set whether the resource should be publicly accessible or not. Used with command=create, command=replicate. Requires boto >= 2.26.0 - required: false - default: null version_added: "1.9" tags: description: - tags dict to apply to a resource. Used with command=create, command=replicate, command=restore. Requires boto >= 2.26.0 - required: false - default: null version_added: "1.9" requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/cloud/amazon/rds_subnet_group.py b/lib/ansible/modules/cloud/amazon/rds_subnet_group.py index e415319f00..a1b6f9b5fd 100644 --- a/lib/ansible/modules/cloud/amazon/rds_subnet_group.py +++ b/lib/ansible/modules/cloud/amazon/rds_subnet_group.py @@ -24,26 +24,17 @@ options: - Specifies whether the subnet should be present or absent. required: true default: present - aliases: [] choices: [ 'present' , 'absent' ] name: description: - Database subnet group identifier. required: true - default: null - aliases: [] description: description: - Database subnet group description. Only set when a new group is added. - required: false - default: null - aliases: [] subnets: description: - List of subnet IDs that make up the database subnet group. - required: false - default: null - aliases: [] author: "Scott Anderson (@tastychutney)" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/redshift.py b/lib/ansible/modules/cloud/amazon/redshift.py index 9a3a27dd7e..19f7c821d6 100644 --- a/lib/ansible/modules/cloud/amazon/redshift.py +++ b/lib/ansible/modules/cloud/amazon/redshift.py @@ -50,7 +50,6 @@ options: db_name: description: - Name of the database. - default: null availability_zone: description: - availability zone in which to launch cluster @@ -58,7 +57,6 @@ options: number_of_nodes: description: - Number of nodes. Only used when cluster_type=multi-node. - default: null cluster_subnet_group_name: description: - which subnet to place the cluster @@ -66,79 +64,69 @@ options: cluster_security_groups: description: - in which security group the cluster belongs - default: null aliases: ['security_groups'] vpc_security_group_ids: description: - VPC security group aliases: ['vpc_security_groups'] - default: null skip_final_cluster_snapshot: description: - skip a final snapshot before deleting the cluster. Used only when command=delete. aliases: ['skip_final_snapshot'] - default: false + default: 'no' version_added: "2.4" final_cluster_snapshot_identifier: description: - identifier of the final snapshot to be created before deleting the cluster. If this parameter is provided, final_cluster_snapshot_identifier must be false. Used only when command=delete. aliases: ['final_snapshot_id'] - default: null version_added: "2.4" preferred_maintenance_window: description: - maintenance window aliases: ['maintance_window', 'maint_window'] - default: null cluster_parameter_group_name: description: - name of the cluster parameter group aliases: ['param_group_name'] - default: null automated_snapshot_retention_period: description: - period when the snapshot take place aliases: ['retention_period'] - default: null port: description: - which port the cluster is listining - default: null cluster_version: description: - which version the cluster should have aliases: ['version'] choices: ['1.0'] - default: null allow_version_upgrade: description: - flag to determinate if upgrade of version is possible aliases: ['version_upgrade'] - default: true + default: 'yes' publicly_accessible: description: - if the cluster is accessible publicly or not - default: false + default: 'no' encrypted: description: - if the cluster is encrypted or not - default: false + default: 'no' elastic_ip: description: - if the cluster has an elastic IP or not - default: null new_cluster_identifier: description: - Only used when command=modify. aliases: ['new_identifier'] - default: null wait: description: - When command=create, modify or restore then wait for the database to enter the 'available' state. When command=delete wait for the database to be terminated. - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py b/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py index 74c8769757..7588e1d012 100644 --- a/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py +++ b/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py @@ -35,14 +35,10 @@ options: group_description: description: - Database subnet group description. - required: false - default: null aliases: ['description'] group_subnets: description: - List of subnet IDs that make up the cluster subnet group. - required: false - default: null aliases: ['subnets'] requirements: [ 'boto' ] extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/route53.py b/lib/ansible/modules/cloud/amazon/route53.py index fffe51ce4d..0350ac5c5a 100644 --- a/lib/ansible/modules/cloud/amazon/route53.py +++ b/lib/ansible/modules/cloud/amazon/route53.py @@ -33,9 +33,7 @@ options: hosted_zone_id: description: - The Hosted Zone ID of the DNS zone to modify - required: false version_added: "2.0" - default: null record: description: - The full DNS record to create or delete @@ -43,7 +41,6 @@ options: ttl: description: - The TTL to give the new record - required: false default: 3600 (one hour) type: description: @@ -53,53 +50,43 @@ options: alias: description: - Indicates if this is an alias record. - required: false version_added: "1.9" - default: False - choices: [ 'True', 'False' ] + type: bool + default: 'no' alias_hosted_zone_id: description: - The hosted zone identifier. - required: false version_added: "1.9" - default: null alias_evaluate_target_health: description: - Whether or not to evaluate an alias target health. Useful for aliases to Elastic Load Balancers. - required: false + type: bool + default: no version_added: "2.1" - default: false value: description: - The new value when creating a DNS record. YAML lists or multiple comma-spaced values are allowed for non-alias records. - When deleting a record all values for the record must be specified or Route53 will not delete it. - required: false - default: null overwrite: description: - Whether an existing record should be overwritten on create if values do not match - required: false - default: null retry_interval: description: - In the case that route53 is still servicing a prior request, this module will wait and try again after this many seconds. If you have many domain names, the default of 500 seconds may be too long. - required: false default: 500 private_zone: description: - - If set to true, the private zone matching the requested name within the domain will be used if there are both public and private zones. + - If set to C(yes), the private zone matching the requested name within the domain will be used if there are both public and private zones. The default is to use the public zone. - required: false - default: false + type: bool + default: 'no' version_added: "1.9" identifier: description: - Have to be specified for Weighted, latency-based and failover resource record sets only. An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. - required: false - default: null version_added: "2.0" weight: description: @@ -107,8 +94,6 @@ options: have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location. - required: false - default: null version_added: "2.0" region: description: @@ -116,39 +101,30 @@ options: that have the same combination of DNS name and type, a value that determines which region this should be associated with for the latency-based routing - required: false - default: null version_added: "2.0" health_check: description: - Health check to associate with this record - required: false - default: null version_added: "2.0" failover: description: - Failover resource record sets only. Whether this is the primary or secondary resource record set. Allowed values are PRIMARY and SECONDARY - required: false - default: null version_added: "2.0" vpc_id: description: - "When used in conjunction with private_zone: true, this will only modify records in the private hosted zone attached to this VPC." - This allows you to have multiple private hosted zones, all with the same name, attached to different VPCs. - required: false - default: null version_added: "2.0" wait: description: - Wait until the changes have been replicated to all Amazon Route 53 DNS servers. - required: false - default: no + type: bool + default: 'no' version_added: "2.1" wait_timeout: description: - How long to wait for the changes to be replicated, in seconds. - required: false default: 300 version_added: "2.1" author: diff --git a/lib/ansible/modules/cloud/amazon/route53_health_check.py b/lib/ansible/modules/cloud/amazon/route53_health_check.py index babfde324b..bf608083f6 100644 --- a/lib/ansible/modules/cloud/amazon/route53_health_check.py +++ b/lib/ansible/modules/cloud/amazon/route53_health_check.py @@ -38,14 +38,10 @@ options: description: - IP address of the end-point to check. Either this or `fqdn` has to be provided. - required: false - default: null port: description: - The port on the endpoint on which you want Amazon Route 53 to perform health checks. Required for TCP checks. - required: false - default: null type: description: - The type of health check that you want to create, which indicates how @@ -61,22 +57,17 @@ options: - Required for all checks except TCP. - The path must begin with a / - Maximum 255 characters. - required: false - default: null fqdn: description: - Domain name of the endpoint to check. Either this or `ip_address` has to be provided. When both are given the `fqdn` is used in the `Host:` header of the HTTP request. - required: false string_match: description: - If the check type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the first 5120 bytes of the response body, Amazon Route 53 considers the resource healthy. - required: false - default: null request_interval: description: - The number of seconds between the time that Amazon Route 53 gets a diff --git a/lib/ansible/modules/cloud/amazon/route53_zone.py b/lib/ansible/modules/cloud/amazon/route53_zone.py index 53a7d1dab2..f516690b6c 100644 --- a/lib/ansible/modules/cloud/amazon/route53_zone.py +++ b/lib/ansible/modules/cloud/amazon/route53_zone.py @@ -34,30 +34,22 @@ options: state: description: - whether or not the zone should exist or not - required: false default: present choices: [ "present", "absent" ] vpc_id: description: - The VPC ID the zone should be a part of (if this is going to be a private zone) - required: false - default: null vpc_region: description: - The VPC Region the zone should be a part of (if this is going to be a private zone) - required: false - default: null comment: description: - Comment associated with the zone - required: false default: '' hosted_zone_id: description: - The unique zone identifier you want to delete or "all" if there are many zones with the same domain name. Required if there are multiple zones identified with the above options - required: false - default: null version_added: 2.4 extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/s3_bucket.py b/lib/ansible/modules/cloud/amazon/s3_bucket.py index 1d17d67b5c..58faf513a7 100644 --- a/lib/ansible/modules/cloud/amazon/s3_bucket.py +++ b/lib/ansible/modules/cloud/amazon/s3_bucket.py @@ -30,23 +30,18 @@ options: force: description: - When trying to delete a bucket, delete all keys in the bucket first (an s3 bucket must be empty for a successful deletion) - required: false - default: no - choices: [ 'yes', 'no' ] + type: bool + default: 'no' name: description: - Name of the s3 bucket required: true - default: null policy: description: - The JSON policy as a string. - required: false - default: null s3_url: description: - S3 URL endpoint for usage with Ceph, Eucalypus, fakes3, etc. Otherwise assumes AWS - default: null aliases: [ S3_URL ] ceph: description: @@ -57,9 +52,8 @@ options: description: - With Requester Pays buckets, the requester instead of the bucket owner pays the cost of the request and the data download from the bucket. - required: false - default: no - choices: [ 'yes', 'no' ] + type: bool + default: 'no' state: description: - Create or remove the s3 bucket @@ -69,14 +63,10 @@ options: tags: description: - tags dict to apply to bucket - required: false - default: null versioning: description: - Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended) - required: false - default: null - choices: [ 'yes', 'no' ] + type: bool extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/s3_lifecycle.py b/lib/ansible/modules/cloud/amazon/s3_lifecycle.py index 04f70b3924..e2949525f6 100644 --- a/lib/ansible/modules/cloud/amazon/s3_lifecycle.py +++ b/lib/ansible/modules/cloud/amazon/s3_lifecycle.py @@ -34,40 +34,29 @@ options: - > Indicates the lifetime of the objects that are subject to the rule by the date they will expire. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified. - required: false - default: null expiration_days: description: - "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." - required: false - default: null prefix: description: - "Prefix identifying one or more objects to which the rule applies. If no prefix is specified, the rule will apply to the whole bucket." - required: false - default: null rule_id: description: - "Unique identifier for the rule. The value cannot be longer than 255 characters. A unique value for the rule will be generated if no value is provided." - required: false - default: null state: description: - "Create or remove the lifecycle rule" - required: false default: present choices: [ 'present', 'absent' ] status: description: - "If 'enabled', the rule is currently being applied. If 'disabled', the rule is not currently being applied." - required: false default: enabled choices: [ 'enabled', 'disabled' ] storage_class: description: - "The storage class to transition to. Currently there are two supported values - 'glacier' or 'standard_ia'." - "The 'standard_ia' class is only being available from Ansible version 2.2." - required: false default: glacier choices: [ 'glacier', 'standard_ia'] transition_date: @@ -76,13 +65,9 @@ options: Indicates the lifetime of the objects that are subject to the rule by the date they will transition to a different storage class. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified. If transition_days is not specified, this parameter is required." - required: false - default: null transition_days: description: - "Indicates when, in days, an object transitions to a different storage class. If transition_date is not specified, this parameter is required." - required: false - default: null extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/s3_logging.py b/lib/ansible/modules/cloud/amazon/s3_logging.py index 429915ab2c..044e12a297 100644 --- a/lib/ansible/modules/cloud/amazon/s3_logging.py +++ b/lib/ansible/modules/cloud/amazon/s3_logging.py @@ -27,18 +27,14 @@ options: state: description: - "Enable or disable logging." - required: false default: present choices: [ 'present', 'absent' ] target_bucket: description: - "The bucket to log to. Required when state=present." - required: false - default: null target_prefix: description: - "The prefix that should be prepended to the generated log files written to the target_bucket." - required: false default: "" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/s3_website.py b/lib/ansible/modules/cloud/amazon/s3_website.py index 5cb0dc9b9f..4a5f81e17f 100644 --- a/lib/ansible/modules/cloud/amazon/s3_website.py +++ b/lib/ansible/modules/cloud/amazon/s3_website.py @@ -25,29 +25,21 @@ options: description: - "Name of the s3 bucket" required: true - default: null error_key: description: - "The object key name to use when a 4XX class error occurs. To remove an error key, set to None." - required: false - default: null redirect_all_requests: description: - "Describes the redirect behavior for every request to this s3 bucket website endpoint" - required: false - default: null region: description: - > AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard. - required: false - default: null state: description: - "Add or remove s3 website configuration" - required: false default: present choices: [ 'present', 'absent' ] suffix: @@ -56,7 +48,6 @@ options: Suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html). The suffix must not include a slash character. - required: false default: index.html extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/sns.py b/lib/ansible/modules/cloud/amazon/sns.py index 4ca9277422..6b2d0feb76 100644 --- a/lib/ansible/modules/cloud/amazon/sns.py +++ b/lib/ansible/modules/cloud/amazon/sns.py @@ -29,7 +29,6 @@ options: subject: description: - Subject line for email delivery. - required: false topic: description: - The topic you want to publish to. @@ -37,46 +36,34 @@ options: email: description: - Message to send to email-only subscription - required: false sqs: description: - Message to send to SQS-only subscription - required: false sms: description: - Message to send to SMS-only subscription - required: false http: description: - Message to send to HTTP-only subscription - required: false https: description: - Message to send to HTTPS-only subscription - required: false aws_secret_key: description: - AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. - required: false - default: None aliases: ['ec2_secret_key', 'secret_key'] aws_access_key: description: - AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used. - required: false - default: None aliases: ['ec2_access_key', 'access_key'] region: description: - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used. - required: false aliases: ['aws_region', 'ec2_region'] message_attributes: description: - Dictionary of message attributes. These are optional structured data entries to be sent along to the endpoint. - This is in AWS's distinct Name/Type/Value format; see example below. - required: false - default: None message_structure: description: - The payload format to use for the message. diff --git a/lib/ansible/modules/cloud/amazon/sns_topic.py b/lib/ansible/modules/cloud/amazon/sns_topic.py index 474ac3d938..13f41d51d5 100644 --- a/lib/ansible/modules/cloud/amazon/sns_topic.py +++ b/lib/ansible/modules/cloud/amazon/sns_topic.py @@ -29,30 +29,22 @@ options: state: description: - Whether to create or destroy an SNS topic - required: False default: present choices: ["absent", "present"] display_name: description: - Display name of the topic - required: False - default: None policy: description: - Policy to apply to the SNS topic - required: False - default: None delivery_policy: description: - Delivery policy to apply to the SNS topic - required: False - default: None subscriptions: description: - List of subscriptions to apply to the topic. Note that AWS requires subscriptions to be confirmed, so you will need to confirm any new subscriptions. - required: False default: [] purge_subscriptions: description: @@ -61,8 +53,7 @@ options: exist and would be purged, they are silently skipped. This means that somebody could come back later and confirm the subscription. Sorry. Blame Amazon." - required: False - default: True + default: 'yes' extends_documentation_fragment: - aws - ec2 diff --git a/lib/ansible/modules/cloud/amazon/sqs_queue.py b/lib/ansible/modules/cloud/amazon/sqs_queue.py index e66d224b8d..4f890964a2 100644 --- a/lib/ansible/modules/cloud/amazon/sqs_queue.py +++ b/lib/ansible/modules/cloud/amazon/sqs_queue.py @@ -39,39 +39,25 @@ options: default_visibility_timeout: description: - The default visibility timeout in seconds. - required: false - default: null message_retention_period: description: - The message retention period in seconds. - required: false - default: null maximum_message_size: description: - The maximum message size in bytes. - required: false - default: null delivery_delay: description: - The delivery delay in seconds. - required: false - default: null receive_message_wait_time: description: - The receive message wait time in seconds. - required: false - default: null policy: description: - The json dict policy to attach to queue - required: false - default: null version_added: "2.1" redrive_policy: description: - json dict with the redrive_policy (see example) - required: false - default: null version_added: "2.2" extends_documentation_fragment: - aws diff --git a/lib/ansible/modules/cloud/amazon/sts_assume_role.py b/lib/ansible/modules/cloud/amazon/sts_assume_role.py index 22fb9cf5fc..9615d1f5cb 100644 --- a/lib/ansible/modules/cloud/amazon/sts_assume_role.py +++ b/lib/ansible/modules/cloud/amazon/sts_assume_role.py @@ -34,29 +34,19 @@ options: policy: description: - Supplemental policy to use in addition to assumed role's policies. - required: false - default: null duration_seconds: description: - The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. - required: false - default: null external_id: description: - A unique identifier that is used by third parties to assume a role in their customers' accounts. - required: false - default: null mfa_serial_number: description: - The identification number of the MFA device that is associated with the user who is making the AssumeRole call. - required: false - default: null mfa_token: description: - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - required: false - default: null notes: - In order to use the assumed role in a following playbook task you must pass the access_key, access_secret and access_token extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/amazon/sts_session_token.py b/lib/ansible/modules/cloud/amazon/sts_session_token.py index 12eda6e857..4d0f4fc84e 100644 --- a/lib/ansible/modules/cloud/amazon/sts_session_token.py +++ b/lib/ansible/modules/cloud/amazon/sts_session_token.py @@ -25,18 +25,12 @@ options: - The duration, in seconds, of the session token. See http://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html#API_GetSessionToken_RequestParameters for acceptable and default values. - required: false - default: null mfa_serial_number: description: - The identification number of the MFA device that is associated with the user who is making the GetSessionToken call. - required: false - default: null mfa_token: description: - The value provided by the MFA device, if the trust policy of the user requires MFA. - required: false - default: null notes: - In order to use the session token in a following playbook task you must pass the I(access_key), I(access_secret) and I(access_token). extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/atomic/atomic_container.py b/lib/ansible/modules/cloud/atomic/atomic_container.py index f616393562..3f666c1cf2 100644 --- a/lib/ansible/modules/cloud/atomic/atomic_container.py +++ b/lib/ansible/modules/cloud/atomic/atomic_container.py @@ -33,22 +33,17 @@ options: - Define the backend to use for the container required: True choices: ["docker", "ostree"] - default: None name: description: - Name of the container required: True - default: null image: description: - The image to use to install the container required: True - default: null rootfs: description: - Define the rootfs of the image - required: False - default: null state: description: - State of the container @@ -60,13 +55,10 @@ options: - Define if it is an user or a system container required: True choices: ["user", "system"] - default: None values: description: - Values for the installation of the container. This option is permitted only with mode 'user' or 'system'. The values specified here will be used at installation time as --set arguments for atomic install. - required: False - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/azure/_azure.py b/lib/ansible/modules/cloud/azure/_azure.py index 1b380ef9c7..760f4ef64e 100644 --- a/lib/ansible/modules/cloud/azure/_azure.py +++ b/lib/ansible/modules/cloud/azure/_azure.py @@ -28,22 +28,16 @@ options: description: - name of the virtual machine and associated cloud service. required: true - default: null location: description: - the azure location to use (e.g. 'East US') required: true - default: null subscription_id: description: - azure subscription id. Overrides the AZURE_SUBSCRIPTION_ID environment variable. - required: false - default: null management_cert_path: description: - path to an azure management certificate associated with the subscription id. Overrides the AZURE_CERT_PATH environment variable. - required: false - default: null storage_account: description: - the azure storage account in which to store the data disks. @@ -53,86 +47,65 @@ options: - system image for creating the virtual machine (e.g., b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-precise-12_04_3-LTS-amd64-server-20131205-en-us-30GB) required: true - default: null role_size: description: - azure role size for the new virtual machine (e.g., Small, ExtraLarge, A6). You have to pay attention to the fact that instances of type G and DS are not available in all regions (locations). Make sure if you selected the size and type of instance available in your chosen location. - required: false default: Small endpoints: description: - a comma-separated list of TCP ports to expose on the virtual machine (e.g., "22,80") - required: false default: 22 user: description: - the unix username for the new virtual machine. - required: false - default: null password: description: - the unix password for the new virtual machine. - required: false - default: null ssh_cert_path: description: - path to an X509 certificate containing the public ssh key to install in the virtual machine. See http://www.windowsazure.com/en-us/manage/linux/tutorials/intro-to-linux/ for more details. - if this option is specified, password-based ssh authentication will be disabled. - required: false - default: null virtual_network_name: description: - Name of virtual network. - required: false - default: null hostname: description: - hostname to write /etc/hostname. Defaults to <name>.cloudapp.net. - required: false - default: null wait: description: - wait for the instance to be in state 'running' before returning - required: false - default: "no" - choices: [ "yes", "no" ] - aliases: [] + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds default: 600 - aliases: [] wait_timeout_redirects: description: - how long before wait gives up for redirects, in seconds default: 300 - aliases: [] state: description: - create or terminate instances - required: false + choices: [ absent, present ] default: 'present' - aliases: [] auto_updates: description: - Enable Auto Updates on Windows Machines - required: false version_added: "2.0" - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' enable_winrm: description: - Enable winrm on Windows Machines - required: false version_added: "2.0" - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' os_type: description: - The type of the os that is gettings provisioned - required: false version_added: "2.0" default: "linux" choices: [ "windows", "linux" ] diff --git a/lib/ansible/modules/cloud/azure/azure_rm_acs.py b/lib/ansible/modules/cloud/azure/azure_rm_acs.py index cdd7027e1d..78e53e4a12 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_acs.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_acs.py @@ -36,12 +36,10 @@ options: choices: - absent - present - required: false location: description: - Valid azure location. Defaults to location of the resource group. default: resource_group location - required: false orchestration_platform: description: - Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. @@ -105,8 +103,6 @@ options: service_principal: description: - The service principal suboptions. - required: false - default: null suboptions: client_id: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_availabilityset_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_availabilityset_facts.py index 379b182572..18d19378f4 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_availabilityset_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_availabilityset_facts.py @@ -26,13 +26,9 @@ options: name: description: - Limit results to a specific availability set - required: false - default: null resource_group: description: - The resource group to search for the desired availability set - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py b/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py index 4022c1fba9..53fff0573c 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py @@ -50,7 +50,6 @@ options: choices: - public - none - default: None ports: description: - List of ports exposed within the container group. @@ -93,7 +92,7 @@ options: description: - Force update of existing container instance. Any update will result in deletion and recreation of existing containers. type: bool - default: False + default: 'no' extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py index 3453f00bbf..7f97610a3e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py @@ -27,7 +27,6 @@ options: name: description: - Name of the Container Registry. - default: null required: true state: description: @@ -43,7 +42,8 @@ options: admin_user_enabled: description: - If enabled, you can use the registry name as username and admin user access key as password to docker login to your container registry. - default: false + type: bool + default: no sku: description: - Specifies the SKU to use. Currently can be either Basic, Standard or Premium. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_deployment.py b/lib/ansible/modules/cloud/azure/azure_rm_deployment.py index 57b9a047f6..eb46fc6f40 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_deployment.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_deployment.py @@ -33,13 +33,11 @@ options: location: description: - The geo-locations in which the resource group will be located. - required: false default: westus deployment_mode: description: - In incremental mode, resources are deployed without deleting existing resources that are not included in the template. In complete mode resources are deployed and existing resources in the resource group not included in the template are deleted. - required: false default: incremental choices: - complete @@ -49,7 +47,6 @@ options: - If state is "present", template will be created. If state is "present" and if deployment exists, it will be updated. If state is "absent", stack will be removed. default: present - required: false choices: - present - absent @@ -57,26 +54,18 @@ options: description: - A hash containing the templates inline. This parameter is mutually exclusive with 'template_link'. Either one of them is required if "state" parameter is "present". - required: false - default: null template_link: description: - Uri of file containing the template body. This parameter is mutually exclusive with 'template'. Either one of them is required if "state" parameter is "present". - required: false - default: null parameters: description: - A hash of all the required template variables for the deployment template. This parameter is mutually exclusive with 'parameters_link'. Either one of them is required if "state" parameter is "present". - required: false - default: null parameters_link: description: - Uri of file containing the parameters body. This parameter is mutually exclusive with 'parameters'. Either one of them is required if "state" parameter is "present". - required: false - default: null deployment_name: description: - The name of the deployment to be tracked in the resource group deployment history. Re-using a deployment name @@ -85,8 +74,8 @@ options: wait_for_deployment_completion: description: - Whether or not to block until the deployment has completed. - default: yes - choices: ['yes', 'no'] + type: bool + default: 'yes' wait_for_deployment_polling_period: description: - Time (in seconds) to wait between polls when waiting for deployment completion. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py index b65af48e23..8550001b0a 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py @@ -24,20 +24,14 @@ options: name: description: - Only show results for a specific Function App - required: false - default: null resource_group: description: - Limit results to a resource group. Required when filtering by name - required: false - default: null aliases: - resource_group_name tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_loadbalancer_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_loadbalancer_facts.py index e9f69b37ed..1a7f824254 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_loadbalancer_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_loadbalancer_facts.py @@ -41,18 +41,12 @@ options: name: description: - Limit results to a specific resource group. - required: false - default: null resource_group: description: - The resource group to search for the desired load balancer - required: false - default: null tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_managed_disk_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_managed_disk_facts.py index 0fb40c30cc..89ae3236dc 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_managed_disk_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_managed_disk_facts.py @@ -38,18 +38,12 @@ options: name: description: - Limit results to a specific managed disk - required: false - default: null resource_group: description: - Limit results to a specific resource group - required: false - default: null tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py index 13ac61a373..ffccfe234b 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py @@ -50,7 +50,6 @@ options: description: - Valid azure location. Defaults to location of the resource group. default: resource_group location - required: false virtual_network_name: description: - Name or id of an existing virtual network with which the network interface will be associated. Required @@ -65,7 +64,6 @@ options: aliases: - subnet required: true - default: null os_type: description: - Determines any rules to be added to a default security group. When creating a network interface, if no @@ -95,7 +93,8 @@ options: - (Deprecate) When creating a network interface, if no public IP address name is provided a default public IP address will be created. Set to false, if you do not want a public IP address automatically created. - This option will be deprecated in 2.9, use I(ip_configurations) instead. - default: true + type: bool + default: 'yes' public_ip_address_name: description: - (Deprecate) Name of an existing public IP address object to associate with the security group. @@ -103,7 +102,6 @@ options: aliases: - public_ip_address - public_ip_name - default: null public_ip_allocation_method: description: - (Deprecate) If a public_ip_address_name is not provided, a default public IP address will be created. The allocation @@ -146,7 +144,8 @@ options: primary: description: - Whether the ip configuration is the primary one in the list. - default: False + type: bool + default: 'no' version_added: 2.5 security_group_name: description: @@ -154,13 +153,11 @@ options: default security group will be created. aliases: - security_group - default: null open_ports: description: - When a default security group is created for a Linux host a rule will be added allowing inbound TCP connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports. - default: null extends_documentation_fragment: - azure - azure_tags diff --git a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface_facts.py index 7889acc732..33359eda36 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface_facts.py @@ -29,18 +29,12 @@ options: name: description: - Only show results for a specific network interface. - required: false - default: null resource_group: description: - Name of the resource group containing the network interface(s). Required when searching by name. - required: false - default: null tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py b/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py index ec0ba6c833..795147a8c6 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py @@ -39,15 +39,12 @@ options: - Dynamic - Static default: Dynamic - required: false domain_name_label: description: - The customizable portion of the FQDN assigned to public IP address. This is an explicit setting. If no value is provided, any existing value will be removed on an existing public IP. aliases: - domain_name_label - required: false - default: null name: description: - Name of the Public IP. @@ -60,12 +57,10 @@ options: choices: - absent - present - required: false location: description: - Valid azure location. Defaults to location of the resource group. default: resource_group location - required: false extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress_facts.py index 49b2743e7c..91e2d9f907 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_publicipaddress_facts.py @@ -29,18 +29,12 @@ options: name: description: - Only show results for a specific Public IP. - required: false - default: null resource_group: description: - Limit results by resource group. Required when using name parameter. - required: false - default: null tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py b/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py index d9a746851d..85063cf303 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py @@ -26,14 +26,12 @@ options: description: - Remove a resource group and all associated resources. Use with state 'absent' to delete a resource group that contains resources. - default: false - required: false + type: bool + default: 'no' location: description: - Azure location for the resource group. Required when creating a new resource group. Cannot be changed once resource group is created. - required: false - default: null name: description: - Name of the resource group. @@ -47,7 +45,6 @@ options: choices: - absent - present - required: false extends_documentation_fragment: - azure - azure_tags diff --git a/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup_facts.py index 768302978d..f73b315ad6 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_resourcegroup_facts.py @@ -29,13 +29,9 @@ options: name: description: - Limit results to a specific resource group. - required: false - default: null tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py index 045640a06d..1e01db6a2c 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py @@ -31,28 +31,23 @@ options: - The set of default rules automatically added to a security group at creation. In general default rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See rules below for the makeup of a rule dict. - required: false - default: null location: description: - Valid azure location. Defaults to location of the resource group. default: resource_group location - required: false name: description: - Name of the security group to operate on. - required: false - default: null purge_default_rules: description: - Remove any existing rules not matching those defined in the default_rules parameter. - default: false - required: false + type: bool + default: 'no' purge_rules: description: - Remove any existing rules not matching those defined in the rules parameters. - default: false - required: false + type: bool + default: 'no' resource_group: description: - Name of the resource group the security group belongs to. @@ -60,8 +55,6 @@ options: rules: description: - Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary. - required: false - default: null suboptions: name: description: @@ -122,7 +115,6 @@ options: - Assert the state of the security group. Set to 'present' to create or update a security group. Set to 'absent' to remove a security group. default: present - required: false choices: - absent - present diff --git a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup_facts.py index 95659b72f8..92bc67a734 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup_facts.py @@ -29,8 +29,6 @@ options: name: description: - Only show results for a specific security group. - required: false - default: null resource_group: description: - Name of the resource group to use. @@ -38,8 +36,6 @@ options: tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py index ed9fcedef3..c32ea7f707 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py @@ -31,29 +31,23 @@ options: name: description: - Name of the storage account to update or create. - required: false - default: null state: description: - Assert the state of the storage account. Use 'present' to create or update a storage account and 'absent' to delete an account. default: present - required: false choices: - absent - present location: description: - Valid azure location. Defaults to location of the resource group. - required: false default: resource_group location account_type: description: - "Type of storage account. Required when creating a storage account. NOTE: Standard_ZRS and Premium_LRS accounts cannot be changed to other account types, and other account types cannot be changed to Standard_ZRS or Premium_LRS." - required: false - default: null choices: - Premium_LRS - Standard_GRS @@ -68,12 +62,9 @@ options: keys where 'name' is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. - Can be added to an existing storage account. Will be ignored during storage account creation. - required: false - default: null kind: description: - The 'kind' of storage. - required: false default: 'Storage' choices: - Storage @@ -82,7 +73,6 @@ options: access_tier: description: - The access tier for this storage account. Required for a storage account of kind 'BlobStorage'. - required: false default: 'Storage' choices: - Hot diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py index 5bb6d371e0..6a8542e256 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py @@ -29,20 +29,14 @@ options: name: description: - Only show results for a specific account. - required: false - default: null resource_group: description: - Limit results to a resource group. Required when filtering by name. - required: false - default: null aliases: - resource_group_name tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py b/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py index b66c5283ca..f813ee71b2 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_storageblob.py @@ -33,14 +33,11 @@ options: blob: description: - Name of a blob object within the container. - required: false - default: null aliases: - blob_name blob_type: description: - Type of Blob Object. - required: false default: block choices: - block @@ -55,46 +52,32 @@ options: content_type: description: - Set the blob content-type header. For example, 'image/png'. - default: null - required: false cache_control: description: - Set the blob cache-control header. - required: false - default: null content_disposition: description: - Set the blob content-disposition header. - required: false - default: null content_encoding: description: - Set the blob encoding header. - required: false - default: null content_language: description: - Set the blob content-language header. - required: false - default: null content_md5: description: - Set the blob md5 hash value. - required: false - default: null dest: description: - Destination file path. Use with state 'present' to download a blob. aliases: - destination - required: false - default: null force: description: - Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs. - default: false - required: false + type: bool + default: no resource_group: description: - Name of the resource group to use. @@ -106,8 +89,6 @@ options: - Source file path. Use with state 'present' to upload a blob. aliases: - source - required: false - default: null state: description: - Assert the state of a container or blob. @@ -120,7 +101,6 @@ options: to download. If a blob (uploading) or a file (downloading) already exists, it will not be overwritten unless the force parameter is true. default: present - required: false choices: - absent - present @@ -128,8 +108,6 @@ options: description: - Determine a container's level of public access. By default containers are private. Can only be set at time of container creation. - required: false - default: null choices: - container - blob diff --git a/lib/ansible/modules/cloud/azure/azure_rm_subnet.py b/lib/ansible/modules/cloud/azure/azure_rm_subnet.py index 5fd4748959..73ac240eab 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_subnet.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_subnet.py @@ -42,15 +42,12 @@ options: security_group_name: description: - Name of an existing security group with which to associate the subnet. - required: false - default: null aliases: - security_group state: description: - Assert the state of the subnet. Use 'present' to create or update a subnet and 'absent' to delete a subnet. - required: false default: present choices: - absent diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py index c4fa68e21b..bae26792f5 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py @@ -41,8 +41,6 @@ options: custom_data: description: - Data which is made available to the virtual machine and used by e.g., cloud-init. - default: null - required: false version_added: "2.5" state: description: @@ -66,7 +64,6 @@ options: restarted: description: - Use with state 'present' to restart a running VM. - default: false location: description: - Valid Azure location. Defaults to location of the resource group. @@ -115,7 +112,6 @@ options: availability_set: description: - Name or ID of an existing availability set to add the VM to. The availability_set should be in the same resource group as VM. - default: null version_added: "2.5" storage_account_name: description: @@ -159,8 +155,6 @@ options: data_disks: description: - Describes list of data disks. - required: false - default: null version_added: "2.4" suboptions: lun: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py index f77aa4a840..23c7c2b1c2 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset.py @@ -128,8 +128,6 @@ options: data_disks: description: - Describes list of data disks. - required: false - default: null version_added: "2.4" suboptions: lun: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py index 3a41cb12a1..895c4260f6 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine_scaleset_facts.py @@ -26,13 +26,9 @@ options: name: description: - Limit results to a specific virtual machine scale set - required: false - default: null resource_group: description: - The resource group to search for the desired virtual machine scale set - required: false - default: null extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py index 8bfeccd304..46bd8faecc 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py @@ -29,8 +29,6 @@ options: name: description: - Only show results for a specific security group. - default: null - required: false location: description: - Azure location value (ie. westus, eastus, eastus2, northcentralus, etc.). Supplying only a @@ -39,23 +37,15 @@ options: publisher: description: - Name of an image publisher. List image offerings associated with a particular publisher. - default: null - required: false offer: description: - Name of an image offering. Combine with sku to see a list of available image versions. - default: null - required: false sku: description: - Image offering SKU. Combine with offer to see a list of available versions. - default: null - required: false version: description: - Specific version number of an image. - default: null - required: false extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py index 5067533943..9416e78c99 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py @@ -33,21 +33,16 @@ options: a new virtual network or using purge_address_prefixes. aliases: - address_prefixes - default: null - required: false dns_servers: description: - Custom list of DNS servers. Maximum length of two. The first server in the list will be treated as the Primary server. This is an explicit list. Existing DNS servers will be replaced with the specified list. Use the purge_dns_servers option to remove all custom DNS servers and revert to default Azure servers. - default: null - required: false location: description: - Valid azure location. Defaults to location of the resource group. default: resource_group location - required: false name: description: - name of the virtual network. @@ -55,13 +50,14 @@ options: purge_address_prefixes: description: - Use with state present to remove any existing address_prefixes. - default: false + type: bool + default: 'no' purge_dns_servers: description: - Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with dns_servers. - default: false - required: false + type: bool + default: 'no' state: description: - Assert the state of the virtual network. Use 'present' to create or update and @@ -70,7 +66,6 @@ options: choices: - absent - present - required: false extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py index 1d78ad0522..04a9893b2d 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py @@ -29,18 +29,12 @@ options: name: description: - Only show results for a specific security group. - default: null - required: false resource_group: description: - Limit results by resource group. Required when filtering by name. - default: null - required: false tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. - default: null - required: false extends_documentation_fragment: - azure diff --git a/lib/ansible/modules/cloud/centurylink/clc_alert_policy.py b/lib/ansible/modules/cloud/centurylink/clc_alert_policy.py index 57d21695be..caf57b9295 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_alert_policy.py +++ b/lib/ansible/modules/cloud/centurylink/clc_alert_policy.py @@ -27,43 +27,30 @@ options: name: description: - The name of the alert policy. This is mutually exclusive with id - required: False - default: None id: description: - The alert policy id. This is mutually exclusive with name - required: False - default: None alert_recipients: description: - A list of recipient email ids to notify the alert. This is required for state 'present' - required: False - default: None metric: description: - The metric on which to measure the condition that will trigger the alert. This is required for state 'present' - required: False - default: None choices: ['cpu','memory','disk'] duration: description: - The length of time in minutes that the condition must exceed the threshold. This is required for state 'present' - required: False - default: None threshold: description: - The threshold that will trigger the alert when the metric equals or exceeds it. This is required for state 'present' This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0 - required: False - default: None state: description: - Whether to create or delete the policy. - required: False default: present choices: ['present','absent'] requirements: diff --git a/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py b/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py index b484fc19c9..7e9245d0c3 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py +++ b/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py @@ -27,32 +27,23 @@ options: description: - Whether to create or delete the firewall policy default: present - required: False choices: ['present', 'absent'] source: description: - The list of source addresses for traffic on the originating firewall. - This is required when state is 'present" - default: None - required: False + This is required when state is 'present' destination: description: - The list of destination addresses for traffic on the terminating firewall. This is required when state is 'present' - default: None - required: False ports: description: - The list of ports associated with the policy. TCP and UDP can take in single ports or port ranges. - default: None - required: False choices: ['any', 'icmp', 'TCP/123', 'UDP/123', 'TCP/123-456', 'UDP/123-456'] firewall_policy_id: description: - Id of the firewall policy. This is required to update or delete an existing firewall policy - default: None - required: False source_account_alias: description: - CLC alias for the source account @@ -60,20 +51,16 @@ options: destination_account_alias: description: - CLC alias for the destination account - default: None - required: False wait: description: - Whether to wait for the provisioning tasks to finish before returning. - default: True - required: False - choices: [True, False] + type: bool + default: 'yes' enabled: description: - Whether the firewall policy is enabled or disabled - default: True - required: False - choices: [True, False] + type: bool + default: 'yes' requirements: - python = 2.7 - requests >= 2.5.0 diff --git a/lib/ansible/modules/cloud/centurylink/clc_loadbalancer.py b/lib/ansible/modules/cloud/centurylink/clc_loadbalancer.py index b03eea2c49..ee2f9f2655 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_loadbalancer.py +++ b/lib/ansible/modules/cloud/centurylink/clc_loadbalancer.py @@ -27,8 +27,6 @@ options: description: description: - A description for the loadbalancer - required: False - default: None alias: description: - The alias of your CLC Account @@ -40,36 +38,27 @@ options: method: description: -The balancing method for the load balancer pool - required: False - default: None choices: ['leastConnection', 'roundRobin'] persistence: description: - The persistence method for the load balancer - required: False - default: None choices: ['standard', 'sticky'] port: description: - Port to configure on the public-facing side of the load balancer pool - required: False - default: None choices: [80, 443] nodes: description: - A list of nodes that needs to be added to the load balancer pool - required: False default: [] status: description: - The status of the loadbalancer - required: False default: enabled choices: ['enabled', 'disabled'] state: description: - Whether to create or delete the load balancer pool - required: False default: present choices: ['present', 'absent', 'port_absent', 'nodes_present', 'nodes_absent'] requirements: diff --git a/lib/ansible/modules/cloud/centurylink/clc_modify_server.py b/lib/ansible/modules/cloud/centurylink/clc_modify_server.py index cda543adff..8c23d5ce9e 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_modify_server.py +++ b/lib/ansible/modules/cloud/centurylink/clc_modify_server.py @@ -26,49 +26,35 @@ options: cpu: description: - How many CPUs to update on the server - required: False - default: None memory: description: - Memory (in GB) to set to the server. - required: False - default: None anti_affinity_policy_id: description: - The anti affinity policy id to be set for a hyper scale server. This is mutually exclusive with 'anti_affinity_policy_name' - required: False - default: None anti_affinity_policy_name: description: - The anti affinity policy name to be set for a hyper scale server. This is mutually exclusive with 'anti_affinity_policy_id' - required: False - default: None alert_policy_id: description: - The alert policy id to be associated to the server. This is mutually exclusive with 'alert_policy_name' - required: False - default: None alert_policy_name: description: - The alert policy name to be associated to the server. This is mutually exclusive with 'alert_policy_id' - required: False - default: None state: description: - The state to insure that the provided resources are in. default: 'present' - required: False choices: ['present', 'absent'] wait: description: - Whether to wait for the provisioning tasks to finish before returning. - default: True - required: False - choices: [ True, False] + type: bool + default: 'yes' requirements: - python = 2.7 - requests >= 2.5.0 diff --git a/lib/ansible/modules/cloud/centurylink/clc_publicip.py b/lib/ansible/modules/cloud/centurylink/clc_publicip.py index 40f874e9e9..5165f84596 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_publicip.py +++ b/lib/ansible/modules/cloud/centurylink/clc_publicip.py @@ -24,12 +24,9 @@ options: - The protocol that the public IP will listen for. default: TCP choices: ['TCP', 'UDP', 'ICMP'] - required: False ports: description: - A list of ports to expose. This is required when state is 'present' - required: False - default: None server_ids: description: - A list of servers to create public ips on. @@ -40,13 +37,11 @@ options: already exists. default: present choices: ['present', 'absent'] - required: False wait: description: - Whether to wait for the tasks to finish before returning. - choices: [ True, False ] - default: True - required: False + type: bool + default: 'yes' requirements: - python = 2.7 - requests >= 2.5.0 diff --git a/lib/ansible/modules/cloud/centurylink/clc_server.py b/lib/ansible/modules/cloud/centurylink/clc_server.py index 82cb03b78e..222c92e9c6 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_server.py +++ b/lib/ansible/modules/cloud/centurylink/clc_server.py @@ -22,201 +22,144 @@ options: additional_disks: description: - The list of additional disks for the server - required: False default: [] add_public_ip: description: - Whether to add a public ip to the server - required: False - default: False - choices: [False, True] + type: bool + default: 'no' alias: description: - The account alias to provision the servers under. - required: False - default: None anti_affinity_policy_id: description: - The anti-affinity policy to assign to the server. This is mutually exclusive with 'anti_affinity_policy_name'. - required: False - default: None anti_affinity_policy_name: description: - The anti-affinity policy to assign to the server. This is mutually exclusive with 'anti_affinity_policy_id'. - required: False - default: None alert_policy_id: description: - The alert policy to assign to the server. This is mutually exclusive with 'alert_policy_name'. - required: False - default: None alert_policy_name: description: - The alert policy to assign to the server. This is mutually exclusive with 'alert_policy_id'. - required: False - default: None count: description: - The number of servers to build (mutually exclusive with exact_count) - required: False default: 1 count_group: description: - Required when exact_count is specified. The Server Group use to determine how many severs to deploy. - required: False - default: None cpu: description: - How many CPUs to provision on the server default: 1 - required: False cpu_autoscale_policy_id: description: - The autoscale policy to assign to the server. - default: None - required: False custom_fields: description: - The list of custom fields to set on the server. default: [] - required: False description: description: - The description to set for the server. - default: None - required: False exact_count: description: - Run in idempotent mode. Will insure that this exact number of servers are running in the provided group, creating and deleting them to reach that count. Requires count_group to be set. - default: None - required: False group: description: - The Server Group to create servers under. default: 'Default Group' - required: False ip_address: description: - The IP Address for the server. One is assigned if not provided. - default: None - required: False location: description: - The Datacenter to create servers in. - default: None - required: False managed_os: description: - Whether to create the server as 'Managed' or not. - default: False + type: bool + default: 'no' required: False - choices: [True, False] memory: description: - Memory in GB. default: 1 - required: False name: description: - A 1 to 6 character identifier to use for the server. This is required when state is 'present' - default: None - required: False network_id: description: - The network UUID on which to create servers. - default: None - required: False packages: description: - The list of blue print packages to run on the server after its created. default: [] - required: False password: description: - Password for the administrator / root user - default: None - required: False primary_dns: description: - Primary DNS used by the server. - default: None - required: False public_ip_protocol: description: - The protocol to use for the public ip if add_public_ip is set to True. default: 'TCP' choices: ['TCP', 'UDP', 'ICMP'] - required: False public_ip_ports: description: - A list of ports to allow on the firewall to the servers public ip, if add_public_ip is set to True. default: [] - required: False secondary_dns: description: - Secondary DNS used by the server. - default: None - required: False server_ids: description: - Required for started, stopped, and absent states. A list of server Ids to insure are started, stopped, or absent. default: [] - required: False source_server_password: description: - The password for the source server if a clone is specified. - default: None - required: False state: description: - The state to insure that the provided resources are in. default: 'present' - required: False choices: ['present', 'absent', 'started', 'stopped'] storage_type: description: - The type of storage to attach to the server. default: 'standard' - required: False choices: ['standard', 'hyperscale'] template: description: - The template to use for server creation. Will search for a template if a partial string is provided. This is required when state is 'present' - default: None - required: False ttl: description: - The time to live for the server in seconds. The server will be deleted when this time expires. - default: None - required: False type: description: - The type of server to create. default: 'standard' - required: False choices: ['standard', 'hyperscale', 'bareMetal'] configuration_id: description: - Only required for bare metal servers. Specifies the identifier for the specific configuration type of bare metal server to deploy. - default: None - required: False os_type: description: - Only required for bare metal servers. Specifies the OS to provision with the bare metal server. - default: None - required: False choices: ['redHat6_64Bit', 'centOS6_64Bit', 'windows2012R2Standard_64Bit', 'ubuntu14_64Bit'] wait: description: - Whether to wait for the provisioning tasks to finish before returning. - default: True - required: False - choices: [True, False] + type: bool + default: 'yes' requirements: - python = 2.7 - requests >= 2.5.0 diff --git a/lib/ansible/modules/cloud/cloudstack/cs_account.py b/lib/ansible/modules/cloud/cloudstack/cs_account.py index ea0406c120..b140ef4ce3 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_account.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_account.py @@ -40,65 +40,48 @@ options: description: - Username of the user to be created if account did not exist. - Required on C(state=present). - required: false - default: null password: description: - Password of the user to be created if account did not exist. - Required on C(state=present). - required: false - default: null first_name: description: - First name of the user to be created if account did not exist. - Required on C(state=present). - required: false - default: null last_name: description: - Last name of the user to be created if account did not exist. - Required on C(state=present). - required: false - default: null email: description: - Email of the user to be created if account did not exist. - Required on C(state=present). - required: false - default: null timezone: description: - Timezone of the user to be created if account did not exist. - required: false - default: null network_domain: description: - Network domain of the account. - required: false - default: null account_type: description: - Type of the account. - required: false default: 'user' choices: [ 'user', 'root_admin', 'domain_admin' ] domain: description: - Domain the account is related to. - required: false default: 'ROOT' state: description: - State of the account. - C(unlocked) is an alias for C(enabled). - required: false default: 'present' choices: [ 'present', 'absent', 'enabled', 'disabled', 'locked', 'unlocked' ] poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py b/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py index e04d19f1b1..f902860770 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py @@ -39,40 +39,29 @@ options: affinity_type: description: - Type of the affinity group. If not specified, first found affinity type is used. - required: false - default: null aliases: [ affinty_type ] description: description: - Description of the affinity group. - required: false - default: null state: description: - State of the affinity group. - required: false default: 'present' choices: [ 'present', 'absent' ] domain: description: - Domain the affinity group is related to. - required: false - default: null account: description: - Account the affinity group is related to. - required: false - default: null project: description: - Name of the project the affinity group is related to. - required: false - default: null poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_cluster.py b/lib/ansible/modules/cloud/cloudstack/cs_cluster.py index b8ebdff4f7..e1da0c38fc 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_cluster.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_cluster.py @@ -40,102 +40,67 @@ options: description: - Name of the zone in which the cluster belongs to. - If not set, default zone is used. - required: false - default: null pod: description: - Name of the pod in which the cluster belongs to. - required: false - default: null cluster_type: description: - Type of the cluster. - Required if C(state=present) - required: false - default: null choices: [ 'CloudManaged', 'ExternalManaged' ] hypervisor: description: - Name the hypervisor to be used. - Required if C(state=present). - required: false - default: none choices: [ 'KVM', 'VMware', 'BareMetal', 'XenServer', 'LXC', 'HyperV', 'UCS', 'OVM' ] url: description: - URL for the cluster - required: false - default: null username: description: - Username for the cluster. - required: false - default: null password: description: - Password for the cluster. - required: false - default: null guest_vswitch_name: description: - Name of virtual switch used for guest traffic in the cluster. - This would override zone wide traffic label setting. - required: false - default: null guest_vswitch_type: description: - Type of virtual switch used for guest traffic in the cluster. - Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) - required: false - default: null choices: [ 'vmwaresvs', 'vmwaredvs' ] public_vswitch_name: description: - Name of virtual switch used for public traffic in the cluster. - This would override zone wide traffic label setting. - required: false - default: null public_vswitch_type: description: - Type of virtual switch used for public traffic in the cluster. - Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch) - required: false - default: null choices: [ 'vmwaresvs', 'vmwaredvs' ] vms_ip_address: description: - IP address of the VSM associated with this cluster. - required: false - default: null vms_username: description: - Username for the VSM associated with this cluster. - required: false - default: null vms_password: description: - Password for the VSM associated with this cluster. - required: false - default: null ovm3_cluster: description: - Ovm3 native OCFS2 clustering enabled for cluster. - required: false - default: null ovm3_pool: description: - Ovm3 native pooling enabled for cluster. - required: false - default: null ovm3_vip: description: - Ovm3 vip to use for pool (and cluster). - required: false - default: null state: description: - State of the cluster. - required: false default: 'present' choices: [ 'present', 'absent', 'disabled', 'enabled' ] extends_documentation_fragment: cloudstack diff --git a/lib/ansible/modules/cloud/cloudstack/cs_configuration.py b/lib/ansible/modules/cloud/cloudstack/cs_configuration.py index cc5659da98..241de695e5 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_configuration.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_configuration.py @@ -43,29 +43,20 @@ options: account: description: - Ensure the value for corresponding account. - required: false - default: null domain: description: - Domain the account is related to. - Only considered if C(account) is used. - required: false default: ROOT zone: description: - Ensure the value for corresponding zone. - required: false - default: null storage: description: - Ensure the value for corresponding storage pool. - required: false - default: null cluster: description: - Ensure the value for corresponding cluster. - required: false - default: null extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py b/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py index 75dcfa5295..ec53513e04 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py @@ -47,45 +47,32 @@ options: ip_address: description: - IP address to be used for the nic. - required: false - default: null vpc: description: - Name of the VPC the C(vm) is related to. - required: false - default: null domain: description: - Domain the instance is related to. - required: false - default: null account: description: - Account the instance is related to. - required: false - default: null project: description: - Name of the project the instance is deployed in. - required: false - default: null zone: description: - Name of the zone in which the instance is deployed in. - If not set, default zone is used. - required: false - default: null state: description: - State of the nic. - required: false default: "present" choices: [ 'present', 'absent' ] poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py b/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py index ca28790acb..9cf832c82c 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py @@ -39,22 +39,15 @@ options: domain: description: - Domain the instance group is related to. - required: false - default: null account: description: - Account the instance group is related to. - required: false - default: null project: description: - Project the instance group is related to. - required: false - default: null state: description: - State of the instance group. - required: false default: 'present' choices: [ 'present', 'absent' ] extends_documentation_fragment: cloudstack diff --git a/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py b/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py index e2259b1df0..496e639b24 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py @@ -55,8 +55,8 @@ options: poll_async: description: - Poll async jobs until job has finished. - default: yes type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_iso.py b/lib/ansible/modules/cloud/cloudstack/cs_iso.py index 7d42437ffe..280bdcd438 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_iso.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_iso.py @@ -40,102 +40,74 @@ options: description: - Display text of the ISO. - If not specified, C(name) will be used. - required: false - default: null version_added: "2.4" url: description: - URL where the ISO can be downloaded from. Required if C(state) is present. - required: false - default: null os_type: description: - Name of the OS that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed. Required if C(state) is present. - required: false - default: null is_ready: description: - - This flag is used for searching existing ISOs. If set to C(true), it will only list ISO ready for deployment e.g. - successfully downloaded and installed. Recommended to set it to C(false). - required: false - default: false + - This flag is used for searching existing ISOs. If set to C(yes), it will only list ISO ready for deployment e.g. + successfully downloaded and installed. Recommended to set it to C(no). + type: bool + default: no is_public: description: - Register the ISO to be publicly available to all users. Only used if C(state) is present. - required: false - default: null is_featured: description: - Register the ISO to be featured. Only used if C(state) is present. - required: false - default: null is_dynamically_scalable: description: - Register the ISO having XS/VMWare tools installed inorder to support dynamic scaling of VM cpu/memory. Only used if C(state) is present. - required: false - default: null checksum: description: - The MD5 checksum value of this ISO. If set, we search by checksum instead of name. - required: false - default: null bootable: description: - Register the ISO to be bootable. Only used if C(state) is present. - required: false - default: null domain: description: - Domain the ISO is related to. - required: false - default: null account: description: - Account the ISO is related to. - required: false - default: null project: description: - Name of the project the ISO to be registered in. - required: false - default: null zone: description: - Name of the zone you wish the ISO to be registered or deleted from. - If not specified, first zone found will be used. - required: false - default: null cross_zones: description: - Whether the ISO should be synced or removed across zones. - Mutually exclusive with C(zone). - required: false - default: false + type: bool + default: 'no' version_added: "2.4" iso_filter: description: - Name of the filter used to search for the ISO. - required: false default: 'self' choices: [ 'featured', 'self', 'selfexecutable','sharedexecutable','executable', 'community' ] state: description: - State of the ISO. - required: false default: 'present' choices: [ 'present', 'absent' ] poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' version_added: "2.3" tags: description: - List of tags. Tags are a list of dictionaries having keys C(key) and C(value). - "To delete all tags, set a empty list e.g. C(tags: [])." - required: false - default: null aliases: [ 'tag' ] version_added: "2.4" extends_documentation_fragment: cloudstack diff --git a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py index 153da6fbed..240e9fc496 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py @@ -42,13 +42,10 @@ options: description: description: - The description of the load balancer rule. - required: false - default: null algorithm: description: - Load balancer algorithm - Required when using C(state=present). - required: false choices: [ 'source', 'roundrobin', 'leastconn' ] default: 'source' private_port: @@ -56,15 +53,12 @@ options: - The private port of the private ip address/virtual machine where the network traffic will be load balanced to. - Required when using C(state=present). - Can not be changed once the rule exists due API limitation. - required: false - default: null public_port: description: - The public port from where the network traffic will be load balanced from. - Required when using C(state=present). - Can not be changed once the rule exists due API limitation. required: true - default: null ip_address: description: - Public IP address from where the network traffic will be load balanced from. @@ -74,45 +68,32 @@ options: description: - Whether the firewall rule for public port should be created, while creating the new rule. - Use M(cs_firewall) for managing firewall rules. - required: false - default: false + type: bool + default: 'no' cidr: description: - CIDR (full notation) to be used for firewall rule if required. - required: false - default: null protocol: description: - The protocol to be used on the load balancer - required: false - default: null project: description: - Name of the project the load balancer IP address is related to. - required: false - default: null state: description: - State of the rule. - required: true default: 'present' choices: [ 'present', 'absent' ] domain: description: - Domain the rule is related to. - required: false - default: null account: description: - Account the rule is related to. - required: false - default: null zone: description: - Name of the zone in which the rule should be created. - If not set, default zone is used. - required: false - default: null extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py index 42ae03b7b4..34579f72e0 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py @@ -43,8 +43,6 @@ options: description: - Public IP address from where the network traffic will be load balanced from. - Only needed to find the rule if C(name) is not unique. - required: false - default: null aliases: [ 'public_ip' ] vms: description: @@ -54,30 +52,21 @@ options: state: description: - Should the VMs be present or absent from the rule. - required: false default: 'present' choices: [ 'present', 'absent' ] project: description: - Name of the project the firewall rule is related to. - required: false - default: null domain: description: - Domain the rule is related to. - required: false - default: null account: description: - Account the rule is related to. - required: false - default: null zone: description: - Name of the zone in which the rule should be located. - If not set, default zone is used. - required: false - default: null extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py b/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py index 7a48572ac4..5c069208c5 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py @@ -39,8 +39,6 @@ options: description: - Description of the network ACL. - If not set, identical to C(name). - required: false - default: null vpc: description: - VPC the network ACL is related to. @@ -48,35 +46,26 @@ options: state: description: - State of the network ACL. - required: false default: 'present' choices: [ 'present', 'absent' ] domain: description: - Domain the network ACL rule is related to. - required: false - default: null account: description: - Account the network ACL rule is related to. - required: false - default: null project: description: - Name of the project the network ACL is related to. - required: false - default: null zone: description: - Name of the zone the VPC is related to. - If not set, default zone is used. - required: false - default: null poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py b/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py index 4990f74b0e..b2529c257e 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py @@ -39,7 +39,6 @@ options: cidr: description: - CIDR of the rule. - required: false default: '0.0.0.0/0' rule_position: description: @@ -50,39 +49,28 @@ options: description: - Protocol of the rule choices: [ tcp, udp, icmp, all, by_number ] - required: false default: tcp protocol_number: description: - Protocol number from 1 to 256 required if C(protocol=by_number). - required: false - default: null start_port: description: - Start port for this rule. - Considered if C(protocol=tcp) or C(protocol=udp). - required: false - default: null aliases: [ port ] end_port: description: - End port for this rule. - Considered if C(protocol=tcp) or C(protocol=udp). - If not specified, equal C(start_port). - required: false - default: null icmp_type: description: - Type of the icmp message being sent. - Considered if C(protocol=icmp). - required: false - default: null icmp_code: description: - Error code for this icmp message. - Considered if C(protocol=icmp). - required: false - default: null vpc: description: - VPC the network ACL is related to. @@ -90,14 +78,12 @@ options: traffic_type: description: - Traffic type of the rule. - required: false choices: [ ingress, egress ] default: ingress aliases: [ type ] action_policy: description: - Action policy of the rule. - required: false choices: [ allow, deny ] default: ingress aliases: [ action ] @@ -105,41 +91,30 @@ options: description: - List of tags. Tags are a list of dictionaries having keys C(key) and C(value). - "If you want to delete all tags, set a empty list e.g. C(tags: [])." - required: false - default: null aliases: [ tag ] domain: description: - Domain the VPC is related to. - required: false - default: null account: description: - Account the VPC is related to. - required: false - default: null project: description: - Name of the project the VPC is related to. - required: false - default: null zone: description: - Name of the zone the VPC related to. - If not set, default zone is used. - required: false - default: null state: description: - State of the network ACL rule. - required: false default: present choices: [ present, absent ] poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_pod.py b/lib/ansible/modules/cloud/cloudstack/cs_pod.py index b775b58b19..2f79782b15 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_pod.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_pod.py @@ -39,41 +39,28 @@ options: id: description: - uuid of the existing pod. - default: null - required: false start_ip: description: - Starting IP address for the Pod. - Required on C(state=present) - default: null - required: false end_ip: description: - Ending IP address for the Pod. - default: null - required: false netmask: description: - Netmask for the Pod. - Required on C(state=present) - default: null - required: false gateway: description: - Gateway for the Pod. - Required on C(state=present) - default: null - required: false zone: description: - Name of the zone in which the pod belongs to. - If not set, default zone is used. - required: false - default: null state: description: - State of the pod. - required: false default: 'present' choices: [ 'present', 'enabled', 'disabled', 'absent' ] extends_documentation_fragment: cloudstack diff --git a/lib/ansible/modules/cloud/cloudstack/cs_project.py b/lib/ansible/modules/cloud/cloudstack/cs_project.py index 851438739d..fbf42bf089 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_project.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_project.py @@ -40,36 +40,27 @@ options: description: - Display text of the project. - If not specified, C(name) will be used as C(display_text). - required: false - default: null state: description: - State of the project. - required: false default: 'present' choices: [ 'present', 'absent', 'active', 'suspended' ] domain: description: - Domain the project is related to. - required: false - default: null account: description: - Account the project is related to. - required: false - default: null tags: description: - List of tags. Tags are a list of dictionaries having keys C(key) and C(value). - "If you want to delete all tags, set a empty list e.g. C(tags: [])." - required: false - default: null version_added: "2.2" poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_region.py b/lib/ansible/modules/cloud/cloudstack/cs_region.py index 0c41b5d8e4..dd79d27524 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_region.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_region.py @@ -41,18 +41,13 @@ options: description: - Name of the region. - Required if C(state=present) - required: false - default: null endpoint: description: - Endpoint URL of the region. - Required if C(state=present) - required: false - default: null state: description: - State of the region. - required: false default: 'present' choices: [ 'present', 'absent' ] extends_documentation_fragment: cloudstack diff --git a/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py b/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py index f7b8be1ee5..443f94bbc7 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py @@ -53,24 +53,17 @@ options: description: - Maximum number of the resource. - Default is unlimited C(-1). - required: false default: -1 aliases: [ 'max' ] domain: description: - Domain the resource is related to. - required: false - default: null account: description: - Account the resource is related to. - required: false - default: null project: description: - Name of the project the resource is related to. - required: false - default: null extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_role.py b/lib/ansible/modules/cloud/cloudstack/cs_role.py index e6a494cd0d..8630a0679b 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_role.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_role.py @@ -40,25 +40,19 @@ options: description: - ID of the role. - If provided, C(id) is used as key. - required: false - default: null aliases: [ 'uuid' ] role_type: description: - Type of the role. - Only considered for creation. - required: false default: User choices: [ 'User', 'DomainAdmin', 'ResourceAdmin', 'Admin' ] description: description: - Description of the role. - required: false - default: null state: description: - State of the role. - required: false default: 'present' choices: [ 'present', 'absent' ] extends_documentation_fragment: cloudstack diff --git a/lib/ansible/modules/cloud/cloudstack/cs_router.py b/lib/ansible/modules/cloud/cloudstack/cs_router.py index a940f48b40..b5bfa9bf05 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_router.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_router.py @@ -40,34 +40,23 @@ options: service_offering: description: - Name or id of the service offering of the router. - required: false - default: null domain: description: - Domain the router is related to. - required: false - default: null account: description: - Account the router is related to. - required: false - default: null project: description: - Name of the project the router is related to. - required: false - default: null zone: description: - Name of the zone the router is deployed in. - If not set, all zones are used. - required: false - default: null version_added: "2.4" state: description: - State of the router. - required: false default: 'present' choices: [ 'present', 'absent', 'started', 'stopped', 'restarted' ] poll_async: diff --git a/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py b/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py index 0c4c187fda..e0ca534930 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py @@ -41,29 +41,20 @@ options: domain: description: - Domain the public key is related to. - required: false - default: null account: description: - Account the public key is related to. - required: false - default: null project: description: - Name of the project the public key to be registered in. - required: false - default: null state: description: - State of the public key. - required: false default: 'present' choices: [ 'present', 'absent' ] public_key: description: - String of the public key. - required: false - default: null extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py b/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py index 7ec76b1971..b7911b6189 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py @@ -40,57 +40,42 @@ options: description: - Name of virtual machine which we make the static NAT for. - Required if C(state=present). - required: false - default: null vm_guest_ip: description: - VM guest NIC secondary IP address for the static NAT. - required: false - default: false + type: bool + default: 'no' network: description: - Network the IP address is related to. - required: false - default: null version_added: "2.2" vpc: description: - VPC the network related to. - required: false - default: null version_added: "2.3" state: description: - State of the static NAT. - required: false default: 'present' choices: [ 'present', 'absent' ] domain: description: - Domain the static NAT is related to. - required: false - default: null account: description: - Account the static NAT is related to. - required: false - default: null project: description: - Name of the project the static NAT is related to. - required: false - default: null zone: description: - Name of the zone in which the virtual machine is in. - If not set, default zone is used. - required: false - default: null poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_user.py b/lib/ansible/modules/cloud/cloudstack/cs_user.py index 33c15a0b8a..6f7eb22cb5 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_user.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_user.py @@ -40,62 +40,46 @@ options: description: - Account the user will be created under. - Required on C(state=present). - required: false - default: null password: description: - Password of the user to be created. - Required on C(state=present). - Only considered on creation and will not be updated if user exists. - required: false - default: null first_name: description: - First name of the user. - Required on C(state=present). - required: false - default: null last_name: description: - Last name of the user. - Required on C(state=present). - required: false - default: null email: description: - Email of the user. - Required on C(state=present). - required: false - default: null timezone: description: - Timezone of the user. - required: false - default: null keys_registered: description: - If API keys of the user should be generated. - "Note: Keys can not be removed by the API again." - required: false - default: null version_added: "2.4" domain: description: - Domain the user is related to. - required: false default: 'ROOT' state: description: - State of the user. - C(unlocked) is an alias for C(enabled). - required: false default: 'present' choices: [ 'present', 'absent', 'enabled', 'disabled', 'locked', 'unlocked' ] poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py b/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py index 1fb7aaa39c..017c12ea34 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py @@ -39,35 +39,26 @@ options: state: description: - State of the VPN gateway. - required: false default: "present" choices: [ 'present', 'absent' ] domain: description: - Domain the VPN gateway is related to. - required: false - default: null account: description: - Account the VPN gateway is related to. - required: false - default: null project: description: - Name of the project the VPN gateway is related to. - required: false - default: null zone: description: - Name of the zone the VPC is related to. - If not set, default zone is used. - required: false - default: null poll_async: description: - Poll async jobs until job has finished. - required: false - default: true + type: bool + default: 'yes' extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_zone.py b/lib/ansible/modules/cloud/cloudstack/cs_zone.py index 6e4c87a1a0..caa81b7d7a 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_zone.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_zone.py @@ -39,73 +39,49 @@ options: id: description: - uuid of the existing zone. - default: null - required: false state: description: - State of the zone. - required: false default: 'present' choices: [ 'present', 'enabled', 'disabled', 'absent' ] domain: description: - Domain the zone is related to. - Zone is a public zone if not set. - required: false - default: null network_domain: description: - Network domain for the zone. - required: false - default: null network_type: description: - Network type of the zone. - required: false default: basic choices: [ 'basic', 'advanced' ] dns1: description: - First DNS for the zone. - Required if C(state=present) - required: false - default: null dns2: description: - Second DNS for the zone. - required: false - default: null internal_dns1: description: - First internal DNS for the zone. - If not set C(dns1) will be used on C(state=present). - required: false - default: null internal_dns2: description: - Second internal DNS for the zone. - required: false - default: null dns1_ipv6: description: - First DNS for IPv6 for the zone. - required: false - default: null dns2_ipv6: description: - Second DNS for IPv6 for the zone. - required: false - default: null guest_cidr_address: description: - Guest CIDR address for the zone. - required: false - default: null dhcp_provider: description: - DHCP provider for the Zone. - required: false - default: null extends_documentation_fragment: cloudstack ''' diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py index 9cc268758d..3af143c8a4 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py @@ -47,9 +47,9 @@ options: description: - Bool, require unique hostnames. By default, DigitalOcean allows multiple hosts with the same name. Setting this to "yes" allows only one host per name. Useful for idempotence. + type: bool + default: 'no' version_added: "1.4" - default: "no" - choices: [ "yes", "no" ] size_id: description: - This is the slug of the size you would like the droplet created with. @@ -65,39 +65,36 @@ options: virtio: description: - "Bool, turn on virtio driver in droplet for improved network and storage I/O." + type: bool + default: 'yes' version_added: "1.4" - default: "yes" - choices: [ "yes", "no" ] private_networking: description: - "Bool, add an additional, private network interface to droplet for inter-droplet communication." + type: bool + default: 'no' version_added: "1.4" - default: "no" - choices: [ "yes", "no" ] backups_enabled: description: - Optional, Boolean, enables backups for your droplet. + type: bool + default: 'no' version_added: "1.6" - default: "no" - choices: [ "yes", "no" ] user_data: description: - opaque blob of data which is made available to the droplet version_added: "2.0" - required: false - default: None ipv6: description: - Optional, Boolean, enable IPv6 for your droplet. + type: bool + default: 'no' version_added: "2.2" - required: false - default: "no" - choices: [ "yes", "no" ] wait: description: - Wait for the droplet to be in state 'running' before returning. If wait is "no" an ip_address may not be returned. - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' wait_timeout: description: - How long before wait gives up, in seconds. diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py index 81f11e3753..398179e8a4 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py @@ -29,18 +29,12 @@ options: ip: description: - Public IP address of the Floating IP. Used to remove an IP - required: false - default: None region: description: - The region that the Floating IP is reserved to. - required: false - default: None droplet_id: description: - The Droplet that the Floating IP has been assigned to. - required: false - default: None oauth_token: description: - DigitalOcean OAuth token. diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py index 20d01c3ec7..61d8f358be 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py @@ -30,20 +30,14 @@ options: fingerprint: description: - This is a unique identifier for the SSH key used to delete a key - required: false - default: None version_added: 2.4 aliases: ['id'] name: description: - The name for the SSH key - required: false - default: None ssh_pub_key: description: - The Public SSH key to add. - required: false - default: None oauth_token: description: - DigitalOcean OAuth token. diff --git a/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py b/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py index 0a7957e24a..9d569ba472 100644 --- a/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py +++ b/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py @@ -45,12 +45,9 @@ options: description: - The name of the target VLAN. - Required if C(state) is C(present). - required: false description: description: - A description of the VLAN. - required: false - default: null network_domain: description: - The Id or name of the target network domain. @@ -58,12 +55,10 @@ options: private_ipv4_base_address: description: - The base address for the VLAN's IPv4 network (e.g. 192.168.1.0). - required: false private_ipv4_prefix_size: description: - The size of the IPv4 address space, e.g 24. - Required, if C(private_ipv4_base_address) is specified. - required: false state: description: - The desired state for the target VLAN. @@ -75,8 +70,8 @@ options: - Permit expansion of the target VLAN's network if the module parameters specify a larger network than the VLAN currently posesses? - If C(False), the module will fail under these conditions. - This is intended to prevent accidental expansion of a VLAN's network (since this operation is not reversible). - required: false - default: False + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/docker/docker_container.py b/lib/ansible/modules/cloud/docker/docker_container.py index f9c7f32044..1e3ab8dde3 100644 --- a/lib/ansible/modules/cloud/docker/docker_container.py +++ b/lib/ansible/modules/cloud/docker/docker_container.py @@ -28,185 +28,137 @@ options: auto_remove: description: - enable auto-removal of the container on daemon side when the container's process exits - default: false + type: bool + default: 'no' version_added: "2.4" blkio_weight: description: - Block IO (relative weight), between 10 and 1000. - default: null - required: false capabilities: description: - List of capabilities to add to the container. - default: null - required: false cleanup: description: - Use with I(detach=false) to remove the container after successful execution. - default: false - required: false + type: bool + default: 'no' version_added: "2.2" command: description: - Command to execute when the container starts. A command may be either a string or a list. Prior to version 2.4, strings were split on commas. - default: null - required: false cpu_period: description: - Limit CPU CFS (Completely Fair Scheduler) period default: 0 - required: false cpu_quota: description: - Limit CPU CFS (Completely Fair Scheduler) quota default: 0 - required: false cpuset_cpus: description: - CPUs in which to allow execution C(1,3) or C(1-3). - default: null - required: false cpuset_mems: description: - Memory nodes (MEMs) in which to allow execution C(0-3) or C(0,1) - default: null - required: false cpu_shares: description: - CPU shares (relative weight). - default: null - required: false detach: description: - Enable detached mode to leave the container running in background. If disabled, the task will reflect the status of the container run (failed if the command failed). - default: true - required: false devices: description: - "List of host device bindings to add to the container. Each binding is a mapping expressed in the format: <path_on_host>:<path_in_container>:<cgroup_permissions>" - default: null - required: false dns_servers: description: - List of custom DNS servers. - default: null - required: false dns_search_domains: description: - List of custom DNS search domains. - default: null - required: false domainname: description: - Container domainname. - default: null - required: false version_added: "2.5" env: description: - Dictionary of key,value pairs. - default: null - required: false env_file: version_added: "2.2" description: - Path to a file containing environment variables I(FOO=BAR). - If variable also present in C(env), then C(env) value will override. - Requires docker-py >= 1.4.0. - default: null - required: false entrypoint: description: - Command that overwrites the default ENTRYPOINT of the image. - default: null - required: false etc_hosts: description: - Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the container's /etc/hosts file. - default: null - required: false exposed_ports: description: - List of additional container ports which informs Docker that the container listens on the specified network ports at runtime. If the port is already exposed using EXPOSE in a Dockerfile, it does not need to be exposed again. - default: null - required: false aliases: - exposed force_kill: description: - Use the kill command when stopping a running container. - default: false - required: false + type: bool + default: 'no' groups: description: - List of additional group names and/or IDs that the container process will run as. - default: null - required: false hostname: description: - Container hostname. - default: null - required: false ignore_image: description: - When C(state) is I(present) or I(started) the module compares the configuration of an existing container to requested configuration. The evaluation includes the image version. If the image version in the registry does not match the container, the container will be recreated. Stop this behavior by setting C(ignore_image) to I(True). - default: false - required: false + type: bool + default: 'no' version_added: "2.2" image: description: - Repository path and tag used to create the container. If an image is not found or pull is true, the image will be pulled from the registry. If no tag is included, 'latest' will be used. - default: null - required: false interactive: description: - Keep stdin open after a container is launched, even if not attached. - default: false - required: false + type: bool + default: 'no' ipc_mode: description: - Set the IPC mode for the container. Can be one of 'container:<name|id>' to reuse another container's IPC namespace or 'host' to use the host's IPC namespace within the container. - default: null - required: false keep_volumes: description: - Retain volumes associated with a removed container. - default: true - required: false + type: bool + default: 'yes' kill_signal: description: - Override default signal used to kill a running container. - default: null - required: false kernel_memory: description: - "Kernel memory limit (format: <number>[<unit>]). Number is a positive integer. Unit can be one of b, k, m, or g. Minimum is 4M." default: 0 - required: false labels: description: - Dictionary of key value pairs. - default: null - required: false links: description: - List of name aliases for linked containers in the format C(container_name:alias) - default: null - required: false log_driver: description: - Specify the logging driver. Docker uses json-file by default. @@ -219,42 +171,32 @@ options: - fluentd - awslogs - splunk - default: null - required: false log_options: description: - Dictionary of options specific to the chosen log_driver. See https://docs.docker.com/engine/admin/logging/overview/ for details. - required: false - default: null mac_address: description: - Container MAC address (e.g. 92:d0:c6:0a:29:33) - default: null - required: false memory: description: - "Memory limit (format: <number>[<unit>]). Number is a positive integer. Unit can be one of b, k, m, or g" default: 0 - required: false memory_reservation: description: - "Memory soft limit (format: <number>[<unit>]). Number is a positive integer. Unit can be one of b, k, m, or g" default: 0 - required: false memory_swap: description: - Total memory limit (memory + swap, format:<number>[<unit>]). Number is a positive integer. Unit can be one of b, k, m, or g. default: 0 - required: false memory_swappiness: description: - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. default: 0 - required: false name: description: - Assign a name to a new container or match an existing container. @@ -268,13 +210,9 @@ options: - container:<name|id> - host - none - default: null - required: false userns_mode: description: - User namespace to use - default: null - required: false version_added: "2.5" networks: description: @@ -284,35 +222,30 @@ options: - If included, C(links) or C(aliases) are lists. - For examples of the data structure and usage see EXAMPLES below. - To remove a container from one or more networks, use the C(purge_networks) option. - default: null - required: false version_added: "2.2" oom_killer: description: - Whether or not to disable OOM Killer for the container. - default: false - required: false + type: bool + default: 'no' oom_score_adj: description: - An integer value containing the score given to the container in order to tune OOM killer preferences. default: 0 - required: false version_added: "2.2" paused: description: - Use with the started state to pause running processes inside the container. - default: false - required: false + type: bool + default: 'no' pid_mode: description: - Set the PID namespace mode for the container. Currently only supports 'host'. - default: null - required: false privileged: description: - Give extended privileges to the container. - default: false - required: false + type: bool + default: 'no' published_ports: description: - List of ports to publish from the container to the host. @@ -329,35 +262,33 @@ options: value encountered in the list of C(networks) is the one that will be used. aliases: - ports - required: false - default: null pull: description: - If true, always pull the latest version of an image. Otherwise, will only pull an image when missing. - default: false - required: false + type: bool + default: 'no' purge_networks: description: - Remove the container from ALL networks not included in C(networks) parameter. - Any default networks such as I(bridge), if not found in C(networks), will be removed as well. - default: false - required: false + type: bool + default: 'no' version_added: "2.2" read_only: description: - Mount the container's root file system as read-only. - default: false - required: false + type: bool + default: 'no' recreate: description: - Use with present and started states to force the re-creation of an existing container. - default: false - required: false + type: bool + default: 'no' restart: description: - Use with started state to force a matching container to be stopped and restarted. - default: false - required: false + type: bool + default: 'no' restart_policy: description: - Container restart policy. Place quotes around I(no) option. @@ -367,24 +298,18 @@ options: - on-failure - unless-stopped default: on-failure - required: false restart_retries: description: - Use with restart policy to control maximum number of restart attempts. default: 0 - required: false shm_size: description: - Size of `/dev/shm`. The format is `<number><unit>`. `number` must be greater than `0`. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). - Omitting the unit defaults to bytes. If you omit the size entirely, the system uses `64m`. - default: null - required: false security_opts: description: - List of security options in the form of C("label:user:User") - default: null - required: false state: description: - 'I(absent) - A container matching the specified name will be stopped and removed. Use force_kill to kill the container @@ -406,7 +331,6 @@ options: with a removed container.' - 'I(stopped) - Asserts that the container is first I(present), and then if the container is running moves it to a stopped state. Use force_kill to kill a container rather than stopping it.' - required: false default: started choices: - absent @@ -416,51 +340,37 @@ options: stop_signal: description: - Override default signal used to stop the container. - default: null - required: false stop_timeout: description: - Number of seconds to wait for the container to stop before sending SIGKILL. - required: false - default: null trust_image_content: description: - - If true, skip image verification. - default: false - required: false + - If C(yes), skip image verification. + type: bool + default: 'no' tmpfs: description: - Mount a tmpfs directory - default: null - required: false version_added: 2.4 tty: description: - Allocate a pseudo-TTY. - default: false - required: false + type: bool + default: 'no' ulimits: description: - "List of ulimit options. A ulimit is specified as C(nofile:262144:262144)" - default: null - required: false sysctls: description: - Dictionary of key,value pairs. - default: null - required: false version_added: 2.4 user: description: - Sets the username or UID used and optionally the groupname or GID for the specified command. - "Can be [ user | user:group | uid | uid:gid | user:gid | uid:group ]" - default: null - required: false uts: description: - Set the UTS namespace mode for the container. - default: null - required: false volumes: description: - List of volumes to mount within the container. @@ -468,23 +378,15 @@ options: - You can specify a read mode for the mount with either C(ro) or C(rw). - SELinux hosts can additionally use C(z) or C(Z) to use a shared or private label for the volume. - default: null - required: false volume_driver: description: - The container volume driver. - default: none - required: false volumes_from: description: - List of container names or Ids to get volumes from. - default: null - required: false working_dir: description: - Path to the working directory. - default: null - required: false version_added: "2.4" extends_documentation_fragment: - docker diff --git a/lib/ansible/modules/cloud/docker/docker_image_facts.py b/lib/ansible/modules/cloud/docker/docker_image_facts.py index c6dff60ab9..93fbf2e1a4 100644 --- a/lib/ansible/modules/cloud/docker/docker_image_facts.py +++ b/lib/ansible/modules/cloud/docker/docker_image_facts.py @@ -28,7 +28,6 @@ options: description: - An image name or a list of image names. Name format will be name[:tag] or repository/name[:tag], where tag is optional. If a tag is not provided, 'latest' will be used. - default: null required: true extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/docker/docker_login.py b/lib/ansible/modules/cloud/docker/docker_login.py index 92ae00df7f..86b85785fe 100644 --- a/lib/ansible/modules/cloud/docker/docker_login.py +++ b/lib/ansible/modules/cloud/docker/docker_login.py @@ -48,20 +48,17 @@ options: description: - "The email address for the registry account. NOTE: private registries may not require this, but Docker Hub requires it." - default: None reauthorize: - required: False description: - Refresh exiting authentication found in the configuration file. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' aliases: - reauth config_path: description: - Custom path to the Docker CLI configuration file. default: ~/.docker/config.json - required: False aliases: - self.config_path - dockercfg_path @@ -74,7 +71,6 @@ options: - docker does not support 'logout' with a custom config file. choices: ['present', 'absent'] default: 'present' - required: False extends_documentation_fragment: - docker diff --git a/lib/ansible/modules/cloud/docker/docker_network.py b/lib/ansible/modules/cloud/docker/docker_network.py index ca0d63e872..fbdf6b3b3f 100644 --- a/lib/ansible/modules/cloud/docker/docker_network.py +++ b/lib/ansible/modules/cloud/docker/docker_network.py @@ -30,7 +30,6 @@ options: connected: description: - List of container names or container IDs to connect to a network. - default: null aliases: - containers @@ -42,7 +41,6 @@ options: driver_options: description: - Dictionary of network settings. Consult docker docs for valid options and values. - default: null force: description: @@ -52,25 +50,25 @@ options: network. This option is required if you have changed the IPAM or driver options and want an existing network to be updated to use the new options. - default: false + type: bool + default: 'no' appends: description: - By default the connected list is canonical, meaning containers not on the list are removed from the network. Use C(appends) to leave existing containers connected. - default: false + type: bool + default: 'no' aliases: - incremental ipam_driver: description: - Specify an IPAM driver. - default: null ipam_options: description: - Dictionary of IPAM options. - default: null state: description: diff --git a/lib/ansible/modules/cloud/docker/docker_service.py b/lib/ansible/modules/cloud/docker/docker_service.py index 51e62fad4c..f4dbb2e8ef 100755 --- a/lib/ansible/modules/cloud/docker/docker_service.py +++ b/lib/ansible/modules/cloud/docker/docker_service.py @@ -35,17 +35,14 @@ options: - Path to a directory containing a docker-compose.yml or docker-compose.yaml file. - Mutually exclusive with C(definition). - Required when no C(definition) is provided. - required: false project_name: description: - Provide a project name. If not provided, the project name is taken from the basename of C(project_src). - Required when C(definition) is provided. - required: false files: description: - List of file names relative to C(project_src). Overrides docker-compose.yml or docker-compose.yaml. - Files are loaded and merged in the order given. - required: false state: description: - Desired state of the project. @@ -55,33 +52,27 @@ options: - absent - present default: present - required: false services: description: - When C(state) is I(present) run I(docker-compose up) on a subset of services. - required: false scale: description: - When C(state) is I(present) scale services. Provide a dictionary of key/value pairs where the key is the name of the service and the value is an integer count for the number of containers. - required: false dependencies: description: - When C(state) is I(present) specify whether or not to include linked services. type: bool - required: false - default: true + default: 'yes' definition: description: - Provide docker-compose yaml describing one or more services, networks and volumes. - Mutually exclusive with C(project_src) and C(files). - required: false hostname_check: description: - Whether or not to check the Docker daemon's hostname against the name provided in the client certificate. type: bool - required: false - default: false + default: 'no' recreate: description: - By default containers will be recreated when their configuration differs from the service definition. @@ -101,53 +92,44 @@ options: - Use the C(nocache) option to ignore the image cache when performing the build. - If an existing image is replaced, services using the image will be recreated unless C(recreate) is I(never). type: bool - required: false - default: false + default: 'no' pull: description: - Use with state I(present) to always pull images prior to starting the application. - Same as running docker-compose pull. - When a new image is pulled, services using the image will be recreated unless C(recreate) is I(never). type: bool - required: false - default: false + default: 'no' version_added: "2.2" nocache: description: - Use with the build option to ignore the cache during the image build process. type: bool - required: false - default: false + default: 'no' version_added: "2.2" remove_images: description: - Use with state I(absent) to remove the all images or only local images. - required: false - default: null remove_volumes: description: - Use with state I(absent) to remove data volumes. - required: false type: bool - default: false + default: 'no' stopped: description: - Use with state I(present) to leave the containers in an exited or non-running state. - required: false type: bool - default: false + default: 'no' restarted: description: - Use with state I(present) to restart all containers. - required: false type: bool - default: false + default: 'no' debug: description: - Include I(actions) in the return values. - required: false type: bool - default: false + default: 'no' extends_documentation_fragment: - docker diff --git a/lib/ansible/modules/cloud/google/gc_storage.py b/lib/ansible/modules/cloud/google/gc_storage.py index a2700a9d2a..cc04e92b1a 100644 --- a/lib/ansible/modules/cloud/google/gc_storage.py +++ b/lib/ansible/modules/cloud/google/gc_storage.py @@ -31,71 +31,56 @@ options: object: description: - Keyname of the object inside the bucket. Can be also be used to create "virtual directories" (see examples). - required: false - default: null src: description: - The source file path when performing a PUT operation. - required: false - default: null dest: description: - The destination file path when downloading an object/key with a GET operation. - required: false force: description: - Forces an overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations. - required: false - default: true + type: bool + default: 'yes' aliases: [ 'overwrite' ] permission: description: - This option let's the user set the canned permissions on the object/bucket that are created. The permissions that can be set are 'private', 'public-read', 'authenticated-read'. - required: false default: private headers: version_added: "2.0" description: - Headers to attach to object. - required: false - default: '{}' + default: {} expiration: description: - Time limit (in seconds) for the URL generated and returned by GCA when performing a mode=put or mode=get_url operation. This url is only available when public-read is the acl for the object. - required: false - default: null mode: description: - Switches the module behaviour between upload, download, get_url (return download url) , get_str (download object as string), create (bucket) and delete (bucket). required: true - default: null choices: [ 'get', 'put', 'get_url', 'get_str', 'delete', 'create' ] gs_secret_key: description: - GS secret key. If not set then the value of the GS_SECRET_ACCESS_KEY environment variable is used. required: true - default: null gs_access_key: description: - GS access key. If not set then the value of the GS_ACCESS_KEY_ID environment variable is used. required: true - default: null region: version_added: "2.4" description: - The gs region to use. If not defined then the value 'US' will be used. See U(https://cloud.google.com/storage/docs/bucket-locations) - required: false default: 'US' versioning: version_added: "2.4" description: - Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended) - required: false - default: null - choices: [ 'yes', 'no' ] + type: bool requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/cloud/google/gcdns_record.py b/lib/ansible/modules/cloud/google/gcdns_record.py index e64da8a7cd..bd7b4a7e6a 100644 --- a/lib/ansible/modules/cloud/google/gcdns_record.py +++ b/lib/ansible/modules/cloud/google/gcdns_record.py @@ -32,7 +32,6 @@ options: state: description: - Whether the given resource record should or should not be present. - required: false choices: ["present", "absent"] default: "present" record: @@ -47,7 +46,6 @@ options: option, or the module will fail. - If both I(zone) and I(zone_id) are specified, I(zone_id) will be used. - required: false zone_id: description: - The Google Cloud ID of the zone (e.g., example-com). @@ -59,7 +57,6 @@ options: number of zones. - If both I(zone) and I(zone_id) are specified, I(zone_id) will be used. - required: false type: description: - The type of resource record to add. @@ -85,7 +82,6 @@ options: description: - The amount of time in seconds that a resource record will remain cached by a caching resolver. - required: false default: 300 overwrite: description: @@ -102,34 +98,25 @@ options: If I(state) is C(absent) and I(overwrite) is C(False), this module will fail if the provided record_data do not match exactly with the existing resource record's record_data. - required: false - choices: [True, False] - default: False + type: bool + default: 'no' service_account_email: description: - The e-mail address for a service account with access to Google Cloud DNS. - required: false - default: null pem_file: description: - The path to the PEM file associated with the service account email. - This option is deprecated and may be removed in a future release. Use I(credentials_file) instead. - required: false - default: null credentials_file: description: - The path to the JSON file associated with the service account email. - required: false - default: null project_id: description: - The Google Cloud Platform project ID to use. - required: false - default: null notes: - See also M(gcdns_zone). - This modules's underlying library does not support in-place updates for diff --git a/lib/ansible/modules/cloud/google/gcdns_zone.py b/lib/ansible/modules/cloud/google/gcdns_zone.py index b17f267a69..5805e5a1ee 100644 --- a/lib/ansible/modules/cloud/google/gcdns_zone.py +++ b/lib/ansible/modules/cloud/google/gcdns_zone.py @@ -31,7 +31,6 @@ options: state: description: - Whether the given zone should or should not be present. - required: false choices: ["present", "absent"] default: "present" zone: @@ -45,33 +44,24 @@ options: description: description: - An arbitrary text string to use for the zone description. - required: false default: "" service_account_email: description: - The e-mail address for a service account with access to Google Cloud DNS. - required: false - default: null pem_file: description: - The path to the PEM file associated with the service account email. - This option is deprecated and may be removed in a future release. Use I(credentials_file) instead. - required: false - default: null credentials_file: description: - The path to the JSON file associated with the service account email. - required: false - default: null project_id: description: - The Google Cloud Platform project ID to use. - required: false - default: null notes: - See also M(gcdns_record). - Zones that are newly created must still be set up with a domain registrar diff --git a/lib/ansible/modules/cloud/google/gce.py b/lib/ansible/modules/cloud/google/gce.py index 529597c269..3360244987 100644 --- a/lib/ansible/modules/cloud/google/gce.py +++ b/lib/ansible/modules/cloud/google/gce.py @@ -25,52 +25,38 @@ options: description: - image string to use for the instance (default will follow latest stable debian image) - required: false default: "debian-8" image_family: description: - image family from which to select the image. The most recent non-deprecated image in the family will be used. - required: false - default: null version_added: "2.4" external_projects: description: - A list of other projects (accessible with the provisioning credentials) to be searched for the image. - required: false - default: null version_added: "2.4" instance_names: description: - a comma-separated list of instance names to create or destroy - required: false - default: null machine_type: description: - machine type to use for the instance, use 'n1-standard-1' by default - required: false default: "n1-standard-1" metadata: description: - a hash/dictionary of custom data for the instance; '{"key":"value", ...}' - required: false - default: null service_account_email: version_added: "1.5.1" description: - service account email - required: false - default: null service_account_permissions: version_added: "2.0" description: - service account permissions (see U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create), --scopes section for detailed information) - required: false - default: null choices: [ "bigquery", "cloud-platform", "compute-ro", "compute-rw", "useraccounts-ro", "useraccounts-rw", "datastore", "logging-write", @@ -82,69 +68,53 @@ options: description: - path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'. - required: false - default: null credentials_file: version_added: "2.1.0" description: - path to the JSON file associated with the service account email - default: null - required: false project_id: version_added: "1.5.1" description: - your GCE project ID - required: false - default: null name: description: - either a name of a single instance or when used with 'num_instances', the base name of a cluster of nodes - required: false aliases: ['base_name'] num_instances: description: - can be used with 'name', specifies the number of nodes to provision using 'name' as a base name - required: false version_added: "2.3" network: description: - name of the network, 'default' will be used if not specified - required: false default: "default" subnetwork: description: - name of the subnetwork in which the instance should be created - required: false - default: null version_added: "2.2" persistent_boot_disk: description: - if set, create the instance with a persistent boot disk - required: false - default: "false" + type: bool + default: 'no' disks: description: - a list of persistent disks to attach to the instance; a string value gives the name of the disk; alternatively, a dictionary value can define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry will be the boot disk (which must be READ_WRITE). - required: false - default: null version_added: "1.7" state: description: - desired state of the resource - required: false default: "present" choices: ["active", "present", "absent", "deleted", "started", "stopped", "terminated"] tags: description: - a comma-separated list of tags to associate with the instance - required: false - default: null zone: description: - the GCE zone to use. The list of available zones is at U(https://cloud.google.com/compute/docs/regions-zones/regions-zones#available). @@ -153,33 +123,31 @@ options: ip_forward: version_added: "1.9" description: - - set to true if the instance can forward ip packets (useful for + - set to C(yes) if the instance can forward ip packets (useful for gateways) - required: false - default: "false" + type: bool + default: 'no' external_ip: version_added: "1.9" description: - type of external ip, ephemeral by default; alternatively, a fixed gce ip or ip name can be given. Specify 'none' if no external ip is desired. - required: false default: "ephemeral" disk_auto_delete: version_added: "1.9" description: - if set boot disk will be removed after instance destruction - required: false - default: "true" + type: bool + default: 'yes' preemptible: version_added: "2.1" description: - - if set to true, instances will be preemptible and time-limited. + - if set to C(yes), instances will be preemptible and time-limited. (requires libcloud >= 0.20.0) - required: false - default: "false" + type: bool + default: 'no' disk_size: description: - The size of the boot disk created for this instance (in GB) - required: false default: 10 version_added: "2.3" diff --git a/lib/ansible/modules/cloud/google/gce_img.py b/lib/ansible/modules/cloud/google/gce_img.py index 2379eeb864..6d6ae1be06 100644 --- a/lib/ansible/modules/cloud/google/gce_img.py +++ b/lib/ansible/modules/cloud/google/gce_img.py @@ -27,55 +27,39 @@ options: description: - the name of the image to create or delete required: true - default: null description: description: - an optional description - required: false - default: null family: description: - an optional family name - required: false - default: null version_added: "2.2" source: description: - the source disk or the Google Cloud Storage URI to create the image from - required: false - default: null state: description: - desired state of the image - required: false default: "present" choices: ["present", "absent"] zone: description: - the zone of the disk specified by source - required: false default: "us-central1-a" timeout: description: - timeout for the operation - required: false default: 180 version_added: "2.0" service_account_email: description: - service account email - required: false - default: null pem_file: description: - path to the pem file associated with the service account email - required: false - default: null project_id: description: - your GCE project ID - required: false - default: null requirements: - "python >= 2.6" - "apache-libcloud" diff --git a/lib/ansible/modules/cloud/google/gce_instance_template.py b/lib/ansible/modules/cloud/google/gce_instance_template.py index e8b7a44314..49cbb1834c 100644 --- a/lib/ansible/modules/cloud/google/gce_instance_template.py +++ b/lib/ansible/modules/cloud/google/gce_instance_template.py @@ -28,8 +28,6 @@ options: name: description: - The name of the GCE instance template. - required: true - default: null size: description: - The desired machine type for the instance template. @@ -38,18 +36,15 @@ options: description: - A source disk to attach to the instance. Cannot specify both I(image) and I(source). - default: null image: description: - The image to use to create the instance. Cannot specify both both I(image) and I(source). - default: null image_family: description: - The image family to use to create the instance. If I(image) has been used I(image_family) is ignored. Cannot specify both I(image) and I(source). - default: null disk_type: description: - Specify a C(pd-standard) disk or C(pd-ssd) @@ -67,12 +62,12 @@ options: subnetwork: description: - The Subnetwork resource name for this instance. - default: null can_ip_forward: description: - - Set to True to allow instance to + - Set to C(yes) to allow instance to send/receive non-matching src/dst packets. - default: false + type: bool + default: 'no' external_ip: description: - The external IP address to use. @@ -84,13 +79,11 @@ options: service_account_email: description: - service account email - default: null service_account_permissions: description: - service account permissions (see U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create), --scopes section for detailed information) - default: null choices: [ "bigquery", "cloud-platform", "compute-ro", "compute-rw", "useraccounts-ro", "useraccounts-rw", "datastore", "logging-write", @@ -102,61 +95,49 @@ options: - Defines whether the instance should be automatically restarted when it is terminated by Compute Engine. - default: null preemptible: description: - Defines whether the instance is preemptible. - default: null tags: description: - a comma-separated list of tags to associate with the instance - default: null metadata: description: - a hash/dictionary of custom data for the instance; '{"key":"value", ...}' - default: null description: description: - description of instance template - default: null disks: description: - a list of persistent disks to attach to the instance; a string value gives the name of the disk; alternatively, a dictionary value can define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry will be the boot disk (which must be READ_WRITE). - default: null nic_gce_struct: description: - Support passing in the GCE-specific formatted networkInterfaces[] structure. - default: null disks_gce_struct: description: - Support passing in the GCE-specific formatted formatted disks[] structure. Case sensitive. see U(https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource) for detailed information - default: null version_added: "2.4" project_id: description: - your GCE project ID - default: null pem_file: description: - path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'. - default: null credentials_file: description: - path to the JSON file associated with the service account email - default: null subnetwork_region: version_added: "2.4" description: - Region that subnetwork resides in. (Required for subnetwork to successfully complete) - default: null requirements: - "python >= 2.6" - "apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials, diff --git a/lib/ansible/modules/cloud/google/gce_lb.py b/lib/ansible/modules/cloud/google/gce_lb.py index 0a4b8f6785..633d851ef9 100644 --- a/lib/ansible/modules/cloud/google/gce_lb.py +++ b/lib/ansible/modules/cloud/google/gce_lb.py @@ -31,108 +31,76 @@ options: httphealthcheck_name: description: - the name identifier for the HTTP health check - required: false - default: null httphealthcheck_port: description: - the TCP port to use for HTTP health checking - required: false default: 80 httphealthcheck_path: description: - the url path to use for HTTP health checking - required: false default: "/" httphealthcheck_interval: description: - the duration in seconds between each health check request - required: false default: 5 httphealthcheck_timeout: description: - the timeout in seconds before a request is considered a failed check - required: false default: 5 httphealthcheck_unhealthy_count: description: - number of consecutive failed checks before marking a node unhealthy - required: false default: 2 httphealthcheck_healthy_count: description: - number of consecutive successful checks before marking a node healthy - required: false default: 2 httphealthcheck_host: description: - host header to pass through on HTTP check requests - required: false - default: null name: description: - name of the load-balancer resource - required: false - default: null protocol: description: - the protocol used for the load-balancer packet forwarding, tcp or udp - required: false default: "tcp" choices: ['tcp', 'udp'] region: description: - the GCE region where the load-balancer is defined - required: false external_ip: description: - the external static IPv4 (or auto-assigned) address for the LB - required: false - default: null port_range: description: - the port (range) to forward, e.g. 80 or 8000-8888 defaults to all ports - required: false - default: null members: description: - a list of zone/nodename pairs, e.g ['us-central1-a/www-a', ...] - required: false aliases: ['nodes'] state: description: - desired state of the LB default: "present" choices: ["active", "present", "absent", "deleted"] - aliases: [] - required: false service_account_email: version_added: "1.6" description: - service account email - required: false - default: null - aliases: [] pem_file: version_added: "1.6" description: - path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'. - required: false - default: null - aliases: [] credentials_file: version_added: "2.1.0" description: - path to the JSON file associated with the service account email - default: null - required: false project_id: version_added: "1.6" description: - your GCE project ID - required: false - default: null - aliases: [] requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/cloud/google/gce_mig.py b/lib/ansible/modules/cloud/google/gce_mig.py index ca873d8aa7..662356e78c 100644 --- a/lib/ansible/modules/cloud/google/gce_mig.py +++ b/lib/ansible/modules/cloud/google/gce_mig.py @@ -40,31 +40,22 @@ options: - Instance Template to be used in creating the VMs. See U(https://cloud.google.com/compute/docs/instance-templates) to learn more about Instance Templates. Required for creating MIGs. - required: false size: description: - Size of Managed Instance Group. If MIG already exists, it will be resized to the number provided here. Required for creating MIGs. - required: false service_account_email: description: - service account email - required: false - default: null credentials_file: description: - Path to the JSON file associated with the service account email - default: null - required: false project_id: description: - GCE project ID - required: false - default: null state: description: - desired state of the resource - required: false default: "present" choices: ["absent", "present"] zone: @@ -77,15 +68,11 @@ options: and policy.max_instances (int) are required fields if autoscaling is used. See U(https://cloud.google.com/compute/docs/reference/beta/autoscalers) for more information on Autoscaling. - required: false - default: null named_ports: version_added: "2.3" description: - Define named ports that backend services can forward data to. Format is a a list of name:port dictionaries. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/google/gce_net.py b/lib/ansible/modules/cloud/google/gce_net.py index d4c298b214..b47bd42e27 100644 --- a/lib/ansible/modules/cloud/google/gce_net.py +++ b/lib/ansible/modules/cloud/google/gce_net.py @@ -30,82 +30,54 @@ options: description: - the protocol:ports to allow ('tcp:80' or 'tcp:80,443' or 'tcp:80-800;udp:1-25') this parameter is mandatory when creating or updating a firewall rule - required: false - default: null - aliases: [] ipv4_range: description: - the IPv4 address range in CIDR notation for the network this parameter is not mandatory when you specified existing network in name parameter, but when you create new network, this parameter is mandatory - required: false aliases: ['cidr'] fwname: description: - name of the firewall rule - required: false - default: null aliases: ['fwrule'] name: description: - name of the network - required: false - default: null - aliases: [] src_range: description: - the source IPv4 address range in CIDR notation - required: false default: [] aliases: ['src_cidr'] src_tags: description: - the source instance tags for creating a firewall rule - required: false default: [] - aliases: [] target_tags: version_added: "1.9" description: - the target instance tags for creating a firewall rule - required: false default: [] - aliases: [] state: description: - desired state of the network or firewall - required: false default: "present" choices: ["active", "present", "absent", "deleted"] - aliases: [] service_account_email: version_added: "1.6" description: - service account email - required: false - default: null - aliases: [] pem_file: version_added: "1.6" description: - path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'. - required: false - default: null - aliases: [] credentials_file: version_added: "2.1.0" description: - path to the JSON file associated with the service account email - required: false - default: null - aliases: [] project_id: version_added: "1.6" description: - your GCE project ID - required: false - default: null - aliases: [] mode: version_added: "2.2" description: @@ -114,31 +86,20 @@ options: "auto" automatically generates subnetworks in different regions "custom" uses networks to group subnets of user specified IP address ranges https://cloud.google.com/compute/docs/networking#network_types - required: false default: "legacy" choices: ["legacy", "auto", "custom"] - aliases: [] subnet_name: version_added: "2.2" description: - name of subnet to create - required: false - default: null - aliases: [] subnet_region: version_added: "2.2" description: - region of subnet to create - required: false - default: null - aliases: [] subnet_desc: version_added: "2.2" description: - description of subnet to create - required: false - default: null - aliases: [] requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/cloud/google/gce_pd.py b/lib/ansible/modules/cloud/google/gce_pd.py index a47eef889f..9972f3cb78 100644 --- a/lib/ansible/modules/cloud/google/gce_pd.py +++ b/lib/ansible/modules/cloud/google/gce_pd.py @@ -26,105 +26,70 @@ options: detach_only: description: - do not destroy the disk, merely detach it from an instance - required: false - default: "no" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'no' instance_name: description: - instance name if you wish to attach or detach the disk - required: false - default: null - aliases: [] mode: description: - GCE mount mode of disk, READ_ONLY (default) or READ_WRITE - required: false default: "READ_ONLY" choices: ["READ_WRITE", "READ_ONLY"] - aliases: [] name: description: - name of the disk required: true - default: null - aliases: [] size_gb: description: - whole integer size of disk (in GB) to create, default is 10 GB - required: false default: 10 - aliases: [] image: description: - the source image to use for the disk - required: false - default: null - aliases: [] version_added: "1.7" snapshot: description: - the source snapshot to use for the disk - required: false - default: null - aliases: [] version_added: "1.7" state: description: - desired state of the persistent disk - required: false default: "present" choices: ["active", "present", "absent", "deleted"] - aliases: [] zone: description: - zone in which to create the disk - required: false default: "us-central1-b" - aliases: [] service_account_email: version_added: "1.6" description: - service account email - required: false - default: null - aliases: [] pem_file: version_added: "1.6" description: - path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'. - required: false - default: null - aliases: [] credentials_file: version_added: "2.1.0" description: - path to the JSON file associated with the service account email - required: false - default: null - aliases: [] project_id: version_added: "1.6" description: - your GCE project ID - required: false - default: null - aliases: [] disk_type: version_added: "1.9" description: - type of disk provisioned - required: false default: "pd-standard" choices: ["pd-standard", "pd-ssd"] - aliases: [] delete_on_termination: version_added: "2.3" description: - - If yes, deletes the volume when instance is terminated - default: no - choices: ["yes", "no"] + - If C(yes), deletes the volume when instance is terminated + type: bool + default: 'no' requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/cloud/google/gcp_backend_service.py b/lib/ansible/modules/cloud/google/gcp_backend_service.py index e7a6c2b627..eede3793ee 100644 --- a/lib/ansible/modules/cloud/google/gcp_backend_service.py +++ b/lib/ansible/modules/cloud/google/gcp_backend_service.py @@ -46,13 +46,10 @@ options: enable_cdn: description: - If true, enable Cloud CDN for this Backend Service. - required: false port_name: description: - Name of the port on the managed instance group (MIG) that backend services can forward data to. Required for external load balancing. - required: false - default: null protocol: description: - The protocol this Backend Service uses to communicate with backends. @@ -66,22 +63,15 @@ options: service_account_email: description: - Service account email - required: false - default: null credentials_file: description: - Path to the JSON file associated with the service account email. - default: null - required: false project_id: description: - GCE project ID. - required: false - default: null state: description: - Desired state of the resource - required: false default: "present" choices: ["absent", "present"] ''' diff --git a/lib/ansible/modules/cloud/google/gcp_healthcheck.py b/lib/ansible/modules/cloud/google/gcp_healthcheck.py index d7bdfc348c..ed8d1970e5 100644 --- a/lib/ansible/modules/cloud/google/gcp_healthcheck.py +++ b/lib/ansible/modules/cloud/google/gcp_healthcheck.py @@ -43,7 +43,6 @@ options: check_interval: description: - How often (in seconds) to send a health check. - required: false default: 5 healthcheck_name: description: @@ -65,7 +64,6 @@ options: description: - The TCP port number for the health check request. The default value is 443 for HTTPS and 80 for HTTP. - required: false request_path: description: - The request path of the HTTPS health check request. @@ -80,33 +78,26 @@ options: - How long (in seconds) to wait for a response before claiming failure. It is invalid for timeout to have a greater value than check_interval. - required: false default: 5 unhealthy_threshold: description: - A so-far healthy instance will be marked unhealthy after this many consecutive failures. - required: false default: 2 healthy_threshold: description: - A so-far unhealthy instance will be marked healthy after this many consecutive successes. - required: false default: 2 service_account_email: description: - service account email - required: false - default: null service_account_permissions: version_added: "2.0" description: - service account permissions (see U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create), --scopes section for detailed information) - required: false - default: null choices: [ "bigquery", "cloud-platform", "compute-ro", "compute-rw", "useraccounts-ro", "useraccounts-rw", "datastore", "logging-write", @@ -116,13 +107,9 @@ options: credentials_file: description: - Path to the JSON file associated with the service account email - default: null - required: false project_id: description: - Your GCP project ID - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/lxc/lxc_container.py b/lib/ansible/modules/cloud/lxc/lxc_container.py index c17cb8b076..e0be3e4145 100644 --- a/lib/ansible/modules/cloud/lxc/lxc_container.py +++ b/lib/ansible/modules/cloud/lxc/lxc_container.py @@ -36,69 +36,56 @@ options: - zfs description: - Backend storage type for the container. - required: false default: dir template: description: - Name of the template to use within an LXC create. - required: false default: ubuntu template_options: description: - Template options when building the container. - required: false config: description: - Path to the LXC configuration file. - required: false - default: null lv_name: description: - Name of the logical volume, defaults to the container name. default: $CONTAINER_NAME - required: false vg_name: description: - If Backend store is lvm, specify the name of the volume group. default: lxc - required: false thinpool: description: - Use LVM thin pool called TP. - required: false fs_type: description: - Create fstype TYPE. default: ext4 - required: false fs_size: description: - File system Size. default: 5G - required: false directory: description: - Place rootfs directory under DIR. - required: false zfs_root: description: - Create zfs under given zfsroot. - required: false container_command: description: - Run a command within a container. - required: false lxc_path: description: - Place container under PATH - required: false container_log: choices: - true - false description: - Enable a container log for host actions to the container. - default: false + type: bool + default: 'no' container_log_level: choices: - INFO @@ -109,15 +96,13 @@ options: required: false default: INFO clone_name: - version_added: "2.0" description: - Name of the new cloned server. This is only used when state is clone. - required: false - default: false - clone_snapshot: + type: bool + default: 'no' version_added: "2.0" - required: false + clone_snapshot: choices: - true - false @@ -125,7 +110,9 @@ options: - Create a snapshot a container when cloning. This is not supported by all container storage backends. Enabling this may fail if the backing store does not support snapshots. - default: false + type: bool + default: 'no' + version_added: "2.0" archive: choices: - true @@ -133,12 +120,12 @@ options: description: - Create an archive of a container. This will create a tarball of the running container. - default: false + type: bool + default: 'no' archive_path: description: - Path the save the archived container. If the path does not exist the archive method will attempt to create it. - default: null archive_compression: choices: - gzip @@ -161,12 +148,10 @@ options: The running container will be stopped while the clone operation is happening and upon completion of the clone the original container state will be restored. - required: false default: started container_config: description: - list of 'key=value' options to use when configuring a container. - required: false requirements: - 'lxc >= 1.0 # OS package' - 'python >= 2.6 # OS Package' diff --git a/lib/ansible/modules/cloud/misc/helm.py b/lib/ansible/modules/cloud/misc/helm.py index 7b795cfc0e..695aa84f88 100644 --- a/lib/ansible/modules/cloud/misc/helm.py +++ b/lib/ansible/modules/cloud/misc/helm.py @@ -26,27 +26,21 @@ options: host: description: - Tiller's server host - required: false default: "localhost" port: description: - Tiller's server port - required: false default: 44134 namespace: description: - Kubernetes namespace where the chart should be installed - required: false default: "default" name: description: - Release name to manage - required: false - default: null state: description: - Whether to install C(present), remove C(absent), or purge C(purged) a package. - required: false choices: ['absent', 'purged', 'present'] default: "present" chart: @@ -58,18 +52,16 @@ options: source: type: repo location: https://kubernetes-charts.storage.googleapis.com - required: false default: {} values: description: - A map of value options for the chart. - required: false default: {} disable_hooks: description: - Whether to disable hooks during the uninstall process - required: false - default: false + type: bool + default: 'no' ''' RETURN = ''' # ''' diff --git a/lib/ansible/modules/cloud/misc/proxmox.py b/lib/ansible/modules/cloud/misc/proxmox.py index e21c1d0cf9..4bb30b8266 100644 --- a/lib/ansible/modules/cloud/misc/proxmox.py +++ b/lib/ansible/modules/cloud/misc/proxmox.py @@ -32,134 +32,100 @@ options: description: - the password to authenticate with - you can use PROXMOX_PASSWORD environment variable - default: null - required: false vmid: description: - the instance id - if not set, the next available VM ID will be fetched from ProxmoxAPI. - if not set, will be fetched from PromoxAPI based on the hostname - default: null - required: false validate_certs: description: - enable / disable https certificate verification - default: false - required: false type: bool + default: 'no' node: description: - Proxmox VE node, when new VM will be created - required only for C(state=present) - for another states will be autodiscovered - default: null - required: false pool: description: - Proxmox VE resource pool - default: null - required: false version_added: "2.3" password: description: - the instance root password - required only for C(state=present) - default: null - required: false hostname: description: - the instance hostname - required only for C(state=present) - must be unique if vmid is not passed - default: null - required: false ostemplate: description: - the template for VM creating - required only for C(state=present) - default: null - required: false disk: description: - hard disk size in GB for instance default: 3 - required: false cores: description: - Specify number of cores per socket. - required: false default: 1 version_added: 2.4 cpus: description: - numbers of allocated cpus for instance default: 1 - required: false memory: description: - memory size in MB for instance default: 512 - required: false swap: description: - swap memory size in MB for instance default: 0 - required: false netif: description: - specifies network interfaces for the container. As a hash/dictionary defining interfaces. - default: null - required: false mounts: description: - specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points - default: null - required: false version_added: "2.2" ip_address: description: - specifies the address the container will be assigned - default: null - required: false onboot: description: - specifies whether a VM will be started during system bootup - default: false - required: false + type: bool + default: 'no' storage: description: - target storage default: 'local' - required: false cpuunits: description: - CPU weight for a VM default: 1000 - required: false nameserver: description: - sets DNS server IP address for a container - default: null - required: false searchdomain: description: - sets DNS search domain for a container - default: null - required: false timeout: description: - timeout for operations default: 30 - required: false force: description: - forcing operations - can be used only with states C(present), C(stopped), C(restarted) - with C(state=present) force option allow to overwrite existing container - with states C(stopped) , C(restarted) allow to force stop instance - default: false - required: false type: bool + default: 'no' state: description: - Indicate desired state of the instance @@ -169,13 +135,12 @@ options: description: - Public key to add to /root/.ssh/authorized_keys. This was added on Proxmox 4.2, it is ignored for earlier versions version_added: "2.3" - default: null unprivileged: version_added: "2.3" description: - Indicate if the container should be unprivileged - default: false - required: false + type: bool + default: 'no' notes: - Requires proxmoxer and requests modules on host. This modules can be installed with pip. diff --git a/lib/ansible/modules/cloud/misc/proxmox_kvm.py b/lib/ansible/modules/cloud/misc/proxmox_kvm.py index bb72d057b2..36851ecc77 100644 --- a/lib/ansible/modules/cloud/misc/proxmox_kvm.py +++ b/lib/ansible/modules/cloud/misc/proxmox_kvm.py @@ -25,21 +25,17 @@ options: acpi: description: - Specify if ACPI should be enables/disabled. - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' agent: description: - Specify if the QEMU GuestAgent should be enabled/disabled. - required: false - default: null - choices: [ "yes", "no" ] + type: bool args: description: - Pass arbitrary arguments to kvm. - This option is for experts only! default: "-serial unix:/var/run/qemu-server/VMID.serial,server,nowait" - required: false api_host: description: - Specify the target host of the Proxmox VE cluster. @@ -52,109 +48,81 @@ options: description: - Specify the password to authenticate with. - You can use C(PROXMOX_PASSWORD) environment variable. - default: null - required: false autostart: description: - Specify, if the VM should be automatically restarted after crash (currently ignored in PVE API). - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' balloon: description: - Specify the amount of RAM for the VM in MB. - Using zero disables the balloon driver. - required: false default: 0 bios: description: - Specify the BIOS implementation. choices: ['seabios', 'ovmf'] - required: false - default: null boot: description: - Specify the boot order -> boot on floppy C(a), hard disk C(c), CD-ROM C(d), or network C(n). - You can combine to set order. - required: false default: cnd bootdisk: description: - Enable booting from specified disk. C((ide|sata|scsi|virtio)\d+) - required: false - default: null clone: description: - Name of VM to be cloned. If C(vmid) is setted, C(clone) can take arbitrary value but required for intiating the clone. - required: false - default: null cores: description: - Specify number of cores per socket. - required: false default: 1 cpu: description: - Specify emulated CPU type. - required: false default: kvm64 cpulimit: description: - Specify if CPU usage will be limited. Value 0 indicates no CPU limit. - If the computer has 2 CPUs, it has total of '2' CPU time - required: false - default: null cpuunits: description: - Specify CPU weight for a VM. - You can disable fair-scheduler configuration by setting this to 0 default: 1000 - required: false delete: description: - Specify a list of settings you want to delete. - required: false - default: null description: description: - Specify the description for the VM. Only used on the configuration web interface. - This is saved as comment inside the configuration file. - required: false - default: null digest: description: - Specify if to prevent changes if current configuration file has different SHA1 digest. - This can be used to prevent concurrent modifications. - required: false - default: null force: description: - Allow to force stop VM. - Can be used only with states C(stopped), C(restarted). - default: null - choices: [ "yes", "no" ] - required: false + type: bool format: description: - Target drive's backing file's data format. - Used only with clone default: qcow2 choices: [ "cloop", "cow", "qcow", "qcow2", "qed", "raw", "vmdk" ] - required: false freeze: description: - Specify if PVE should freeze CPU at startup (use 'c' monitor command to start execution). - required: false - default: null - choices: [ "yes", "no" ] + type: bool full: description: - Create a full copy of all disk. This is always done when you clone a normal VM. - For VM templates, we try to create a linked clone by default. - Used only with clone - default: yes - choices: [ "yes", "no"] - required: false + type: bool + default: 'yes' hostpci: description: - Specify a hash/dictionary of map host pci devices into guest. C(hostpci='{"key":"value", "key":"value"}'). @@ -165,21 +133,15 @@ options: - C(rombar=boolean) I(default=1) Specify whether or not the device's ROM will be visible in the guest's memory map. - C(x-vga=boolean) I(default=0) Enable vfio-vga device support. - /!\ This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. - required: false - default: null hotplug: description: - Selectively enable hotplug features. - This is a comma separated list of hotplug features C('network', 'disk', 'cpu', 'memory' and 'usb'). - Value 0 disables hotplug completely and value 1 is an alias for the default C('network,disk,usb'). - required: false - default: null hugepages: description: - Enable/disable hugepages memory. choices: ['any', '2', '1024'] - required: false - default: null ide: description: - A hash/dictionary of volume used as IDE hard disk or CD-ROM. C(ide='{"key":"value", "key":"value"}'). @@ -188,60 +150,42 @@ options: - C(storage) is the storage identifier where to create the disk. - C(size) is the size of the disk in GB. - C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). - required: false - default: null keyboard: description: - Sets the keyboard layout for VNC server. - required: false - default: null kvm: description: - Enable/disable KVM hardware virtualization. - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' localtime: description: - Sets the real time clock to local time. - This is enabled by default if ostype indicates a Microsoft OS. - required: false - default: null - choices: [ "yes", "no" ] + type: bool lock: description: - Lock/unlock the VM. choices: ['migrate', 'backup', 'snapshot', 'rollback'] - required: false - default: null machine: description: - Specifies the Qemu machine type. - type => C((pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)) - required: false - default: null memory: description: - Memory size in MB for instance. - required: false default: 512 migrate_downtime: description: - Sets maximum tolerated downtime (in seconds) for migrations. - required: false - default: null migrate_speed: description: - Sets maximum speed (in MB/s) for migrations. - A value of 0 is no limit. - required: false - default: null name: description: - Specifies the VM name. Only used on the configuration web interface. - Required only for C(state=present). - default: null - required: false net: description: - A hash/dictionary of network interfaces for the VM. C(net='{"key":"value", "key":"value"}'). @@ -252,21 +196,15 @@ options: - The C(bridge) parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'. - Option C(rate) is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'. - If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. - default: null - required: false newid: description: - VMID for the clone. Used only with clone. - If newid is not set, the next available VM ID will be fetched from ProxmoxAPI. - default: null - required: false node: description: - Proxmox VE node, where the new VM will be created. - Only required for C(state=present). - For other states, it will be autodiscovered. - default: null - required: false numa: description: - A hash/dictionaries of NUMA topology. C(numa='{"key":"value", "key":"value"}'). @@ -276,50 +214,36 @@ options: - C(hostnodes) Host NUMA nodes to use. - C(memory) Amount of memory this NUMA node provides. - C(policy) NUMA allocation policy. - default: null - required: false onboot: description: - Specifies whether a VM will be started during system bootup. - default: "yes" - choices: [ "yes", "no" ] - required: false + type: bool + default: 'yes' ostype: description: - Specifies guest operating system. This is used to enable special optimization/features for specific operating systems. - The l26 is Linux 2.6/3.X Kernel. choices: ['other', 'wxp', 'w2k', 'w2k3', 'w2k8', 'wvista', 'win7', 'win8', 'l24', 'l26', 'solaris'] default: l26 - required: false parallel: description: - A hash/dictionary of map host parallel devices. C(parallel='{"key":"value", "key":"value"}'). - Keys allowed are - (parallel[n]) where 0 ≤ n ≤ 2. - Values allowed are - C("/dev/parport\d+|/dev/usb/lp\d+"). - default: null - required: false pool: description: - Add the new VM to the specified pool. - default: null - required: false protection: description: - Enable/disable the protection flag of the VM. This will enable/disable the remove VM and remove disk operations. - default: null - choices: [ "yes", "no" ] - required: false + type: bool reboot: description: - - Allow reboot. If set to yes, the VM exit on reboot. - default: null - choices: [ "yes", "no" ] - required: false + - Allow reboot. If set to C(yes), the VM exit on reboot. + type: bool revert: description: - Revert a pending change. - default: null - required: false sata: description: - A hash/dictionary of volume used as sata hard disk or CD-ROM. C(sata='{"key":"value", "key":"value"}'). @@ -328,8 +252,6 @@ options: - C(storage) is the storage identifier where to create the disk. - C(size) is the size of the disk in GB. - C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). - default: null - required: false scsi: description: - A hash/dictionary of volume used as SCSI hard disk or CD-ROM. C(scsi='{"key":"value", "key":"value"}'). @@ -338,129 +260,95 @@ options: - C(storage) is the storage identifier where to create the disk. - C(size) is the size of the disk in GB. - C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). - default: null - required: false scsihw: description: - Specifies the SCSI controller model. choices: ['lsi', 'lsi53c810', 'virtio-scsi-pci', 'virtio-scsi-single', 'megasas', 'pvscsi'] - required: false - default: null serial: description: - A hash/dictionary of serial device to create inside the VM. C('{"key":"value", "key":"value"}'). - Keys allowed are - serial[n](str; required) where 0 ≤ n ≤ 3. - Values allowed are - C((/dev/.+|socket)). - /!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care. - default: null - required: false shares: description: - Rets amount of memory shares for auto-ballooning. (0 - 50000). - The larger the number is, the more memory this VM gets. - The number is relative to weights of all other running VMs. - Using 0 disables auto-ballooning, this means no limit. - required: false - default: null skiplock: description: - Ignore locks - Only root is allowed to use this option. - required: false - default: null smbios: description: - Specifies SMBIOS type 1 fields. - required: false - default: null snapname: description: - The name of the snapshot. Used only with clone. - default: null - required: false sockets: description: - Sets the number of CPU sockets. (1 - N). - required: false default: 1 startdate: description: - Sets the initial date of the real time clock. - Valid format for date are C('now') or C('2016-09-25T16:01:21') or C('2016-09-25'). - required: false - default: null startup: description: - Startup and shutdown behavior. C([[order=]\d+] [,up=\d+] [,down=\d+]). - Order is a non-negative number defining the general startup order. - Shutdown in done with reverse ordering. - required: false - default: null state: description: - Indicates desired state of the instance. - If C(current), the current state of the VM will be fecthed. You can access it with C(results.status) choices: ['present', 'started', 'absent', 'stopped', 'restarted','current'] - required: false default: present storage: description: - Target storage for full clone. - default: null - required: false tablet: description: - Enables/disables the USB tablet device. - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' target: description: - Target node. Only allowed if the original VM is on shared storage. - Used only with clone - default: null - required: false tdf: description: - Enables/disables time drift fix. - required: false - default: null - choices: [ "yes", "no" ] + type: bool template: description: - Enables/disables the template. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' timeout: description: - Timeout for operations. default: 30 - required: false update: description: - If C(yes), the VM will be update with new value. - Cause of the operations of the API and security reasons, I have disabled the update of the following parameters - C(net, virtio, ide, sata, scsi). Per example updating C(net) update the MAC address and C(virtio) create always new disk... - default: "no" - choices: [ "yes", "no" ] - required: false + type: bool + default: 'no' validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - default: "no" - choices: [ "yes", "no" ] - required: false + type: bool + default: 'no' vcpus: description: - Sets number of hotplugged vcpus. - required: false - default: null vga: description: - Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option 'std' or 'vmware'. choices: ['std', 'cirrus', 'vmware', 'qxl', 'serial0', 'serial1', 'serial2', 'serial3', 'qxl2', 'qxl3', 'qxl4'] - required: false default: std virtio: description: @@ -470,19 +358,13 @@ options: - C(storage) is the storage identifier where to create the disk. - C(size) is the size of the disk in GB. - C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). - required: false - default: null vmid: description: - Specifies the VM ID. Instead use I(name) parameter. - If vmid is not set, the next available VM ID will be fetched from ProxmoxAPI. - default: null - required: false watchdog: description: - Creates a virtual hardware watchdog device. - required: false - default: null requirements: [ "proxmoxer", "requests" ] ''' diff --git a/lib/ansible/modules/cloud/misc/proxmox_template.py b/lib/ansible/modules/cloud/misc/proxmox_template.py index 70b9f38ffb..a82a453ca1 100644 --- a/lib/ansible/modules/cloud/misc/proxmox_template.py +++ b/lib/ansible/modules/cloud/misc/proxmox_template.py @@ -33,55 +33,43 @@ options: description: - the password to authenticate with - you can use PROXMOX_PASSWORD environment variable - default: null - required: false validate_certs: description: - enable / disable https certificate verification - default: false - required: false + default: 'no' type: bool node: description: - Proxmox VE node, when you will operate with template - default: null required: true src: description: - path to uploaded file - required only for C(state=present) - default: null - required: false aliases: ['path'] template: description: - the template name - required only for states C(absent), C(info) - default: null - required: false content_type: description: - content type - required only for C(state=present) default: 'vztmpl' - required: false choices: ['vztmpl', 'iso'] storage: description: - target storage default: 'local' - required: false timeout: description: - timeout for operations default: 30 - required: false force: description: - can be used only with C(state=present), exists template will be overwritten - default: false - required: false type: bool + default: 'no' state: description: - Indicate desired state of the template diff --git a/lib/ansible/modules/cloud/misc/rhevm.py b/lib/ansible/modules/cloud/misc/rhevm.py index c29074427a..88705409a9 100644 --- a/lib/ansible/modules/cloud/misc/rhevm.py +++ b/lib/ansible/modules/cloud/misc/rhevm.py @@ -28,117 +28,95 @@ options: description: - The user to authenticate with. default: "admin@internal" - required: false server: description: - The name/ip of your RHEV-m/oVirt instance. default: "127.0.0.1" - required: false port: description: - The port on which the API is reacheable. default: "443" - required: false insecure_api: description: - A boolean switch to make a secure or insecure connection to the server. - default: false - required: false + type: bool + default: 'no' name: description: - The name of the VM. cluster: description: - The rhev/ovirt cluster in which you want you VM to start. - required: false datacenter: description: - The rhev/ovirt datacenter in which you want you VM to start. - required: false default: "Default" state: description: - This serves to create/remove/update or powermanage your VM. default: "present" - required: false choices: ['ping', 'present', 'absent', 'up', 'down', 'restarted', 'cd', 'info'] image: description: - The template to use for the VM. - default: null - required: false type: description: - To define if the VM is a server or desktop. default: server - required: false choices: [ 'server', 'desktop', 'host' ] vmhost: description: - The host you wish your VM to run on. - required: false vmcpu: description: - The number of CPUs you want in your VM. default: "2" - required: false cpu_share: description: - This parameter is used to configure the cpu share. default: "0" - required: false vmmem: description: - The amount of memory you want your VM to use (in GB). default: "1" - required: false osver: description: - The operationsystem option in RHEV/oVirt. default: "rhel_6x64" - required: false mempol: description: - The minimum amount of memory you wish to reserve for this system. default: "1" - required: false vm_ha: description: - To make your VM High Available. - default: true - required: false + type: bool + default: 'yes' disks: description: - This option uses complex arguments and is a list of disks with the options name, size and domain. - required: false ifaces: description: - This option uses complex arguments and is a list of interfaces with the options name and vlan. aliases: ['nics', 'interfaces'] - required: false boot_order: description: - This option uses complex arguments and is a list of items that specify the bootorder. default: ["network","hd"] - required: false del_prot: description: - This option sets the delete protection checkbox. - default: true - required: false + type: bool + default: yes cd_drive: description: - The CD you wish to have mounted on the VM when I(state = 'CD'). - default: null - required: false timeout: description: - The timeout you wish to define for power actions. - When I(state = 'up') - When I(state = 'down') - When I(state = 'restarted') - default: null - required: false ''' RETURN = ''' diff --git a/lib/ansible/modules/cloud/oneandone/oneandone_server.py b/lib/ansible/modules/cloud/oneandone/oneandone_server.py index 1e96a0f09f..92acf6fbab 100644 --- a/lib/ansible/modules/cloud/oneandone/oneandone_server.py +++ b/lib/ansible/modules/cloud/oneandone/oneandone_server.py @@ -34,7 +34,6 @@ options: state: description: - Define a server's state to create, remove, start or stop it. - required: false default: present choices: [ "present", "absent", "running", "stopped" ] auth_token: @@ -46,26 +45,21 @@ options: description: - Custom API URL. Overrides the ONEANDONE_API_URL environement variable. - required: false datacenter: description: - The datacenter location. - required: false default: US choices: [ "US", "ES", "DE", "GB" ] hostname: description: - The hostname or ID of the server. Only used when state is 'present'. - required: false description: description: - The description of the server. - required: false appliance: description: - The operating system name or ID for the server. It is required only for 'present' state. - required: false fixed_instance_size: description: - The instance size name or ID of the server. @@ -77,56 +71,43 @@ options: description: - The total number of processors. It must be provided with cores_per_processor, ram, and hdds parameters. - required: false cores_per_processor: description: - The number of cores per processor. It must be provided with vcore, ram, and hdds parameters. - required: false ram: description: - The amount of RAM memory. It must be provided with with vcore, cores_per_processor, and hdds parameters. - required: false hdds: description: - A list of hard disks with nested "size" and "is_main" properties. It must be provided with vcore, cores_per_processor, and ram parameters. - required: false private_network: description: - The private network name or ID. - required: false firewall_policy: description: - The firewall policy name or ID. - required: false load_balancer: description: - The load balancer name or ID. - required: false monitoring_policy: description: - The monitoring policy name or ID. - required: false server: description: - Server identifier (ID or hostname). It is required for all states except 'running' and 'present'. - required: false count: description: - The number of servers to create. - required: false default: 1 ssh_key: description: - User's public SSH key (contents, not path). - required: false - default: None server_type: description: - The type of server to be built. - required: false default: "cloud" choices: [ "cloud", "baremetal", "k8s_node" ] wait: @@ -135,9 +116,8 @@ options: Also used for delete operation (set to 'false' if you don't want to wait for each individual server to be deleted before moving on with other tasks.) - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' wait_timeout: description: - how long before wait gives up, in seconds @@ -151,8 +131,8 @@ options: - When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting the count where there is a %02d or %03d in the hostname string. - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' requirements: - "1and1" diff --git a/lib/ansible/modules/cloud/openstack/os_flavor_facts.py b/lib/ansible/modules/cloud/openstack/os_flavor_facts.py index d01ce36e6e..2c5a0ed9c0 100644 --- a/lib/ansible/modules/cloud/openstack/os_flavor_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_flavor_facts.py @@ -35,8 +35,6 @@ options: name: description: - A flavor name. Cannot be used with I(ram) or I(vcpus) or I(ephemeral). - required: false - default: None ram: description: - "A string used for filtering flavors based on the amount of RAM @@ -51,31 +49,28 @@ options: prefix the amount of RAM with one of these acceptable range values: '<', '>', '<=', '>='. These values represent less than, greater than, less than or equal to, and greater than or equal to, respectively." - required: false - default: false + type: bool + default: 'no' vcpus: description: - A string used for filtering flavors based on the number of virtual CPUs desired. Format is the same as the I(ram) parameter. - required: false - default: false + type: bool + default: 'no' limit: description: - Limits the number of flavors returned. All matching flavors are returned by default. - required: false - default: None ephemeral: description: - A string used for filtering flavors based on the amount of ephemeral storage. Format is the same as the I(ram) parameter - required: false - default: false + type: bool + default: 'no' version_added: "2.3" availability_zone: description: - Ignored. Present for backwards compatibility - required: false extends_documentation_fragment: openstack ''' diff --git a/lib/ansible/modules/cloud/openstack/os_floating_ip.py b/lib/ansible/modules/cloud/openstack/os_floating_ip.py index 4f6b69f3ab..1dd6b91449 100644 --- a/lib/ansible/modules/cloud/openstack/os_floating_ip.py +++ b/lib/ansible/modules/cloud/openstack/os_floating_ip.py @@ -30,39 +30,34 @@ options: network: description: - The name or ID of a neutron external network or a nova pool name. - required: false floating_ip_address: description: - A floating IP address to attach or to detach. Required only if I(state) is absent. When I(state) is present can be used to specify a IP address to attach. - required: false reuse: description: - When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project. - required: false - default: false + type: bool + default: 'no' fixed_address: description: - To which fixed IP of server the floating IP address should be attached to. - required: false nat_destination: description: - The name or id of a neutron private network that the fixed IP to attach floating IP is on - required: false - default: None aliases: ["fixed_network", "internal_network"] version_added: "2.3" wait: description: - When attaching a floating IP address, specify whether we should wait for it to appear as attached. - required: false - default: false + type: bool + default: 'no' timeout: description: - Time to wait for an IP address to appear as attached. See wait. @@ -72,19 +67,17 @@ options: description: - Should the resource be present or absent. choices: [present, absent] - required: false default: present purge: description: - When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only. - required: false - default: false + type: bool + default: 'no' version_added: "2.1" availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_group.py b/lib/ansible/modules/cloud/openstack/os_group.py index 4e469b5494..b5a3594bae 100644 --- a/lib/ansible/modules/cloud/openstack/os_group.py +++ b/lib/ansible/modules/cloud/openstack/os_group.py @@ -29,13 +29,9 @@ options: description: description: - Group description - required: false - default: None domain_id: description: - Domain id to create the group in if the cloud supports domains. - required: false - default: None version_added: "2.3" state: description: @@ -45,7 +41,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_image.py b/lib/ansible/modules/cloud/openstack/os_image.py index 5052abcddc..48a2532191 100644 --- a/lib/ansible/modules/cloud/openstack/os_image.py +++ b/lib/ansible/modules/cloud/openstack/os_image.py @@ -29,68 +29,48 @@ options: description: - Name that has to be given to the image required: true - default: None id: version_added: "2.4" description: - The Id of the image - required: false - default: None checksum: version_added: "2.5" description: - The checksum of the image - required: false - default: None disk_format: description: - The format of the disk that is getting uploaded - required: false default: qcow2 container_format: description: - The format of the container - required: false default: bare owner: description: - The owner of the image - required: false - default: None min_disk: description: - The minimum disk space (in GB) required to boot this image - required: false - default: None min_ram: description: - The minimum ram (in MB) required to boot this image - required: false - default: None is_public: description: - Whether the image can be accessed publicly. Note that publicizing an image requires admin role by default. - required: false + type: bool default: 'yes' filename: description: - The path to the file which has to be uploaded - required: false - default: None ramdisk: description: - The name of an existing ramdisk image that will be associated with this image - required: false - default: None kernel: description: - The name of an existing kernel image that will be associated with this image - required: false - default: None properties: description: - Additional properties to be associated with this image - required: false default: {} state: description: @@ -100,7 +80,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_ironic.py b/lib/ansible/modules/cloud/openstack/os_ironic.py index 689530c6fc..0911c5b40b 100644 --- a/lib/ansible/modules/cloud/openstack/os_ironic.py +++ b/lib/ansible/modules/cloud/openstack/os_ironic.py @@ -33,30 +33,21 @@ options: - globally unique identifier (UUID) to be given to the resource. Will be auto-generated if not specified, and name is specified. - Definition of a UUID will always take precedence to a name value. - required: false - default: None name: description: - unique name identifier to be given to the resource. - required: false - default: None driver: description: - The name of the Ironic Driver to use with this node. required: true - default: None chassis_uuid: description: - Associate the node with a pre-defined chassis. - required: false - default: None ironic_url: description: - If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth_type" settings set to None. - required: false - default: None driver_info: description: - Information for this server's driver. Will vary based on which @@ -109,12 +100,11 @@ options: field. As of Kilo, by default, passwords are always masked to API requests, which means the logic as a result always attempts to re-assert the password field. - required: false - default: false + type: bool + default: 'no' availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade", "jsonpatch"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py b/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py index 2137335d53..07543e88a4 100644 --- a/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py +++ b/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py @@ -28,33 +28,23 @@ options: mac: description: - unique mac address that is used to attempt to identify the host. - required: false - default: None uuid: description: - globally unique identifier (UUID) to identify the host. - required: false - default: None name: description: - unique name identifier to identify the host in Ironic. - required: false - default: None ironic_url: description: - If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth_type" settings set to None. - required: false - default: None timeout: description: - A timeout in seconds to tell the role to wait for the node to complete introspection if wait is set to True. - required: false default: 1200 availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_ironic_node.py b/lib/ansible/modules/cloud/openstack/os_ironic_node.py index 38624e5df2..00613ebaac 100644 --- a/lib/ansible/modules/cloud/openstack/os_ironic_node.py +++ b/lib/ansible/modules/cloud/openstack/os_ironic_node.py @@ -33,26 +33,20 @@ options: - Indicates if the resource should be deployed. Allows for deployment logic to be disengaged and control of the node power or maintenance state to be changed. - choices: ['true', 'false'] - default: true + type: bool + default: 'yes' uuid: description: - globally unique identifier (UUID) to be given to the resource. - required: false - default: None ironic_url: description: - If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth_type" settings set to None. - required: false - default: None config_drive: description: - A configdrive file or HTTP(S) URL that will be passed along to the node. - required: false - default: None instance_info: description: - Definition of the instance information which is used to deploy @@ -79,20 +73,18 @@ options: description: - A setting to allow the direct control if a node is in maintenance mode. - required: false - default: false + type: bool + default: 'no' maintenance_reason: description: - A string expression regarding the reason a node is in a maintenance mode. - required: false - default: None wait: description: - A boolean value instructing the module to wait for node activation or deactivation to complete before returning. - required: false - default: False + type: bool + default: 'no' version_added: "2.1" timeout: description: @@ -102,7 +94,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keypair.py b/lib/ansible/modules/cloud/openstack/os_keypair.py index b1aff29a52..24a1bf1f0f 100644 --- a/lib/ansible/modules/cloud/openstack/os_keypair.py +++ b/lib/ansible/modules/cloud/openstack/os_keypair.py @@ -28,19 +28,14 @@ options: description: - Name that has to be given to the key pair required: true - default: None public_key: description: - The public key that would be uploaded to nova and injected into VMs upon creation. - required: false - default: None public_key_file: description: - Path to local file containing ssh public key. Mutually exclusive with public_key. - required: false - default: None state: description: - Should the resource be present or absent. @@ -49,8 +44,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false -requirements: [] ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_domain.py b/lib/ansible/modules/cloud/openstack/os_keystone_domain.py index 172fef4767..6edc52d78e 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_domain.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_domain.py @@ -32,13 +32,11 @@ options: description: description: - Description of the domain - required: false - default: None enabled: description: - Is the domain enabled - required: false - default: True + type: bool + default: 'yes' state: description: - Should the resource be present or absent. @@ -47,7 +45,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py b/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py index e814eb011e..2f57431acb 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py @@ -27,17 +27,13 @@ options: name: description: - Name or ID of the domain - required: false filters: description: - A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. - required: false - default: None availability_zone: description: - Ignored. Present for backwards compatibility - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_service.py b/lib/ansible/modules/cloud/openstack/os_keystone_service.py index 20eff9ef63..371b497483 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_service.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_service.py @@ -30,13 +30,11 @@ options: description: description: - Description of the service - required: false - default: None enabled: description: - Is the service enabled - required: false - default: True + type: bool + default: 'yes' service_type: description: - The type of service @@ -49,7 +47,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_network.py b/lib/ansible/modules/cloud/openstack/os_network.py index b63c152955..4479e4cd2f 100644 --- a/lib/ansible/modules/cloud/openstack/os_network.py +++ b/lib/ansible/modules/cloud/openstack/os_network.py @@ -30,35 +30,30 @@ options: shared: description: - Whether this network is shared or not. - required: false - default: false + type: bool + default: 'no' admin_state_up: description: - Whether the state should be marked as up or down. - required: false - default: true + type: bool + default: 'yes' external: description: - Whether this network is externally accessible. - required: false - default: false + type: bool + default: 'no' state: description: - Indicate desired state of the resource. choices: ['present', 'absent'] - required: false default: present provider_physical_network: description: - The physical network where this network object is implemented. - required: false - default: None version_added: "2.1" provider_network_type: description: - The type of physical network that maps to this network resource. - required: false - default: None version_added: "2.1" provider_segmentation_id: description: @@ -66,19 +61,14 @@ options: attribute defines the segmentation model. For example, if the I(network_type) value is vlan, this ID is a vlan identifier. If the I(network_type) value is gre, this ID is a gre key. - required: false - default: None version_added: "2.1" project: description: - Project name or ID containing the network (name admin-only) - required: false - default: None version_added: "2.1" availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_nova_flavor.py b/lib/ansible/modules/cloud/openstack/os_nova_flavor.py index 733c4f5e04..be40409508 100644 --- a/lib/ansible/modules/cloud/openstack/os_nova_flavor.py +++ b/lib/ansible/modules/cloud/openstack/os_nova_flavor.py @@ -28,7 +28,6 @@ options: then I(ram), I(vcpus), and I(disk) are all required. There are no default values for those parameters. choices: ['present', 'absent'] - required: false default: present name: description: @@ -37,53 +36,40 @@ options: ram: description: - Amount of memory, in MB. - required: false - default: null vcpus: description: - Number of virtual CPUs. - required: false - default: null disk: description: - Size of local disk, in GB. - required: false - default: null ephemeral: description: - Ephemeral space size, in GB. - required: false default: 0 swap: description: - Swap space size, in MB. - required: false default: 0 rxtx_factor: description: - RX/TX factor. - required: false default: 1.0 is_public: description: - Make flavor accessible to the public. - required: false - default: true + type: bool + default: 'yes' flavorid: description: - ID for the flavor. This is optional as a unique UUID will be assigned if a value is not specified. - required: false default: "auto" availability_zone: description: - Ignored. Present for backwards compatibility - required: false extra_specs: description: - Metadata dictionary - required: false - default: None version_added: "2.3" requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py b/lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py index 1cca6a9262..70113af96f 100644 --- a/lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py +++ b/lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py @@ -28,16 +28,10 @@ options: required: true metadata: description: Metadata dict. - required: false - default: None availability_zone: description: Availability zone to create aggregate into. - required: false - default: None hosts: description: List of hosts to set for an aggregate. - required: false - default: None state: description: Should the resource be present or absent. choices: [present, absent] diff --git a/lib/ansible/modules/cloud/openstack/os_port.py b/lib/ansible/modules/cloud/openstack/os_port.py index 7da2e021ed..06cab9b1a2 100644 --- a/lib/ansible/modules/cloud/openstack/os_port.py +++ b/lib/ansible/modules/cloud/openstack/os_port.py @@ -30,35 +30,24 @@ options: name: description: - Name that has to be given to the port. - required: false - default: None fixed_ips: description: - Desired IP and/or subnet for this port. Subnet is referenced by subnet_id and IP is referenced by ip_address. - required: false - default: None admin_state_up: description: - Sets admin state. - required: false - default: None mac_address: description: - MAC address of this port. - required: false - default: None security_groups: description: - Security group(s) ID(s) or name(s) associated with the port (comma separated string or YAML list) - required: false - default: None no_security_groups: description: - Do not associate a security group with this port. - required: false - default: False + default: 'no' allowed_address_pairs: description: - "Allowed address pairs list. Allowed address pairs are supported with @@ -67,8 +56,6 @@ options: - ip_address: 10.1.0.12 mac_address: ab:cd:ef:12:34:56 - ip_address: ..." - required: false - default: None extra_dhcp_opts: description: - "Extra dhcp options to be assigned to this port. Extra options are @@ -77,18 +64,12 @@ options: - opt_name: opt name1 opt_value: value1 - opt_name: ..." - required: false - default: None device_owner: description: - The ID of the entity that uses this port. - required: false - default: None device_id: description: - Device ID of device using this port. - required: false - default: None state: description: - Should the resource be present or absent. @@ -97,7 +78,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_port_facts.py b/lib/ansible/modules/cloud/openstack/os_port_facts.py index 26d8edf64f..a4dcb0e92a 100644 --- a/lib/ansible/modules/cloud/openstack/os_port_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_port_facts.py @@ -28,20 +28,15 @@ options: port: description: - Unique name or ID of a port. - required: false - default: null filters: description: - A dictionary of meta data to use for further filtering. Elements of this dictionary will be matched against the returned port dictionaries. Matching is currently limited to strings within the port dictionary, or strings within nested dictionaries. - required: false - default: null availability_zone: description: - Ignored. Present for backwards compatibility - required: false extends_documentation_fragment: openstack ''' diff --git a/lib/ansible/modules/cloud/openstack/os_project.py b/lib/ansible/modules/cloud/openstack/os_project.py index 95ba9afe83..2e7ac108e3 100644 --- a/lib/ansible/modules/cloud/openstack/os_project.py +++ b/lib/ansible/modules/cloud/openstack/os_project.py @@ -32,20 +32,16 @@ options: description: description: - Description for the project - required: false - default: None domain_id: description: - Domain id to create the project in if the cloud supports domains. The domain_id parameter requires shade >= 1.8.0 - required: false - default: None aliases: ['domain'] enabled: description: - Is the project enabled - required: false - default: True + type: bool + default: 'yes' state: description: - Should the resource be present or absent. @@ -54,7 +50,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_project_facts.py b/lib/ansible/modules/cloud/openstack/os_project_facts.py index f6c2f1f6a4..496d2dfea9 100644 --- a/lib/ansible/modules/cloud/openstack/os_project_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_project_facts.py @@ -31,18 +31,13 @@ options: domain: description: - Name or ID of the domain containing the project if the cloud supports domains - required: false - default: None filters: description: - A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. - required: false - default: None availability_zone: description: - Ignored. Present for backwards compatibility - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_quota.py b/lib/ansible/modules/cloud/openstack/os_quota.py index c78e5409d5..d305120a27 100644 --- a/lib/ansible/modules/cloud/openstack/os_quota.py +++ b/lib/ansible/modules/cloud/openstack/os_quota.py @@ -30,144 +30,78 @@ options: state: description: - A value of present sets the quota and a value of absent resets the quota to system defaults. - required: False default: present backup_gigabytes: - required: False - default: None description: Maximum size of backups in GB's. backups: - required: False - default: None description: Maximum number of backups allowed. cores: - required: False - default: None description: Maximum number of CPU's per project. fixed_ips: - required: False - default: None description: Number of fixed IP's to allow. floating_ips: - required: False - default: None description: Number of floating IP's to allow in Compute. aliases: ['compute_floating_ips'] floatingip: - required: False - default: None description: Number of floating IP's to allow in Network. aliases: ['network_floating_ips'] gigabytes: - required: False - default: None description: Maximum volume storage allowed for project. gigabytes_lvm: - required: False - default: None description: Maximum size in GB's of individual lvm volumes. injected_file_size: - required: False - default: None description: Maximum file size in bytes. injected_files: - required: False - default: None description: Number of injected files to allow. injected_path_size: - required: False - default: None description: Maximum path size. instances: - required: False - default: None description: Maximum number of instances allowed. key_pairs: - required: False - default: None description: Number of key pairs to allow. loadbalancer: - required: False - default: None description: Number of load balancers to allow. version_added: "2.4" network: - required: False - default: None description: Number of networks to allow. per_volume_gigabytes: - required: False - default: None description: Maximum size in GB's of individual volumes. pool: - required: False - default: None description: Number of load balancer pools to allow. version_added: "2.4" port: - required: False - default: None description: Number of Network ports to allow, this needs to be greater than the instances limit. properties: - required: False - default: None description: Number of properties to allow. ram: - required: False - default: None description: Maximum amount of ram in MB to allow. rbac_policy: - required: False - default: None description: Number of policies to allow. router: - required: False - default: None description: Number of routers to allow. security_group_rule: - required: False - default: None description: Number of rules per security group to allow. security_group: - required: False - default: None description: Number of security groups to allow. server_group_members: - required: False - default: None description: Number of server group members to allow. server_groups: - required: False - default: None description: Number of server groups to allow. snapshots: - required: False - default: None description: Number of snapshots to allow. snapshots_lvm: - required: False - default: None description: Number of LVM snapshots to allow. subnet: - required: False - default: None description: Number of subnets to allow. subnetpool: - required: False - default: None description: Number of subnet pools to allow. volumes: - required: False - default: None description: Number of volumes to allow. volumes_lvm: - required: False - default: None description: Number of LVM volumes to allow. availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: diff --git a/lib/ansible/modules/cloud/openstack/os_recordset.py b/lib/ansible/modules/cloud/openstack/os_recordset.py index f88b7067f1..0ad794c96c 100644 --- a/lib/ansible/modules/cloud/openstack/os_recordset.py +++ b/lib/ansible/modules/cloud/openstack/os_recordset.py @@ -42,13 +42,9 @@ options: description: description: - Description of the recordset - required: false - default: None ttl: description: - TTL (Time To Live) value in seconds - required: false - default: None state: description: - Should the resource be present or absent. @@ -57,7 +53,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_router.py b/lib/ansible/modules/cloud/openstack/os_router.py index fe5a6cb0d5..ce983b320c 100644 --- a/lib/ansible/modules/cloud/openstack/os_router.py +++ b/lib/ansible/modules/cloud/openstack/os_router.py @@ -36,24 +36,20 @@ options: admin_state_up: description: - Desired admin state of the created or existing router. - required: false - default: true + type: bool + default: 'yes' enable_snat: description: - Enable Source NAT (SNAT) attribute. - required: false - default: true + type: bool + default: 'yes' network: description: - Unique name or ID of the external gateway network. - required I(interfaces) or I(enable_snat) are provided. - required: false - default: None project: description: - Unique name or ID of the project. - required: false - default: None version_added: "2.2" external_fixed_ips: description: @@ -61,8 +57,6 @@ options: is a dictionary with the subnet name or ID (subnet) and the IP address to assign on the subnet (ip). If no IP is specified, one is automatically assigned from that subnet. - required: false - default: None interfaces: description: - List of subnets to attach to the router internal interface. Default @@ -75,13 +69,9 @@ options: User defined portip is often required when a multiple router need to be connected to a single subnet for which the default gateway has been already used. - - required: false - default: None availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_security_group.py b/lib/ansible/modules/cloud/openstack/os_security_group.py index 03d11e1bc4..40758ebbb4 100644 --- a/lib/ansible/modules/cloud/openstack/os_security_group.py +++ b/lib/ansible/modules/cloud/openstack/os_security_group.py @@ -31,8 +31,6 @@ options: description: description: - Long description of the purpose of the security group - required: false - default: None state: description: - Should the resource be present or absent. @@ -41,7 +39,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_security_group_rule.py b/lib/ansible/modules/cloud/openstack/os_security_group_rule.py index 9ad9ff67f6..17e8e0cc40 100644 --- a/lib/ansible/modules/cloud/openstack/os_security_group_rule.py +++ b/lib/ansible/modules/cloud/openstack/os_security_group_rule.py @@ -31,26 +31,19 @@ options: description: - IP protocols TCP UDP ICMP 112 (VRRP) choices: ['tcp', 'udp', 'icmp', '112', None] - default: None port_range_min: description: - Starting port - required: false - default: None port_range_max: description: - Ending port - required: false - default: None remote_ip_prefix: description: - Source IP address(es) in CIDR notation (exclusive with remote_group) - required: false remote_group: description: - Name or ID of the Security group to link (exclusive with remote_ip_prefix) - required: false ethertype: description: - Must be IPv4 or IPv6, and addresses represented in CIDR must @@ -71,7 +64,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' diff --git a/lib/ansible/modules/cloud/openstack/os_server.py b/lib/ansible/modules/cloud/openstack/os_server.py index e939433c32..1c0ecdc2da 100644 --- a/lib/ansible/modules/cloud/openstack/os_server.py +++ b/lib/ansible/modules/cloud/openstack/os_server.py @@ -43,13 +43,11 @@ options: description: - The name or id of the flavor in which the new instance has to be created. Mutually exclusive with flavor_ram - required: false default: 1 flavor_ram: description: - The minimum amount of ram in MB that the flavor in which the new instance has to be created must have. Mutually exclusive with flavor. - required: false default: 1 flavor_include: description: @@ -60,21 +58,15 @@ options: key_name: description: - The key pair name to be used when creating a instance - required: false - default: None security_groups: description: - Names of the security groups to which the instance should be added. This may be a YAML list or a comma separated string. - required: false - default: None network: description: - Name or ID of a network to attach this instance to. A simpler version of the nics parameter, only one of network or nics should be supplied. - required: false - default: None nics: description: - A list of networks to which the instance's interface should @@ -83,58 +75,47 @@ options: - 'Also this accepts a string containing a list of (net/port)-(id/name) Eg: nics: "net-id=uuid-1,port-name=myport" Only one of network or nics should be supplied.' - required: false - default: None auto_ip: description: - Ensure instance has public ip however the cloud wants to do that - required: false + type: bool default: 'yes' aliases: ['auto_floating_ip', 'public_ip'] floating_ips: description: - list of valid floating IPs that pre-exist to assign to this node - required: false - default: None floating_ip_pools: description: - Name of floating IP pool from which to choose a floating IP - required: false - default: None meta: description: - 'A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs. Eg: meta: "key1=value1,key2=value2"' - required: false - default: None wait: description: - If the module should wait for the instance to be created. - required: false + type: bool default: 'yes' timeout: description: - The amount of time the module should wait for the instance to get into active state. - required: false default: 180 config_drive: description: - Whether to boot the server with config drive enabled - required: false + type: bool default: 'no' userdata: description: - Opaque blob of data which is made available to the instance - required: false - default: None boot_from_volume: description: - Should the instance boot from a persistent volume created based on the image given. Mututally exclusive with boot_volume. - required: false - default: false + type: bool + default: 'no' volume_size: description: - The size of the volume to create in GB if booting from volume based @@ -143,23 +124,19 @@ options: description: - Volume name or id to use as the volume to boot from. Implies boot_from_volume. Mutually exclusive with image and boot_from_volume. - required: false - default: None aliases: ['root_volume'] terminate_volume: description: - - If true, delete volume when deleting instance (if booted from volume) - default: false + - If C(yes), delete volume when deleting instance (if booted from volume) + type: bool + default: 'no' volumes: description: - A list of preexisting volumes names or ids to attach to the instance - required: false default: [] scheduler_hints: description: - Arbitrary key/value pairs to the scheduler for custom use - required: false - default: None version_added: "2.1" state: description: @@ -170,8 +147,8 @@ options: description: - When I(state) is absent and this option is true, any floating IP associated with the instance will be deleted along with the instance. - required: false - default: false + type: bool + default: 'no' version_added: "2.2" reuse_ips: description: @@ -182,13 +159,12 @@ options: concurrent server creation, it is highly recommended to set this to false and to delete the floating ip associated with a server when the server is deleted using I(delete_fip). - required: false - default: true + type: bool + default: 'yes' version_added: "2.2" availability_zone: description: - Availability zone in which to create the server. - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_server_action.py b/lib/ansible/modules/cloud/openstack/os_server_action.py index 378e659e8f..cf660ee987 100644 --- a/lib/ansible/modules/cloud/openstack/os_server_action.py +++ b/lib/ansible/modules/cloud/openstack/os_server_action.py @@ -32,13 +32,12 @@ options: wait: description: - If the module should wait for the instance action to be performed. - required: false + type: bool default: 'yes' timeout: description: - The amount of time the module should wait for the instance to perform the requested action. - required: false default: 180 action: description: @@ -50,12 +49,10 @@ options: image: description: - Image the server should be rebuilt with - default: null version_added: "2.3" availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_server_facts.py b/lib/ansible/modules/cloud/openstack/os_server_facts.py index 2695efc777..0b6ae4934b 100644 --- a/lib/ansible/modules/cloud/openstack/os_server_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_server_facts.py @@ -31,18 +31,15 @@ options: description: - restrict results to servers with names or UUID matching this glob expression (e.g., <web*>). - required: false - default: None detailed: description: - when true, return additional detail about servers at the expense of additional API calls. - required: false - default: false + type: bool + default: 'no' availability_zone: description: - Ignored. Present for backwards compatibility - required: false extends_documentation_fragment: openstack ''' diff --git a/lib/ansible/modules/cloud/openstack/os_server_volume.py b/lib/ansible/modules/cloud/openstack/os_server_volume.py index 532c26bf60..6b39d1dc55 100644 --- a/lib/ansible/modules/cloud/openstack/os_server_volume.py +++ b/lib/ansible/modules/cloud/openstack/os_server_volume.py @@ -40,12 +40,9 @@ options: device: description: - Device you want to attach. Defaults to auto finding a device name. - required: false - default: None availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_stack.py b/lib/ansible/modules/cloud/openstack/os_stack.py index f53d33fc5a..1960c70f57 100644 --- a/lib/ansible/modules/cloud/openstack/os_stack.py +++ b/lib/ansible/modules/cloud/openstack/os_stack.py @@ -28,7 +28,6 @@ options: description: - Indicate desired state of the resource choices: ['present', 'absent'] - required: false default: present name: description: @@ -37,38 +36,28 @@ options: tag: description: - Tag for the stack that should be created, name could be char and digit, no space - required: false - default: None version_added: "2.5" template: description: - Path of the template file to use for the stack creation - required: false - default: None environment: description: - List of environment files that should be used for the stack creation - required: false - default: None parameters: description: - Dictionary of parameters for the stack creation - required: false - default: None rollback: description: - Rollback stack creation - required: false - default: false + type: bool + default: 'yes' timeout: description: - Maximum number of seconds to wait for the stack creation - required: false default: 3600 availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_subnet.py b/lib/ansible/modules/cloud/openstack/os_subnet.py index 296622d8e3..4ccbfbf826 100644 --- a/lib/ansible/modules/cloud/openstack/os_subnet.py +++ b/lib/ansible/modules/cloud/openstack/os_subnet.py @@ -27,13 +27,11 @@ options: description: - Indicate desired state of the resource choices: ['present', 'absent'] - required: false default: present network_name: description: - Name of the network to which the subnet should be attached - Required when I(state) is 'present' - required: false name: description: - The name of the subnet that should be created. Although Neutron @@ -45,78 +43,58 @@ options: - The CIDR representation of the subnet that should be assigned to the subnet. Required when I(state) is 'present' and a subnetpool is not specified. - required: false - default: None ip_version: description: - The IP version of the subnet 4 or 6 - required: false default: 4 enable_dhcp: description: - Whether DHCP should be enabled for this subnet. - required: false - default: true + type: bool + default: 'yes' gateway_ip: description: - The ip that would be assigned to the gateway for this subnet - required: false - default: None no_gateway_ip: description: - The gateway IP would not be assigned for this subnet - required: false - default: false + type: bool + default: 'no' version_added: "2.2" dns_nameservers: description: - List of DNS nameservers for this subnet. - required: false - default: None allocation_pool_start: description: - From the subnet pool the starting address from which the IP should be allocated. - required: false - default: None allocation_pool_end: description: - From the subnet pool the last IP that should be assigned to the virtual machines. - required: false - default: None host_routes: description: - A list of host route dictionaries for the subnet. - required: false - default: None ipv6_ra_mode: description: - IPv6 router advertisement mode choices: ['dhcpv6-stateful', 'dhcpv6-stateless', 'slaac'] - required: false - default: None ipv6_address_mode: description: - IPv6 address mode choices: ['dhcpv6-stateful', 'dhcpv6-stateless', 'slaac'] - required: false - default: None use_default_subnetpool: description: - Use the default subnetpool for I(ip_version) to obtain a CIDR. - required: false - default: false + type: bool + default: 'no' project: description: - Project name or ID containing the subnet (name admin-only) - required: false - default: None version_added: "2.1" availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_user.py b/lib/ansible/modules/cloud/openstack/os_user.py index eb07b2d3e4..aebd34d131 100644 --- a/lib/ansible/modules/cloud/openstack/os_user.py +++ b/lib/ansible/modules/cloud/openstack/os_user.py @@ -32,10 +32,7 @@ options: password: description: - Password for the user - required: false - default: None update_password: - required: false default: always choices: ['always', 'on_create'] version_added: "2.3" @@ -45,8 +42,6 @@ options: email: description: - Email address for the user - required: false - default: None description: description: - Description about the user @@ -54,18 +49,14 @@ options: default_project: description: - Project name or ID that the user should be associated with by default - required: false - default: None domain: description: - Domain to create the user in if the cloud supports domains - required: false - default: None enabled: description: - Is the user enabled - required: false - default: True + type: bool + default: 'yes' state: description: - Should the resource be present or absent. @@ -74,7 +65,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_user_facts.py b/lib/ansible/modules/cloud/openstack/os_user_facts.py index 4b96a3249c..ae32858b81 100644 --- a/lib/ansible/modules/cloud/openstack/os_user_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_user_facts.py @@ -31,18 +31,13 @@ options: domain: description: - Name or ID of the domain containing the user if the cloud supports domains - required: false - default: None filters: description: - A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. - required: false - default: None availability_zone: description: - Ignored. Present for backwards compatibility - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/openstack/os_user_role.py b/lib/ansible/modules/cloud/openstack/os_user_role.py index 060d4aa806..fceafa7f51 100644 --- a/lib/ansible/modules/cloud/openstack/os_user_role.py +++ b/lib/ansible/modules/cloud/openstack/os_user_role.py @@ -30,27 +30,19 @@ options: description: - Name or ID for the user. If I(user) is not specified, then I(group) is required. Both may not be specified. - required: false - default: null group: description: - Name or ID for the group. Valid only with keystone version 3. If I(group) is not specified, then I(user) is required. Both may not be specified. - required: false - default: null project: description: - Name or ID of the project to scope the role association to. If you are using keystone version 2, then this value is required. - required: false - default: null domain: description: - ID of the domain to scope the role association to. Valid only with keystone version 3, and required if I(project) is not specified. - required: false - default: null state: description: - Should the roles be present or absent on the user. @@ -59,7 +51,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/openstack/os_volume.py b/lib/ansible/modules/cloud/openstack/os_volume.py index a64cc48dc6..3ef290e0c9 100644 --- a/lib/ansible/modules/cloud/openstack/os_volume.py +++ b/lib/ansible/modules/cloud/openstack/os_volume.py @@ -26,8 +26,6 @@ options: description: - Size of volume in GB. This parameter is required when the I(state) parameter is 'present'. - required: false - default: None display_name: description: - Name of volume @@ -35,28 +33,18 @@ options: display_description: description: - String describing the volume - required: false - default: None volume_type: description: - Volume type for volume - required: false - default: None image: description: - Image name or id for boot from volume - required: false - default: None snapshot_id: description: - Volume snapshot id to create from - required: false - default: None volume: description: - Volume name or id to create from - required: false - default: None version_added: "2.3" state: description: @@ -66,12 +54,9 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false scheduler_hints: description: - Scheduler hints passed to volume API in form of dict - required: false - default: None version_added: "2.4" requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/cloud/openstack/os_zone.py b/lib/ansible/modules/cloud/openstack/os_zone.py index 3aea08777e..be4f583fe1 100644 --- a/lib/ansible/modules/cloud/openstack/os_zone.py +++ b/lib/ansible/modules/cloud/openstack/os_zone.py @@ -31,26 +31,18 @@ options: description: - Zone type choices: [primary, secondary] - default: None email: description: - Email of the zone owner (only applies if zone_type is primary) - required: false description: description: - Zone description - required: false - default: None ttl: description: - TTL (Time To Live) value in seconds - required: false - default: None masters: description: - Master nameservers (only applies if zone_type is secondary) - required: false - default: None state: description: - Should the resource be present or absent. @@ -59,7 +51,6 @@ options: availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: - "python >= 2.6" - "shade" diff --git a/lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py b/lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py index 7353e555c8..b5321ca711 100644 --- a/lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py +++ b/lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py @@ -36,20 +36,17 @@ options: description: - The IP address of the backend to update / modify / delete state: - required: false default: present choices: ['present', 'absent'] description: - Determines whether the backend is to be created/modified or deleted probe: - required: false - default: none + default: 'none' choices: ['none', 'http', 'icmp' , 'oco'] description: - Determines the type of probe to use for this backend weight: - required: false default: 8 description: - Determines the weight for this backend @@ -70,7 +67,6 @@ options: description: - The consumer key to use timeout: - required: false default: 120 description: - The timeout in seconds used to wait for a task to be diff --git a/lib/ansible/modules/cloud/profitbricks/profitbricks.py b/lib/ansible/modules/cloud/profitbricks/profitbricks.py index cd11f57cb1..e9d6445897 100644 --- a/lib/ansible/modules/cloud/profitbricks/profitbricks.py +++ b/lib/ansible/modules/cloud/profitbricks/profitbricks.py @@ -23,8 +23,8 @@ options: auto_increment: description: - Whether or not to increment a single number in the name for created virtual machines. - default: yes - choices: ["yes", "no"] + type: bool + default: 'yes' name: description: - The name of the virtual machine. @@ -36,87 +36,69 @@ options: image_password: description: - Password set for the administrative user. - required: false version_added: '2.2' ssh_keys: description: - Public SSH keys allowing access to the virtual machine. - required: false version_added: '2.2' datacenter: description: - The datacenter to provision this virtual machine. - required: false - default: null cores: description: - The number of CPU cores to allocate to the virtual machine. - required: false default: 2 ram: description: - The amount of memory to allocate to the virtual machine. - required: false default: 2048 cpu_family: description: - The CPU family type to allocate to the virtual machine. - required: false default: AMD_OPTERON choices: [ "AMD_OPTERON", "INTEL_XEON" ] version_added: '2.2' volume_size: description: - The size in GB of the boot volume. - required: false default: 10 bus: description: - The bus type for the volume. - required: false default: VIRTIO choices: [ "IDE", "VIRTIO"] instance_ids: description: - list of instance ids, currently only used when state='absent' to remove instances. - required: false count: description: - The number of virtual machines to create. - required: false default: 1 location: description: - The datacenter location. Use only if you want to create the Datacenter or else this value is ignored. - required: false default: us/las choices: [ "us/las", "de/fra", "de/fkb" ] assign_public_ip: description: - This will assign the machine to the public LAN. If no LAN exists with public Internet access it is created. - required: false - default: false + type: bool + default: 'no' lan: description: - The ID of the LAN you wish to add the servers to. - required: false default: 1 subscription_user: description: - The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable. - required: false - default: null subscription_password: description: - THe ProfitBricks password. Overrides the PB_PASSWORD environment variable. - required: false - default: null wait: description: - wait for the instance to be in state 'running' before returning - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' wait_timeout: description: - how long before wait gives up, in seconds @@ -124,13 +106,11 @@ options: remove_boot_volume: description: - remove the bootVolume of the virtual machine you're destroying. - required: false - default: "yes" - choices: ["yes", "no"] + type: bool + default: 'yes' state: description: - create or terminate instances - required: false default: 'present' choices: [ "running", "stopped", "absent", "present" ] diff --git a/lib/ansible/modules/cloud/rackspace/rax.py b/lib/ansible/modules/cloud/rackspace/rax.py index 5e6b53fb48..ef920db838 100644 --- a/lib/ansible/modules/cloud/rackspace/rax.py +++ b/lib/ansible/modules/cloud/rackspace/rax.py @@ -25,10 +25,8 @@ options: - Whether or not to increment a single number with the name of the created servers. Only applicable when used with the I(group) attribute or meta key. - default: yes - choices: - - "yes" - - "no" + type: bool + default: 'yes' version_added: 1.5 boot_from_volume: description: @@ -36,10 +34,8 @@ options: If C(yes) and I(image) is specified a new volume will be created at boot time. I(boot_volume_size) is required with I(image) to create a new volume at boot time. - default: "no" - choices: - - "yes" - - "no" + type: bool + default: 'no' version_added: 1.9 boot_volume: description: @@ -56,15 +52,14 @@ options: description: - Whether the I(boot_volume) or newly created volume from I(image) will be terminated when the server is terminated - default: false + type: bool + default: 'no' version_added: 1.9 config_drive: description: - Attach read-only configuration drive to server as label config-2 - default: no - choices: - - "yes" - - "no" + type: bool + default: 'no' version_added: 1.7 count: description: @@ -91,10 +86,8 @@ options: the servers matched, servers will be deleted to match the count. If the number of matched servers is fewer than specified in I(count) additional servers will be added. - default: no - choices: - - "yes" - - "no" + type: bool + default: 'no' version_added: 1.4 extra_client_args: description: @@ -110,11 +103,9 @@ options: files: description: - Files to insert into the instance. remotefilename:localcontent - default: null flavor: description: - flavor to use for the instance - default: null group: description: - host group to assign to server, is also used for idempotent operations @@ -125,7 +116,6 @@ options: - image to use for the instance. Can be an C(id), C(human_id) or C(name). With I(boot_from_volume), a Cloud Block Storage volume will be created with this image - default: null instance_ids: description: - list of instance ids, currently only used when state='absent' to @@ -134,17 +124,14 @@ options: key_name: description: - key pair to use on the instance - default: null aliases: - keypair meta: description: - A hash of metadata to associate with the instance - default: null name: description: - Name to give the instance - default: null networks: description: - The network to attach to the instances. If specified, you must include @@ -169,10 +156,8 @@ options: wait: description: - wait for the instance to be in state 'running' before returning - default: "no" - choices: - - "yes" - - "no" + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/rackspace/rax_cbs.py b/lib/ansible/modules/cloud/rackspace/rax_cbs.py index 068b9b7880..a0a1efacd1 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_cbs.py +++ b/lib/ansible/modules/cloud/rackspace/rax_cbs.py @@ -22,21 +22,17 @@ options: description: description: - Description to give the volume being created - default: null image: description: - image to use for bootable volumes. Can be an C(id), C(human_id) or C(name). This option requires C(pyrax>=1.9.3) - default: null version_added: 1.9 meta: description: - A hash of metadata to associate with the volume - default: null name: description: - Name to give the volume being created - default: null required: true size: description: @@ -46,7 +42,6 @@ options: snapshot_id: description: - The id of the snapshot to create the volume from - default: null state: description: - Indicate desired state of the resource @@ -66,10 +61,8 @@ options: wait: description: - wait for the volume to be in state 'available' before returning - default: "no" - choices: - - "yes" - - "no" + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py b/lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py index 7cb1abe398..1bb8bea421 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py +++ b/lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py @@ -23,17 +23,13 @@ options: description: - The device path to attach the volume to, e.g. /dev/xvde. - Before 2.4 this was a required field. Now it can be left to null to auto assign the device name. - default: null - required: false volume: description: - Name or id of the volume to attach/detach - default: null required: true server: description: - Name or id of the server to attach/detach - default: null required: true state: description: @@ -46,10 +42,8 @@ options: wait: description: - wait for the volume to be in 'in-use'/'available' state before returning - default: "no" - choices: - - "yes" - - "no" + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/rackspace/rax_cdb.py b/lib/ansible/modules/cloud/rackspace/rax_cdb.py index 7261c2dcaa..2b61e994b6 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_cdb.py +++ b/lib/ansible/modules/cloud/rackspace/rax_cdb.py @@ -24,7 +24,6 @@ options: name: description: - Name of the databases server instance - default: null flavor: description: - flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB) @@ -53,8 +52,8 @@ options: wait: description: - wait for the instance to be in state 'running' before returning - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/rackspace/rax_cdb_database.py b/lib/ansible/modules/cloud/rackspace/rax_cdb_database.py index 5969e7448e..69e84a611e 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_cdb_database.py +++ b/lib/ansible/modules/cloud/rackspace/rax_cdb_database.py @@ -21,11 +21,9 @@ options: cdb_id: description: - The databases server UUID - default: null name: description: - Name to give to the database - default: null character_set: description: - Set of symbols and encodings diff --git a/lib/ansible/modules/cloud/rackspace/rax_cdb_user.py b/lib/ansible/modules/cloud/rackspace/rax_cdb_user.py index eac23bd016..77b6dfed38 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_cdb_user.py +++ b/lib/ansible/modules/cloud/rackspace/rax_cdb_user.py @@ -22,15 +22,12 @@ options: cdb_id: description: - The databases server UUID - default: null db_username: description: - Name of the database user - default: null db_password: description: - Database user password - default: null databases: description: - Name of the databases that the user can access diff --git a/lib/ansible/modules/cloud/rackspace/rax_clb.py b/lib/ansible/modules/cloud/rackspace/rax_clb.py index d539934f4e..022050a87a 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_clb.py +++ b/lib/ansible/modules/cloud/rackspace/rax_clb.py @@ -32,11 +32,9 @@ options: meta: description: - A hash of metadata to associate with the instance - default: null name: description: - Name to give the load balancer - default: null port: description: - Port for the balancer being created @@ -90,10 +88,8 @@ options: wait: description: - wait for the balancer to be in state 'running' before returning - default: "no" - choices: - - "yes" - - "no" + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/rackspace/rax_facts.py b/lib/ansible/modules/cloud/rackspace/rax_facts.py index 4c40a550a0..762ff1f8a1 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_facts.py +++ b/lib/ansible/modules/cloud/rackspace/rax_facts.py @@ -29,7 +29,6 @@ options: name: description: - Server name to retrieve facts for - default: null author: "Matt Martz (@sivel)" extends_documentation_fragment: rackspace.openstack ''' diff --git a/lib/ansible/modules/cloud/rackspace/rax_files_objects.py b/lib/ansible/modules/cloud/rackspace/rax_files_objects.py index 9138cacc66..e2e5f2ae1b 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_files_objects.py +++ b/lib/ansible/modules/cloud/rackspace/rax_files_objects.py @@ -24,15 +24,12 @@ options: description: - Optionally clear existing metadata when applying metadata to existing objects. Selecting this option is only appropriate when setting type=meta - choices: - - "yes" - - "no" - default: "no" + type: bool + default: 'no' container: description: - The container to use for file object operations. required: true - default: null dest: description: - The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder". @@ -42,11 +39,9 @@ options: description: - Used to set an expiration on a file or folder uploaded to Cloud Files. Requires an integer, specifying expiration in seconds - default: null meta: description: - A hash of items to set as metadata values on an uploaded file or folder - default: null method: description: - The method of operation to be performed. For example, put to upload files @@ -62,16 +57,13 @@ options: - Source from which to upload files. Used to specify a remote object as a source for an operation, i.e. a file name, "file1", or a comma-separated list of remote objects, "file1,file2,file17". src and dest are mutually exclusive on remote-only object operations - default: null structure: description: - Used to specify whether to maintain nested directory structure when downloading objects from Cloud Files. Setting to false downloads the contents of a container to a single, flat directory - choices: - - yes - - "no" - default: "yes" + type: bool + default: 'yes' state: description: - Indicate desired state of the resource diff --git a/lib/ansible/modules/cloud/rackspace/rax_keypair.py b/lib/ansible/modules/cloud/rackspace/rax_keypair.py index 0a6010662c..455caf922d 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_keypair.py +++ b/lib/ansible/modules/cloud/rackspace/rax_keypair.py @@ -26,7 +26,6 @@ options: public_key: description: - Public Key string to upload. Can be a file path or string - default: null state: description: - Indicate desired state of the resource diff --git a/lib/ansible/modules/cloud/rackspace/rax_meta.py b/lib/ansible/modules/cloud/rackspace/rax_meta.py index 5288bb0dd0..e4a34598c4 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_meta.py +++ b/lib/ansible/modules/cloud/rackspace/rax_meta.py @@ -29,11 +29,9 @@ options: name: description: - Server name to modify metadata for - default: null meta: description: - A hash of metadata to associate with the instance - default: null author: "Matt Martz (@sivel)" extends_documentation_fragment: rackspace.openstack ''' diff --git a/lib/ansible/modules/cloud/rackspace/rax_network.py b/lib/ansible/modules/cloud/rackspace/rax_network.py index d4d7323e57..f8473a73fc 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_network.py +++ b/lib/ansible/modules/cloud/rackspace/rax_network.py @@ -29,11 +29,9 @@ options: label: description: - Label (name) to give the network - default: null cidr: description: - cidr of the network being created - default: null author: - "Christopher H. Laco (@claco)" - "Jesse Keating (@j2sol)" diff --git a/lib/ansible/modules/cloud/rackspace/rax_queue.py b/lib/ansible/modules/cloud/rackspace/rax_queue.py index a83dd36826..839f9dc3bc 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_queue.py +++ b/lib/ansible/modules/cloud/rackspace/rax_queue.py @@ -22,7 +22,6 @@ options: name: description: - Name to give the queue - default: null state: description: - Indicate desired state of the resource diff --git a/lib/ansible/modules/cloud/rackspace/rax_scaling_group.py b/lib/ansible/modules/cloud/rackspace/rax_scaling_group.py index 2ba30a11b6..cb12841bb4 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_scaling_group.py +++ b/lib/ansible/modules/cloud/rackspace/rax_scaling_group.py @@ -22,10 +22,8 @@ options: config_drive: description: - Attach read-only configuration drive to server as label config-2 - default: no - choices: - - "yes" - - "no" + type: bool + default: 'no' version_added: 1.8 cooldown: description: @@ -42,7 +40,6 @@ options: files: description: - 'Files to insert into the instance. Hash of C(remotepath: localpath)' - default: null flavor: description: - flavor to use for the instance @@ -54,7 +51,6 @@ options: key_name: description: - key pair to use on the instance - default: null loadbalancers: description: - List of load balancer C(id) and C(port) hashes @@ -66,7 +62,6 @@ options: meta: description: - A hash of metadata to associate with the instance - default: null min_entities: description: - The minimum number of entities that are allowed in the scaling group. @@ -104,10 +99,8 @@ options: description: - wait for the scaling group to finish provisioning the minimum amount of servers - default: "no" - choices: - - "yes" - - "no" + type: bool + default: 'no' wait_timeout: description: - how long before wait gives up, in seconds diff --git a/lib/ansible/modules/cloud/smartos/smartos_image_facts.py b/lib/ansible/modules/cloud/smartos/smartos_image_facts.py index 3d2d788ed3..137288e20d 100644 --- a/lib/ansible/modules/cloud/smartos/smartos_image_facts.py +++ b/lib/ansible/modules/cloud/smartos/smartos_image_facts.py @@ -29,8 +29,6 @@ options: manifest and 'published_date', 'published', 'source', 'clones', and 'size'. More informaton can be found at U(https://smartos.org/man/1m/imgadm) under 'imgadm list'. - required: false - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/univention/udm_share.py b/lib/ansible/modules/cloud/univention/udm_share.py index 68bcad5667..a90e838232 100644 --- a/lib/ansible/modules/cloud/univention/udm_share.py +++ b/lib/ansible/modules/cloud/univention/udm_share.py @@ -28,7 +28,6 @@ requirements: - Python >= 2.6 options: state: - required: false default: "present" choices: [ present, absent ] description: @@ -39,18 +38,15 @@ options: - Name host: required: false - default: None description: - Host FQDN (server which provides the share), e.g. C({{ ansible_fqdn }}). Required if C(state=present). path: required: false - default: None description: - Directory on the providing server, e.g. C(/home). Required if C(state=present). samba_name: required: false - default: None description: - Windows name. Required if C(state=present). aliases: [ sambaName ] @@ -59,297 +55,240 @@ options: description: - Organisational unit, inside the LDAP Base DN. owner: - required: false default: 0 description: - Directory owner of the share's root directory. group: - required: false default: '0' description: - Directory owner group of the share's root directory. directorymode: - required: false default: '00755' description: - Permissions for the share's root directory. root_squash: - required: false default: '1' choices: [ '0', '1' ] description: - Modify user ID for root user (root squashing). subtree_checking: - required: false default: '1' choices: [ '0', '1' ] description: - Subtree checking. sync: - required: false default: 'sync' description: - NFS synchronisation. writeable: - required: false default: '1' choices: [ '0', '1' ] description: - NFS write access. samba_block_size: - required: false - default: None description: - Blocking size. aliases: [ sambaBlockSize ] samba_blocking_locks: - required: false default: '1' choices: [ '0', '1' ] description: - Blocking locks. aliases: [ sambaBlockingLocks ] samba_browseable: - required: false default: '1' choices: [ '0', '1' ] description: - Show in Windows network environment. aliases: [ sambaBrowseable ] samba_create_mode: - required: false default: '0744' description: - File mode. aliases: [ sambaCreateMode ] samba_csc_policy: - required: false default: 'manual' description: - Client-side caching policy. aliases: [ sambaCscPolicy ] samba_custom_settings: - required: false default: [] description: - Option name in smb.conf and its value. aliases: [ sambaCustomSettings ] samba_directory_mode: - required: false default: '0755' description: - Directory mode. aliases: [ sambaDirectoryMode ] samba_directory_security_mode: - required: false default: '0777' description: - Directory security mode. aliases: [ sambaDirectorySecurityMode ] samba_dos_filemode: - required: false default: '0' choices: [ '0', '1' ] description: - Users with write access may modify permissions. aliases: [ sambaDosFilemode ] samba_fake_oplocks: - required: false default: '0' choices: [ '0', '1' ] description: - Fake oplocks. aliases: [ sambaFakeOplocks ] samba_force_create_mode: - required: false default: '0' choices: [ '0', '1' ] description: - Force file mode. aliases: [ sambaForceCreateMode ] samba_force_directory_mode: - required: false default: '0' choices: [ '0', '1' ] description: - Force directory mode. aliases: [ sambaForceDirectoryMode ] samba_force_directory_security_mode: - required: false default: '0' choices: [ '0', '1' ] description: - Force directory security mode. aliases: [ sambaForceDirectorySecurityMode ] samba_force_group: - required: false - default: None description: - Force group. aliases: [ sambaForceGroup ] samba_force_security_mode: - required: false default: '0' choices: [ '0', '1' ] description: - Force security mode. aliases: [ sambaForceSecurityMode ] samba_force_user: - required: false - default: None description: - Force user. aliases: [ sambaForceUser ] samba_hide_files: - required: false - default: None description: - Hide files. aliases: [ sambaHideFiles ] samba_hide_unreadable: - required: false default: '0' choices: [ '0', '1' ] description: - Hide unreadable files/directories. aliases: [ sambaHideUnreadable ] samba_hosts_allow: - required: false default: [] description: - Allowed host/network. aliases: [ sambaHostsAllow ] samba_hosts_deny: - required: false default: [] description: - Denied host/network. aliases: [ sambaHostsDeny ] samba_inherit_acls: - required: false default: '1' choices: [ '0', '1' ] description: - Inherit ACLs. aliases: [ sambaInheritAcls ] samba_inherit_owner: - required: false default: '0' choices: [ '0', '1' ] description: - Create files/directories with the owner of the parent directory. aliases: [ sambaInheritOwner ] samba_inherit_permissions: - required: false default: '0' choices: [ '0', '1' ] description: - Create files/directories with permissions of the parent directory. aliases: [ sambaInheritPermissions ] samba_invalid_users: - required: false - default: None description: - Invalid users or groups. aliases: [ sambaInvalidUsers ] samba_level_2_oplocks: - required: false default: '1' choices: [ '0', '1' ] description: - Level 2 oplocks. aliases: [ sambaLevel2Oplocks ] samba_locking: - required: false default: '1' choices: [ '0', '1' ] description: - Locking. aliases: [ sambaLocking ] samba_msdfs_root: - required: false default: '0' choices: [ '0', '1' ] description: - MSDFS root. aliases: [ sambaMSDFSRoot ] samba_nt_acl_support: - required: false default: '1' choices: [ '0', '1' ] description: - NT ACL support. aliases: [ sambaNtAclSupport ] samba_oplocks: - required: false default: '1' choices: [ '0', '1' ] description: - Oplocks. aliases: [ sambaOplocks ] samba_postexec: - required: false - default: None description: - Postexec script. aliases: [ sambaPostexec ] samba_preexec: - required: false - default: None description: - Preexec script. aliases: [ sambaPreexec ] samba_public: - required: false default: '0' choices: [ '0', '1' ] description: - Allow anonymous read-only access with a guest user. aliases: [ sambaPublic ] samba_security_mode: - required: false default: '0777' description: - Security mode. aliases: [ sambaSecurityMode ] samba_strict_locking: - required: false default: 'Auto' description: - Strict locking. aliases: [ sambaStrictLocking ] samba_vfs_objects: - required: false - default: None description: - VFS objects. aliases: [ sambaVFSObjects ] samba_valid_users: - required: false - default: None description: - Valid users or groups. aliases: [ sambaValidUsers ] samba_write_list: - required: false - default: None description: - Restrict write access to these users/groups. aliases: [ sambaWriteList ] samba_writeable: - required: false default: '1' choices: [ '0', '1' ] description: - Samba write access. aliases: [ sambaWriteable ] nfs_hosts: - required: false default: [] description: - Only allow access for this host, IP address or network. nfs_custom_settings: - required: false default: [] description: - Option name in exports file. diff --git a/lib/ansible/modules/cloud/univention/udm_user.py b/lib/ansible/modules/cloud/univention/udm_user.py index b0f6ee0a60..0cb77c289b 100644 --- a/lib/ansible/modules/cloud/univention/udm_user.py +++ b/lib/ansible/modules/cloud/univention/udm_user.py @@ -28,7 +28,6 @@ requirements: - Python >= 2.6 options: state: - required: false default: "present" choices: [ present, absent ] description: @@ -39,263 +38,191 @@ options: - User name aliases: ['name'] firstname: - required: false description: - First name. Required if C(state=present). lastname: - required: false description: - Last name. Required if C(state=present). password: - required: false - default: None description: - Password. Required if C(state=present). birthday: - required: false - default: None description: - Birthday city: - required: false - default: None description: - City of users business address. country: - required: false - default: None description: - Country of users business address. department_number: - required: false - default: None description: - Department number of users business address. aliases: [ departmentNumber ] description: - required: false - default: None description: - Description (not gecos) display_name: - required: false - default: None description: - Display name (not gecos) aliases: [ displayName ] email: - required: false - default: [''] + default: [] description: - A list of e-mail addresses. employee_number: - required: false - default: None description: - Employee number aliases: [ employeeNumber ] employee_type: - required: false - default: None description: - Employee type aliases: [ employeeType ] gecos: - required: false - default: None description: - GECOS groups: - required: false default: [] description: - "POSIX groups, the LDAP DNs of the groups will be found with the LDAP filter for each group as $GROUP: C((&(objectClass=posixGroup)(cn=$GROUP)))." home_share: - required: false - default: None description: - "Home NFS share. Must be a LDAP DN, e.g. C(cn=home,cn=shares,ou=school,dc=example,dc=com)." aliases: [ homeShare ] home_share_path: - required: false - default: None description: - Path to home NFS share, inside the homeShare. aliases: [ homeSharePath ] home_telephone_number: - required: false default: [] description: - List of private telephone numbers. aliases: [ homeTelephoneNumber ] homedrive: - required: false - default: None description: - Windows home drive, e.g. C("H:"). mail_alternative_address: - required: false default: [] description: - List of alternative e-mail addresses. aliases: [ mailAlternativeAddress ] mail_home_server: - required: false - default: None description: - FQDN of mail server aliases: [ mailHomeServer ] mail_primary_address: - required: false - default: None description: - Primary e-mail address aliases: [ mailPrimaryAddress ] mobile_telephone_number: - required: false default: [] description: - Mobile phone number aliases: [ mobileTelephoneNumber ] organisation: - required: false - default: None description: - Organisation override_pw_history: - required: false - default: False + type: bool + default: 'no' description: - Override password history aliases: [ overridePWHistory ] override_pw_length: - required: false - default: False + type: bool + default: 'no' description: - Override password check aliases: [ overridePWLength ] pager_telephonenumber: - required: false default: [] description: - List of pager telephone numbers. aliases: [ pagerTelephonenumber ] phone: - required: false - default: [] description: - List of telephone numbers. postcode: - required: false - default: None description: - Postal code of users business address. primary_group: - required: false default: cn=Domain Users,cn=groups,$LDAP_BASE_DN description: - Primary group. This must be the group LDAP DN. aliases: [ primaryGroup ] profilepath: - required: false - default: None description: - Windows profile directory pwd_change_next_login: - required: false - default: None choices: [ '0', '1' ] description: - Change password on next login. aliases: [ pwdChangeNextLogin ] room_number: - required: false - default: None description: - Room number of users business address. aliases: [ roomNumber ] samba_privileges: - required: false - default: [] description: - "Samba privilege, like allow printer administration, do domain join." aliases: [ sambaPrivileges ] samba_user_workstations: - required: false - default: [] description: - Allow the authentication only on this Microsoft Windows host. aliases: [ sambaUserWorkstations ] sambahome: - required: false - default: None description: - Windows home path, e.g. C('\\\\$FQDN\\$USERNAME'). scriptpath: - required: false - default: None description: - Windows logon script. secretary: - required: false default: [] description: - A list of superiors as LDAP DNs. serviceprovider: - required: false - default: [''] + default: [] description: - Enable user for the following service providers. shell: - required: false default: '/bin/bash' description: - Login shell street: - required: false - default: None description: - Street of users business address. title: - required: false - default: None description: - Title, e.g. C(Prof.). unixhome: - required: false default: '/home/$USERNAME' description: - Unix home directory userexpiry: - required: false default: Today + 1 year description: - Account expiry date, e.g. C(1999-12-31). position: - required: false default: '' description: - "Define the whole position of users object inside the LDAP tree, e.g. C(cn=employee,cn=users,ou=school,dc=example,dc=com)." update_password: - required: false default: always description: - "C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users." version_added: "2.3" ou: - required: false default: '' description: - "Organizational Unit inside the LDAP Base DN, e.g. C(school) for LDAP OU C(ou=school,dc=example,dc=com)." subpath: - required: false default: 'cn=users' description: - "LDAP subpath inside the organizational unit, e.g. diff --git a/lib/ansible/modules/cloud/vmware/_vsphere_guest.py b/lib/ansible/modules/cloud/vmware/_vsphere_guest.py index 6109ab150d..137eb742dd 100644 --- a/lib/ansible/modules/cloud/vmware/_vsphere_guest.py +++ b/lib/ansible/modules/cloud/vmware/_vsphere_guest.py @@ -27,7 +27,6 @@ options: description: - The hostname of the vcenter server the module will connect to, to create the guest. required: true - default: null validate_certs: description: - Validate SSL certs. Note, if running on python without SSLContext @@ -35,9 +34,8 @@ options: as pysphere does not support validating certificates on older python. Prior to 2.1, this module would always validate on python >= 2.7.9 and never validate on python <= 2.7.8. - required: false - default: yes type: bool + default: 'yes' version_added: 2.1 guest: description: @@ -47,28 +45,20 @@ options: description: - Username to connect to vcenter as. required: true - default: null password: description: - Password of the user to connect to vcenter as. required: true - default: null resource_pool: description: - The name of the resource_pool to create the VM in. - required: false - default: None cluster: description: - The name of the cluster to create the VM in. By default this is derived from the host you tell the module to build the guest on. - required: false - default: None esxi: description: - Dictionary which includes datacenter and hostname on which the VM should be created. For standalone ESXi hosts, ha-datacenter should be used as the datacenter name - required: false - default: null state: description: - Indicate desired state of the vm. 'reconfigured' only applies changes to 'vm_cdrom', 'memory_mb', and 'num_cpus' in vm_hardware parameter. @@ -80,62 +70,48 @@ options: description: - Specifies if the VM should be deployed from a template (mutually exclusive with 'state' parameter). No guest customization changes to hardware such as CPU, RAM, NICs or Disks can be applied when launching from template. - default: no type: bool + default: 'no' template_src: version_added: "1.9" description: - Name of the source template to deploy from - default: None snapshot_to_clone: description: - A string that when specified, will create a linked clone copy of the VM. Snapshot must already be taken in vCenter. version_added: "2.0" - required: false - default: none power_on_after_clone: description: - Specifies if the VM should be powered on after the clone. - required: false - default: yes type: bool + default: 'yes' vm_disk: description: - A key, value list of disks and their sizes and which datastore to keep it in. - required: false - default: null vm_hardware: description: - A key, value list of VM config settings. Must include ['memory_mb', 'num_cpus', 'osid', 'scsi']. - required: false - default: null vm_nic: description: - - A key, value list of nics, their types and what network to put them on. Optionaly with their MAC address. - required: false - default: null + - A key, value list of nics, their types and what network to put them on. + - Optionaly with their MAC address. vm_extra_config: description: - A key, value pair of any extra values you want set or changed in the vmx file of the VM. Useful to set advanced options on the VM. - required: false - default: null vm_hw_version: description: - Desired hardware version identifier (for example, "vmx-08" for vms that needs to be managed with vSphere Client). Note that changing hardware version of existing vm is not supported. - required: false - default: null version_added: "1.7" vmware_guest_facts: description: - Gather facts from vCenter on a particular VM type: bool - default: null force: description: - Boolean. Allows you to run commands which may alter the running state of a guest. Also used to reconfigure and destroy. - default: "no" type: bool + default: 'no' notes: - This module should run from a system that can access vSphere directly. diff --git a/lib/ansible/modules/cloud/vmware/vca_vapp.py b/lib/ansible/modules/cloud/vmware/vca_vapp.py index 3793ce721b..3cada800d4 100644 --- a/lib/ansible/modules/cloud/vmware/vca_vapp.py +++ b/lib/ansible/modules/cloud/vmware/vca_vapp.py @@ -31,94 +31,67 @@ options: the I(state) is not `absent` then the I(template_name) value must be provided. The I(template_name) must be previously uploaded to the catalog specified by I(catalog_name) - required: no - default: None network_name: description: - The name of the network that should be attached to the virtual machine in the vApp. The virtual network specified must already be created in the vCloud Air VDC. If the I(state) is not 'absent' then the I(network_name) argument must be provided. - required: no - default: None network_mode: description: - Configures the mode of the network connection. - required: no default: pool choices: ['pool', 'dhcp', 'static'] vm_name: description: - The name of the virtual machine instance in the vApp to manage. - required: no - default: None vm_cpus: description: - The number of vCPUs to configure for the VM in the vApp. If the I(vm_name) argument is provided, then this becomes a per VM setting otherwise it is applied to all VMs in the vApp. - required: no - default: None vm_memory: description: - The amount of memory in MB to allocate to VMs in the vApp. If the I(vm_name) argument is provided, then this becomes a per VM setting otherise it is applied to all VMs in the vApp. - required: no - default: None operation: description: - Specifies an operation to be performed on the vApp. - required: no default: noop choices: ['noop', 'poweron', 'poweroff', 'suspend', 'shutdown', 'reboot', 'reset'] state: description: - Configures the state of the vApp. - required: no default: present choices: ['present', 'absent', 'deployed', 'undeployed'] username: description: - The vCloud Air username to use during authentication - required: false - default: None password: description: - The vCloud Air password to use during authentication - required: false - default: None org: description: - The org to login to for creating vapp, mostly set when the service_type is vdc. - required: false - default: None instance_id: description: - The instance id in a vchs environment to be used for creating the vapp - required: false - default: None host: description: - The authentication host to be used when service type is vcd. - required: false - default: None api_version: description: - The api version to be used with the vca - required: false default: "5.7" service_type: description: - The type of service we are authenticating against - required: false default: vca choices: [ "vca", "vchs", "vcd" ] vdc_name: description: - The name of the virtual data center (VDC) where the vm should be created or contains the vAPP. - required: false - default: None extends_documentation_fragment: vca ''' diff --git a/lib/ansible/modules/cloud/webfaction/webfaction_app.py b/lib/ansible/modules/cloud/webfaction/webfaction_app.py index 3970db30ce..258c3e627a 100644 --- a/lib/ansible/modules/cloud/webfaction/webfaction_app.py +++ b/lib/ansible/modules/cloud/webfaction/webfaction_app.py @@ -44,7 +44,6 @@ options: state: description: - Whether the application should exist - required: false choices: ['present', 'absent'] default: "present" @@ -57,19 +56,18 @@ options: description: - Whether the app should restart with an C(autostart.cgi) script type: bool - default: "no" + default: 'no' extra_info: description: - Any extra parameters required by the app - required: false default: '' port_open: description: - IF the port should be opened type: bool - default: false + default: 'no' login_name: description: @@ -84,7 +82,7 @@ options: machine: description: - The machine name to use (optional for accounts with only one machine) - default: false + default: False ''' diff --git a/lib/ansible/modules/cloud/webfaction/webfaction_db.py b/lib/ansible/modules/cloud/webfaction/webfaction_db.py index dcccb35898..be40f32cbb 100644 --- a/lib/ansible/modules/cloud/webfaction/webfaction_db.py +++ b/lib/ansible/modules/cloud/webfaction/webfaction_db.py @@ -41,7 +41,6 @@ options: state: description: - Whether the database should exist - required: false choices: ['present', 'absent'] default: "present" @@ -54,8 +53,6 @@ options: password: description: - The password for the new database user. - required: false - default: null login_name: description: diff --git a/lib/ansible/modules/cloud/webfaction/webfaction_domain.py b/lib/ansible/modules/cloud/webfaction/webfaction_domain.py index e3e94d1902..118572f13a 100644 --- a/lib/ansible/modules/cloud/webfaction/webfaction_domain.py +++ b/lib/ansible/modules/cloud/webfaction/webfaction_domain.py @@ -41,14 +41,12 @@ options: state: description: - Whether the domain should exist - required: false choices: ['present', 'absent'] default: "present" subdomains: description: - Any subdomains to create. - required: false default: [] login_name: diff --git a/lib/ansible/modules/cloud/webfaction/webfaction_mailbox.py b/lib/ansible/modules/cloud/webfaction/webfaction_mailbox.py index 4e8db64b9a..afa7020cf9 100644 --- a/lib/ansible/modules/cloud/webfaction/webfaction_mailbox.py +++ b/lib/ansible/modules/cloud/webfaction/webfaction_mailbox.py @@ -39,12 +39,10 @@ options: description: - The password for the mailbox required: true - default: null state: description: - Whether the mailbox should exist - required: false choices: ['present', 'absent'] default: "present" diff --git a/lib/ansible/modules/cloud/webfaction/webfaction_site.py b/lib/ansible/modules/cloud/webfaction/webfaction_site.py index 54e18bbfd1..578668c566 100644 --- a/lib/ansible/modules/cloud/webfaction/webfaction_site.py +++ b/lib/ansible/modules/cloud/webfaction/webfaction_site.py @@ -41,7 +41,6 @@ options: state: description: - Whether the website should exist - required: false choices: ['present', 'absent'] default: "present" @@ -54,18 +53,16 @@ options: description: - Whether or not to use HTTPS type: bool - default: 'false' + default: 'no' site_apps: description: - A mapping of URLs to apps - required: false default: [] subdomains: description: - A list of subdomains associated with this site. - required: false default: [] login_name: |