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 , Tim C " 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 " 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 .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: ::" - 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:' 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 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 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 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 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: - 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` 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., ). - 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: diff --git a/lib/ansible/modules/clustering/consul.py b/lib/ansible/modules/clustering/consul.py index c44a19e023..b9d3162001 100644 --- a/lib/ansible/modules/clustering/consul.py +++ b/lib/ansible/modules/clustering/consul.py @@ -49,86 +49,65 @@ options: - Unique name for the service on a node, must be unique per node, required if registering a service. May be omitted if registering a node level check - required: false service_id: description: - the ID for the service, must be unique per node, defaults to the service name if the service name is supplied - required: false default: service_name if supplied host: description: - host of the consul agent defaults to localhost - required: false default: localhost port: description: - the port on which the consul agent is running - required: false default: 8500 scheme: description: - the protocol scheme on which the consul agent is running - required: false default: http version_added: "2.1" validate_certs: description: - whether to verify the tls certificate of the consul agent - required: false - default: True + type: bool + default: 'yes' version_added: "2.1" notes: description: - Notes to attach to check when registering it. - required: false - default: None service_port: description: - the port on which the service is listening. Can optionally be supplied for registration of a service, i.e. if service_name or service_id is set - required: false - default: None service_address: description: - the address to advertise that the service will be listening on. This value will be passed as the I(Address) parameter to Consul's U(/v1/agent/service/register) API method, so refer to the Consul API documentation for further details. - required: false - default: None version_added: "2.1" tags: description: - a list of tags that will be attached to the service registration. - required: false - default: None script: description: - the script/command that will be run periodically to check the health of the service. Scripts require an interval and vise versa - required: false - default: None interval: description: - the interval at which the service check will be run. This is a number with a s or m suffix to signify the units of seconds or minutes e.g 15s or 1m. If no suffix is supplied, m will be used by default e.g. 1 will be 1m. Required if the script param is specified. - required: false - default: None check_id: description: - an ID for the service check, defaults to the check name, ignored if part of a service definition. - required: false - default: None check_name: description: - a name for the service check, defaults to the check id. required if standalone, ignored if part of service definition. - required: false - default: None ttl: description: - checks can be registered with a ttl instead of a script and interval @@ -138,29 +117,21 @@ options: Similar to the interval this is a number with a s or m suffix to signify the units of seconds or minutes e.g 15s or 1m. If no suffix is supplied, m will be used by default e.g. 1 will be 1m - required: false - default: None http: description: - checks can be registered with an http endpoint. This means that consul will check that the http endpoint returns a successful http status. Interval must also be provided with this option. - required: false - default: None version_added: "2.0" timeout: description: - A custom HTTP check timeout. The consul default is 10 seconds. Similar to the interval this is a number with a s or m suffix to signify the units of seconds or minutes, e.g. 15s or 1m. - required: false - default: None version_added: "2.0" token: description: - the token key indentifying an ACL rule set. May be required to register services. - required: false - default: None """ EXAMPLES = ''' diff --git a/lib/ansible/modules/clustering/znode.py b/lib/ansible/modules/clustering/znode.py index 71cd500758..1824c5b2b9 100755 --- a/lib/ansible/modules/clustering/znode.py +++ b/lib/ansible/modules/clustering/znode.py @@ -30,28 +30,21 @@ options: value: description: - The value assigned to the znode. - default: None - required: false op: description: - An operation to perform. Mutually exclusive with state. - default: None - required: false state: description: - The state to enforce. Mutually exclusive with op. - default: None - required: false timeout: description: - The amount of time to wait for a node to appear. default: 300 - required: false recursive: description: - Recursively delete node and all its children. - default: False - required: false + type: bool + default: 'no' version_added: "2.1" requirements: - kazoo >= 2.1 diff --git a/lib/ansible/modules/commands/command.py b/lib/ansible/modules/commands/command.py index f92a4689ac..ec18aba684 100644 --- a/lib/ansible/modules/commands/command.py +++ b/lib/ansible/modules/commands/command.py @@ -53,8 +53,6 @@ options: version_added: "2.4" description: - Set the stdin of the command directly to the specified value. - required: false - default: null notes: - If you want to run a command through the shell (say you are using C(<), C(>), C(|), etc), you actually want the M(shell) module instead. Parsing shell metacharacters can lead to unexpected commands being executed if quoting is not done correctly so it is more secure to diff --git a/lib/ansible/modules/commands/script.py b/lib/ansible/modules/commands/script.py index 2d186a3308..badafb3e3e 100644 --- a/lib/ansible/modules/commands/script.py +++ b/lib/ansible/modules/commands/script.py @@ -28,26 +28,18 @@ options: description: - Path to the local script file followed by optional arguments. There is no parameter actually named 'free form'; see the examples! required: true - default: null - aliases: [] creates: description: - a filename, when it already exists, this step will B(not) be run. - required: no - default: null version_added: "1.5" removes: description: - a filename, when it does not exist, this step will B(not) be run. - required: no - default: null version_added: "1.5" chdir: description: - cd into this directory on the remote node before running the script version_added: "2.4" - required: false - default: null notes: - It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points! - The ssh connection plugin will force pseudo-tty allocation via -tt when scripts are executed. pseudo-ttys do not have a stderr channel and all diff --git a/lib/ansible/modules/commands/shell.py b/lib/ansible/modules/commands/shell.py index 4e3174587c..04f218b0af 100644 --- a/lib/ansible/modules/commands/shell.py +++ b/lib/ansible/modules/commands/shell.py @@ -30,42 +30,31 @@ options: - The shell module takes a free form command to run, as a string. There's not an actual option named "free form". See the examples! required: true - default: null creates: description: - a filename, when it already exists, this step will B(not) be run. - required: no - default: null removes: description: - a filename, when it does not exist, this step will B(not) be run. version_added: "0.8" - required: no - default: null chdir: description: - cd into this directory before running the command - required: false - default: null version_added: "0.6" executable: description: - change the shell used to execute the command. Should be an absolute path to the executable. - required: false - default: null version_added: "0.9" warn: description: - if command warnings are on in ansible.cfg, do not warn about this particular line if set to no/false. - required: false - default: True + type: bool + default: 'yes' version_added: "1.8" stdin: version_added: "2.4" description: - Set the stdin of the command directly to the specified value. - required: false - default: null notes: - If you want to execute a command securely and predictably, it may be better to use the M(command) module instead. Best practices when writing diff --git a/lib/ansible/modules/database/misc/elasticsearch_plugin.py b/lib/ansible/modules/database/misc/elasticsearch_plugin.py index f3ac231fd9..2a1faf1e2b 100644 --- a/lib/ansible/modules/database/misc/elasticsearch_plugin.py +++ b/lib/ansible/modules/database/misc/elasticsearch_plugin.py @@ -33,49 +33,36 @@ options: state: description: - Desired state of a plugin. - required: False choices: ["present", "absent"] default: present url: description: - Set exact URL to download the plugin from (Only works for ES 1.x) - required: False - default: None timeout: description: - "Timeout setting: 30s, 1m, 1h..." - Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0. - required: False default: 1m plugin_bin: description: - Location of the plugin binary. If this file is not found, the default plugin binaries will be used. - The default changed in Ansible 2.4 to None. - required: False - default: None plugin_dir: description: - Your configured plugin directory specified in Elasticsearch - required: False default: /usr/share/elasticsearch/plugins/ proxy_host: description: - Proxy host to use during plugin installation - required: False - default: None version_added: "2.1" proxy_port: description: - Proxy port to use during plugin installation - required: False - default: None version_added: "2.1" version: description: - Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated - required: False - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/database/misc/kibana_plugin.py b/lib/ansible/modules/database/misc/kibana_plugin.py index f56f36a87e..a6f0b5f623 100644 --- a/lib/ansible/modules/database/misc/kibana_plugin.py +++ b/lib/ansible/modules/database/misc/kibana_plugin.py @@ -31,42 +31,33 @@ options: state: description: - Desired state of a plugin. - required: False choices: ["present", "absent"] default: present url: description: - Set exact URL to download the plugin from. For local file, prefix its absolute path with file:// - required: False - default: None timeout: description: - "Timeout setting: 30s, 1m, 1h..." - required: False default: 1m plugin_bin: description: - Location of the plugin binary - required: False default: /opt/kibana/bin/kibana plugin_dir: description: - Your configured plugin directory specified in Kibana - required: False default: /opt/kibana/installedPlugins/ version: description: - Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated if C(force) is not set to yes - required: False - default: None force: description: - Delete and re-install the plugin. Can be useful for plugins update - required: False - choices: ["yes", "no"] - default: no + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/database/misc/redis.py b/lib/ansible/modules/database/misc/redis.py index 51871c722b..bbeed27d77 100644 --- a/lib/ansible/modules/database/misc/redis.py +++ b/lib/ansible/modules/database/misc/redis.py @@ -41,7 +41,6 @@ options: master_host: description: - The host of the master instance [slave command] - default: null master_port: description: - The port of the master instance [slave command] diff --git a/lib/ansible/modules/database/misc/riak.py b/lib/ansible/modules/database/misc/riak.py index 13be9cab1f..90c98506b2 100644 --- a/lib/ansible/modules/database/misc/riak.py +++ b/lib/ansible/modules/database/misc/riak.py @@ -28,47 +28,35 @@ options: command: description: - The command you would like to perform against the cluster. - required: false - default: null choices: ['ping', 'kv_test', 'join', 'plan', 'commit'] config_dir: description: - The path to the riak configuration directory - required: false default: /etc/riak http_conn: description: - The ip address and port that is listening for Riak HTTP queries - required: false default: 127.0.0.1:8098 target_node: description: - The target node for certain operations (join, ping) - required: false default: riak@127.0.0.1 wait_for_handoffs: description: - Number of seconds to wait for handoffs to complete. - required: false - default: null wait_for_ring: description: - Number of seconds to wait for all nodes to agree on the ring. - required: false - default: null wait_for_service: description: - Waits for a riak service to come online before continuing. - required: false - default: None choices: ['kv'] 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. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: 1.5.1 ''' diff --git a/lib/ansible/modules/database/mongodb/mongodb_parameter.py b/lib/ansible/modules/database/mongodb/mongodb_parameter.py index 28dbf13505..2820982f08 100644 --- a/lib/ansible/modules/database/mongodb/mongodb_parameter.py +++ b/lib/ansible/modules/database/mongodb/mongodb_parameter.py @@ -27,33 +27,23 @@ options: login_user: description: - The username used to authenticate with - required: false - default: null login_password: description: - The password used to authenticate with - required: false - default: null login_host: description: - The host running the database - required: false default: localhost login_port: description: - The port to connect to - required: false default: 27017 login_database: description: - The database where login credentials are stored - required: false - default: null replica_set: description: - Replica set to connect to (automatically connects to primary for writes) - required: false - default: null database: description: - The name of the database to add/remove the user from @@ -61,8 +51,8 @@ options: ssl: description: - Whether to use an SSL connection when connecting to the database - required: false - default: false + type: bool + default: 'no' param: description: - MongoDB administrative parameter to modify @@ -74,7 +64,6 @@ options: param_type: description: - Define the parameter value (str, int) - required: false default: str notes: diff --git a/lib/ansible/modules/database/mongodb/mongodb_user.py b/lib/ansible/modules/database/mongodb/mongodb_user.py index 29fd4345be..e1a4849c8d 100644 --- a/lib/ansible/modules/database/mongodb/mongodb_user.py +++ b/lib/ansible/modules/database/mongodb/mongodb_user.py @@ -26,35 +26,25 @@ options: login_user: description: - The username used to authenticate with - required: false - default: null login_password: description: - The password used to authenticate with - required: false - default: null login_host: description: - The host running the database - required: false default: localhost login_port: description: - The port to connect to - required: false default: 27017 login_database: version_added: "2.0" description: - The database where login credentials are stored - required: false - default: null replica_set: version_added: "1.6" description: - Replica set to connect to (automatically connects to primary for writes) - required: false - default: null database: description: - The name of the database to add/remove the user from @@ -63,23 +53,18 @@ options: description: - The name of the user to add or remove required: true - default: null aliases: [ 'user' ] password: description: - The password to use for the user - required: false - default: null ssl: version_added: "1.8" description: - Whether to use an SSL connection when connecting to the database - default: False ssl_cert_reqs: version_added: "2.2" description: - Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. - required: false default: "CERT_REQUIRED" choices: ["CERT_REQUIRED", "CERT_OPTIONAL", "CERT_NONE"] roles: @@ -91,16 +76,13 @@ options: 'dbAdminAnyDatabase' - "Or the following dictionary '{ db: DATABASE_NAME, role: ROLE_NAME }'." - "This param requires pymongo 2.5+. If it is a string, mongodb 2.4+ is also required. If it is a dictionary, mongo 2.6+ is required." - required: false default: "readWrite" state: description: - The database user state - required: false default: present choices: [ "present", "absent" ] update_password: - required: false default: always choices: ['always', 'on_create'] version_added: "2.1" diff --git a/lib/ansible/modules/database/mssql/mssql_db.py b/lib/ansible/modules/database/mssql/mssql_db.py index f542b44a31..20dd46fd91 100644 --- a/lib/ansible/modules/database/mssql/mssql_db.py +++ b/lib/ansible/modules/database/mssql/mssql_db.py @@ -26,45 +26,35 @@ options: description: - name of the database to add or remove required: true - default: null aliases: [ db ] login_user: description: - The username used to authenticate with - required: false - default: null login_password: description: - The password used to authenticate with - required: false - default: null login_host: description: - Host running the database - required: false login_port: description: - Port of the MSSQL server. Requires login_host be defined as other then localhost if login_port is used - required: false default: 1433 state: description: - The database state - required: false default: present choices: [ "present", "absent", "import" ] target: description: - Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL files (C(.sql)) files are supported. - required: false autocommit: description: - Automatically commit the change only if the import succeed. Sometimes it is necessary to use autocommit=true, since some content can't be changed within a transaction. - required: false - default: false - choices: [ "false", "true" ] + type: bool + default: 'no' notes: - Requires the pymssql Python package on the remote host. For Ubuntu, this is as easy as pip install pymssql (See M(pip).) diff --git a/lib/ansible/modules/database/mysql/mysql_db.py b/lib/ansible/modules/database/mysql/mysql_db.py index a844befcf2..cd2e4240a8 100644 --- a/lib/ansible/modules/database/mysql/mysql_db.py +++ b/lib/ansible/modules/database/mysql/mysql_db.py @@ -28,40 +28,33 @@ options: - name=all May only be provided if I(state) is C(dump) or C(import). - if name=all Works like --all-databases option for mysqldump (Added in 2.0) required: true - default: null aliases: [ db ] state: description: - The database state - required: false default: present choices: [ "present", "absent", "dump", "import" ] collation: description: - Collation mode (sorting). This only applies to new table/databases and does not update existing ones, this is a limitation of MySQL. - required: false - default: null encoding: description: - Encoding mode to use, examples include C(utf8) or C(latin1_swedish_ci) - required: false - default: null target: description: - Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL files (C(.sql)) as well as bzip2 (C(.bz2)), gzip (C(.gz)) and xz (Added in 2.0) compressed files are supported. - required: false single_transaction: description: - Execute the dump in a single transaction - required: false - default: false + type: bool + default: 'no' version_added: "2.1" quick: description: - Option used for dumping large tables - required: false - default: true + type: bool + default: 'yes' version_added: "2.1" author: "Ansible Core Team" requirements: diff --git a/lib/ansible/modules/database/mysql/mysql_replication.py b/lib/ansible/modules/database/mysql/mysql_replication.py index dcc035ce70..669757d6c8 100644 --- a/lib/ansible/modules/database/mysql/mysql_replication.py +++ b/lib/ansible/modules/database/mysql/mysql_replication.py @@ -29,7 +29,6 @@ options: description: - module operating mode. Could be getslave (SHOW SLAVE STATUS), getmaster (SHOW MASTER STATUS), changemaster (CHANGE MASTER TO), startslave (START SLAVE), stopslave (STOP SLAVE), resetslave (RESET SLAVE), resetslaveall (RESET SLAVE ALL) - required: False choices: - getslave - getmaster @@ -88,8 +87,6 @@ options: master_auto_position: description: - does the host uses GTID based replication or not - required: false - default: null version_added: "2.0" extends_documentation_fragment: mysql diff --git a/lib/ansible/modules/database/mysql/mysql_user.py b/lib/ansible/modules/database/mysql/mysql_user.py index f04f876d63..55a387143a 100644 --- a/lib/ansible/modules/database/mysql/mysql_user.py +++ b/lib/ansible/modules/database/mysql/mysql_user.py @@ -28,28 +28,23 @@ options: password: description: - set the user's password. - required: false - default: null encrypted: description: - Indicate that the 'password' field is a `mysql_native_password` hash - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' version_added: "2.0" host: description: - the 'host' part of the MySQL username - required: false default: localhost host_all: description: - override the host option, making ansible apply changes to all hostnames for a given user. This option cannot be used when creating users - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' version_added: "2.1" priv: description: @@ -62,39 +57,32 @@ options: exactly as returned by a C(SHOW GRANT) statement. If not followed, the module will always report changes. It includes grouping columns by permission (C(SELECT(col1,col2)) instead of C(SELECT(col1),SELECT(col2))). - required: false - default: null append_privs: description: - Append the privileges defined by priv to the existing ones for this user instead of overwriting existing ones. - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' version_added: "1.4" sql_log_bin: description: - Whether binary logging should be enabled or disabled for the connection. - required: false - choices: ["yes", "no" ] - default: "yes" + type: bool + default: 'yes' version_added: "2.1" state: description: - Whether the user should exist. When C(absent), removes the user. - required: false default: present choices: [ "present", "absent" ] check_implicit_admin: description: - Check if mysql allows login as root/nopassword before trying supplied credentials. - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' version_added: "1.3" update_password: - required: false default: always choices: ['always', 'on_create'] version_added: "2.0" diff --git a/lib/ansible/modules/database/postgresql/postgresql_db.py b/lib/ansible/modules/database/postgresql/postgresql_db.py index 8dec1efde7..66fd1cbfae 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_db.py +++ b/lib/ansible/modules/database/postgresql/postgresql_db.py @@ -24,34 +24,23 @@ options: description: - name of the database to add or remove required: true - default: null aliases: [ db ] owner: description: - Name of the role to set as owner of the database - required: false - default: null template: description: - Template used to create the database - required: false - default: null encoding: description: - Encoding of the database - required: false - default: null lc_collate: description: - Collation order (LC_COLLATE) to use in the database. Must match collation order of template database unless C(template0) is used as template. - required: false - default: null lc_ctype: description: - Character classification (LC_CTYPE) to use in the database (e.g. lower, upper, ...) Must match LC_CTYPE of template database unless C(template0) is used as template. - required: false - default: null state: description: | The database state. present implies that the database should be created if necessary. @@ -61,7 +50,6 @@ options: (Added in 2.4) The format of the backup will be detected based on the target name. Supported compression formats for dump and restore are: .bz2, .gz, and .xz Supported formats for dump and restore are: .sql and .tar - required: false default: present choices: [ "present", "absent", "dump", "restore" ] target: diff --git a/lib/ansible/modules/database/postgresql/postgresql_ext.py b/lib/ansible/modules/database/postgresql/postgresql_ext.py index 97bd549f21..62b40d9d7f 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_ext.py +++ b/lib/ansible/modules/database/postgresql/postgresql_ext.py @@ -24,36 +24,27 @@ options: description: - name of the extension to add or remove required: true - default: null db: description: - name of the database to add or remove the extension to/from required: true - default: null login_user: description: - The username used to authenticate with - required: false - default: null login_password: description: - The password used to authenticate with - required: false - default: null login_host: description: - Host running the database - required: false default: localhost port: description: - Database port to connect to. - required: false default: 5432 state: description: - The database extension state - required: false default: present choices: [ "present", "absent" ] notes: diff --git a/lib/ansible/modules/database/postgresql/postgresql_lang.py b/lib/ansible/modules/database/postgresql/postgresql_lang.py index 8e5afb6a7a..87b077ebab 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_lang.py +++ b/lib/ansible/modules/database/postgresql/postgresql_lang.py @@ -36,63 +36,51 @@ options: description: - name of the procedural language to add, remove or change required: true - default: null trust: description: - make this language trusted for the selected db - required: false - default: no + type: bool + default: 'no' choices: [ "yes", "no" ] db: description: - name of database where the language will be added, removed or changed - required: false - default: null force_trust: description: - marks the language as trusted, even if it's marked as untrusted in pg_pltemplate. - use with care! - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' fail_on_drop: description: - if C(yes), fail when removing a language. Otherwise just log and continue - in some cases, it is not possible to remove a language (used by the db-system). When dependencies block the removal, consider using C(cascade). - required: false + type: bool default: 'yes' - choices: [ "yes", "no" ] cascade: description: - when dropping a language, also delete object that depend on this language. - only used when C(state=absent). - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' port: description: - Database port to connect to. - required: false default: 5432 login_user: description: - User used to authenticate with PostgreSQL - required: false default: postgres login_password: description: - Password used to authenticate with PostgreSQL (must match C(login_user)) - required: false - default: null login_host: description: - Host running PostgreSQL where you want to execute the actions. - required: false default: localhost state: description: - The state of the language for the selected database - required: false default: present choices: [ "present", "absent" ] notes: diff --git a/lib/ansible/modules/database/postgresql/postgresql_privs.py b/lib/ansible/modules/database/postgresql/postgresql_privs.py index 098882c04d..3afb22ca53 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_privs.py +++ b/lib/ansible/modules/database/postgresql/postgresql_privs.py @@ -33,18 +33,15 @@ options: description: - If C(present), the specified privileges are granted, if C(absent) they are revoked. - required: no default: present choices: [present, absent] privs: description: - Comma separated list of privileges to grant/revoke. - 'Alias: I(priv)' - required: no type: description: - Type of database object to set privileges on. - required: no default: table choices: [table, sequence, function, database, schema, language, tablespace, group] @@ -61,13 +58,11 @@ options: replaced with commas (needed to specify function signatures, see examples)' - 'Alias: I(obj)' - required: no schema: description: - Schema that contains the database objects specified via I(objs). - May only be provided if I(type) is C(table), C(sequence) or C(function). Defaults to C(public) in these cases. - required: no roles: description: - Comma separated list of role (user/group) names to set permissions for. @@ -83,25 +78,19 @@ options: make no changes. - I(grant_option) only has an effect if I(state) is C(present). - 'Alias: I(admin_option)' - required: no - choices: ['yes', 'no'] + type: bool host: description: - Database host address. If unspecified, connect via Unix socket. - 'Alias: I(login_host)' - default: null - required: no port: description: - Database port to connect to. - required: no default: 5432 unix_socket: description: - Path to a Unix domain socket for local connections. - 'Alias: I(login_unix_socket)' - required: false - default: null login: description: - The username to authenticate with. @@ -111,14 +100,11 @@ options: description: - The password to authenticate with. - 'Alias: I(login_password))' - default: null - required: no ssl_mode: description: - Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. - See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes. - Default of C(prefer) matches libpq default. - required: false default: prefer choices: [disable, allow, prefer, require, verify-ca, verify-full] version_added: '2.3' @@ -126,8 +112,6 @@ options: description: - Specifies the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server's certificate will be verified to be signed by one of these authorities. - required: false - default: null version_added: '2.3' notes: - Default authentication assumes that postgresql_privs is run by the diff --git a/lib/ansible/modules/database/postgresql/postgresql_schema.py b/lib/ansible/modules/database/postgresql/postgresql_schema.py index d8edee6326..6c2ce18986 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_schema.py +++ b/lib/ansible/modules/database/postgresql/postgresql_schema.py @@ -24,46 +24,33 @@ options: description: - Name of the schema to add or remove. required: true - default: null database: description: - Name of the database to connect to. - required: false default: postgres login_user: description: - The username used to authenticate with. - required: false - default: null login_password: description: - The password used to authenticate with. - required: false - default: null login_host: description: - Host running the database. - required: false default: localhost login_unix_socket: description: - Path to a Unix domain socket for local connections. - required: false - default: null owner: description: - Name of the role to set as owner of the schema. - required: false - default: null port: description: - Database port to connect to. - required: false default: 5432 state: description: - The schema state. - required: false default: present choices: [ "present", "absent" ] notes: diff --git a/lib/ansible/modules/database/postgresql/postgresql_user.py b/lib/ansible/modules/database/postgresql/postgresql_user.py index 39c4f35796..0e5cd0556e 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_user.py +++ b/lib/ansible/modules/database/postgresql/postgresql_user.py @@ -36,7 +36,6 @@ options: description: - name of the user (role) to add or remove required: true - default: null password: description: - set the user's password, before 1.4 this was required. @@ -45,16 +44,14 @@ options: C('str[\\"md5\\"] + md5[ password + username ]'), resulting in a total of 35 characters. An easy way to do this is: C(echo \\"md5`echo -n \\"verysecretpasswordJOE\\" | md5`\\"). Note that if the provided password string is already in MD5-hashed format, then it is used as-is, regardless of encrypted parameter. - default: null db: description: - name of database where permissions will be granted - default: null fail_on_user: description: - if C(yes), fail when user can't be removed. Otherwise just log and continue + type: bool default: 'yes' - choices: [ yes, no ] port: description: - Database port to connect to. @@ -66,7 +63,6 @@ options: login_password: description: - Password used to authenticate with PostgreSQL - default: null login_host: description: - Host running PostgreSQL. @@ -74,11 +70,9 @@ options: login_unix_socket: description: - Path to a Unix domain socket for local connections - default: null priv: description: - "PostgreSQL privileges string in the format: C(table:priv1,priv2)" - default: null role_attr_flags: description: - "PostgreSQL role attributes string in the format: CREATEDB,CREATEROLE,SUPERUSER" @@ -94,21 +88,19 @@ options: description: - whether the password is stored hashed in the database. boolean. Passwords can be passed already hashed or unhashed, and postgresql ensures the stored password is hashed when encrypted is set. - default: false version_added: '1.4' expires: description: - The date at which the user's password is to expire. - If set to C('infinity'), user's password never expire. - Note that this value should be a valid SQL date and time type. - default: null version_added: '1.4' no_password_changes: description: - if C(yes), don't inspect database for password changes. Effective when C(pg_authid) is not accessible (such as AWS RDS). Otherwise, make password changes as necessary. + type: bool default: 'no' - choices: [ yes, no ] version_added: '2.0' ssl_mode: description: @@ -122,12 +114,10 @@ options: description: - Specifies the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server's certificate will be verified to be signed by one of these authorities. - default: null version_added: '2.3' conn_limit: description: - Specifies the user connection limit. - default: null version_added: '2.4' notes: - The default authentication assumes that you are either logging in as or diff --git a/lib/ansible/modules/database/vertica/vertica_configuration.py b/lib/ansible/modules/database/vertica/vertica_configuration.py index 485d1beef8..e71e1bb5cb 100644 --- a/lib/ansible/modules/database/vertica/vertica_configuration.py +++ b/lib/ansible/modules/database/vertica/vertica_configuration.py @@ -32,28 +32,21 @@ options: db: description: - Name of the Vertica database. - required: false - default: null cluster: description: - Name of the Vertica cluster. - required: false default: localhost port: description: - Vertica cluster port to connect to. - required: false default: 5433 login_user: description: - The username used to authenticate with. - required: false default: dbadmin login_password: description: - The password used to authenticate with. - required: false - default: null notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. diff --git a/lib/ansible/modules/database/vertica/vertica_facts.py b/lib/ansible/modules/database/vertica/vertica_facts.py index c471b9413e..f1d766cc35 100644 --- a/lib/ansible/modules/database/vertica/vertica_facts.py +++ b/lib/ansible/modules/database/vertica/vertica_facts.py @@ -24,28 +24,21 @@ options: cluster: description: - Name of the cluster running the schema. - required: false default: localhost port: description: Database port to connect to. - required: false default: 5433 db: description: - Name of the database running the schema. - required: false - default: null login_user: description: - The username used to authenticate with. - required: false default: dbadmin login_password: description: - The password used to authenticate with. - required: false - default: null notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. diff --git a/lib/ansible/modules/database/vertica/vertica_role.py b/lib/ansible/modules/database/vertica/vertica_role.py index 2385b9f44e..09433cb028 100644 --- a/lib/ansible/modules/database/vertica/vertica_role.py +++ b/lib/ansible/modules/database/vertica/vertica_role.py @@ -29,39 +29,29 @@ options: description: - Comma separated list of roles to assign to the role. aliases: ['assigned_role'] - required: false - default: null state: description: - Whether to create C(present), drop C(absent) or lock C(locked) a role. - required: false choices: ['present', 'absent'] default: present db: description: - Name of the Vertica database. - required: false - default: null cluster: description: - Name of the Vertica cluster. - required: false default: localhost port: description: - Vertica cluster port to connect to. - required: false default: 5433 login_user: description: - The username used to authenticate with. - required: false default: dbadmin login_password: description: - The password used to authenticate with. - required: false - default: null notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. diff --git a/lib/ansible/modules/database/vertica/vertica_schema.py b/lib/ansible/modules/database/vertica/vertica_schema.py index 713435f635..a5579800aa 100644 --- a/lib/ansible/modules/database/vertica/vertica_schema.py +++ b/lib/ansible/modules/database/vertica/vertica_schema.py @@ -34,50 +34,36 @@ options: description: - Comma separated list of roles to create and grant usage access to the schema. aliases: ['usage_role'] - required: false - default: null create_roles: description: - Comma separated list of roles to create and grant usage and create access to the schema. aliases: ['create_role'] - required: false - default: null owner: description: - Name of the user to set as owner of the schema. - required: false - default: null state: description: - Whether to create C(present), or drop C(absent) a schema. - required: false default: present choices: ['present', 'absent'] db: description: - Name of the Vertica database. - required: false - default: null cluster: description: - Name of the Vertica cluster. - required: false default: localhost port: description: - Vertica cluster port to connect to. - required: false default: 5433 login_user: description: - The username used to authenticate with. - required: false default: dbadmin login_password: description: - The password used to authenticate with. - required: false - default: null notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. diff --git a/lib/ansible/modules/database/vertica/vertica_user.py b/lib/ansible/modules/database/vertica/vertica_user.py index d15f1a8e59..11607cf461 100644 --- a/lib/ansible/modules/database/vertica/vertica_user.py +++ b/lib/ansible/modules/database/vertica/vertica_user.py @@ -30,69 +30,49 @@ options: profile: description: - Sets the user's profile. - required: false - default: null resource_pool: description: - Sets the user's resource pool. - required: false - default: null password: description: - The user's password encrypted by the MD5 algorithm. - The password must be generated with the format C("md5" + md5[password + username]), resulting in a total of 35 characters. An easy way to do this is by querying the Vertica database with select 'md5'||md5(''). - required: false - default: null expired: description: - Sets the user's password expiration. - required: false - default: null ldap: description: - Set to true if users are authenticated via LDAP. - The user will be created with password expired and set to I($ldap$). - required: false - default: null roles: description: - Comma separated list of roles to assign to the user. aliases: ['role'] - required: false - default: null state: description: - Whether to create C(present), drop C(absent) or lock C(locked) a user. - required: false choices: ['present', 'absent', 'locked'] default: present db: description: - Name of the Vertica database. - required: false - default: null cluster: description: - Name of the Vertica cluster. - required: false default: localhost port: description: - Vertica cluster port to connect to. - required: false default: 5433 login_user: description: - The username used to authenticate with. - required: false default: dbadmin login_password: description: - The password used to authenticate with. - required: false - default: null notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. diff --git a/lib/ansible/modules/files/fetch.py b/lib/ansible/modules/files/fetch.py index 2ac8f47480..839f94876f 100644 --- a/lib/ansible/modules/files/fetch.py +++ b/lib/ansible/modules/files/fetch.py @@ -27,8 +27,6 @@ options: - The file on the remote system to fetch. This I(must) be a file, not a directory. Recursive fetching may be supported in a later release. required: true - default: null - aliases: [] dest: description: - A directory to save the file into. For example, if the I(dest) @@ -36,7 +34,6 @@ options: C(host.example.com), would be saved into C(/backup/host.example.com/etc/profile) required: true - default: null fail_on_missing: version_added: "1.1" description: @@ -44,16 +41,14 @@ options: read for any reason. Prior to Ansible-2.5, setting this would only fail if the source file was missing. - The default was changed to "yes" in Ansible-2.5. - required: false - choices: [ "yes", "no" ] - default: "yes" + type: bool + default: 'yes' validate_checksum: version_added: "1.4" description: - Verify that the source and destination checksums match after the files are fetched. - required: false - choices: [ "yes", "no" ] - default: "yes" + type: bool + default: 'yes' aliases: [ "validate_md5" ] flat: version_added: "1.2" @@ -62,7 +57,6 @@ options: hostname/path/to/file to the destination. If dest ends with '/', it will use the basename of the source file, similar to the copy module. Obviously this is only handy if the filenames are unique. -requirements: [] author: - "Ansible Core Team" - "Michael DeHaan" diff --git a/lib/ansible/modules/files/find.py b/lib/ansible/modules/files/find.py index f973221217..3613f1e609 100644 --- a/lib/ansible/modules/files/find.py +++ b/lib/ansible/modules/files/find.py @@ -38,7 +38,6 @@ options: least one of the patterns specified. Multiple patterns can be specified using a list. aliases: ['pattern'] excludes: - default: null description: - One or more (shell or regex) patterns, which type is controlled by C(use_regex) option. - Excludes is a patterns should not be returned in list. Multiple patterns can be specified @@ -60,10 +59,10 @@ options: choices: [ any, directory, file, link ] default: file recurse: - default: 'no' - choices: [ 'no', 'yes' ] description: - If target is a directory, recursively descend into the directory looking for files. + type: bool + default: 'no' size: description: - Select files whose size is equal to or greater than the specified size. @@ -77,28 +76,26 @@ options: description: - Choose the file property against which we compare age. hidden: - default: 'no' - choices: [ 'no', 'yes' ] description: - Set this to true to include hidden files, otherwise they'll be ignored. - follow: + type: bool default: 'no' - choices: [ 'no', 'yes' ] + follow: description: - Set this to true to follow symlinks in path for systems with python 2.6+. - get_checksum: + type: bool default: 'no' - choices: [ 'no', 'yes' ] + get_checksum: description: - Set this to true to retrieve a file's sha1 checksum. - use_regex: + type: bool default: 'no' - choices: [ 'no', 'yes' ] + use_regex: description: - If false the patterns are file globs (shell) if true they are python regexes. + type: bool + default: 'no' depth: - required: false - default: null description: - Set the maximum number of levels to decend into. Setting recurse to false will override this value, which is effectively depth 1. diff --git a/lib/ansible/modules/identity/ipa/ipa_role.py b/lib/ansible/modules/identity/ipa/ipa_role.py index 053492af9c..13d5c28f64 100644 --- a/lib/ansible/modules/identity/ipa/ipa_role.py +++ b/lib/ansible/modules/identity/ipa/ipa_role.py @@ -52,7 +52,6 @@ options: - If an empty list is passed all assigned privileges will be removed. - If option is omitted privileges will not be checked or changed. - If option is passed all assigned privileges that are not passed will be removed. - default: None version_added: "2.4" service: description: diff --git a/lib/ansible/modules/messaging/rabbitmq_parameter.py b/lib/ansible/modules/messaging/rabbitmq_parameter.py index b671942964..91039397eb 100644 --- a/lib/ansible/modules/messaging/rabbitmq_parameter.py +++ b/lib/ansible/modules/messaging/rabbitmq_parameter.py @@ -26,32 +26,25 @@ options: description: - Name of the component of which the parameter is being set required: true - default: null name: description: - Name of the parameter being set required: true - default: null value: description: - Value of the parameter, as a JSON term - required: false - default: null vhost: description: - vhost to apply access privileges. - required: false default: / node: description: - erlang node name of the rabbit we wish to configure - required: false default: rabbit version_added: "1.2" state: description: - Specify if user is to be added or removed - required: false default: present choices: [ 'present', 'absent'] ''' diff --git a/lib/ansible/modules/messaging/rabbitmq_policy.py b/lib/ansible/modules/messaging/rabbitmq_policy.py index 5211cd3d87..9109283c33 100644 --- a/lib/ansible/modules/messaging/rabbitmq_policy.py +++ b/lib/ansible/modules/messaging/rabbitmq_policy.py @@ -26,16 +26,13 @@ options: description: - The name of the policy to manage. required: true - default: null vhost: description: - The name of the vhost to apply to. - required: false default: / apply_to: description: - What the policy applies to. Requires RabbitMQ 3.2.0 or later. - required: false default: all choices: [all, exchanges, queues] version_added: "2.1" @@ -43,21 +40,17 @@ options: description: - A regex of queues to apply the policy to. required: true - default: null tags: description: - A dict or string describing the policy. required: true - default: null priority: description: - The priority of the policy. - required: false default: 0 node: description: - Erlang node name of the rabbit we wish to configure. - required: false default: rabbit state: description: diff --git a/lib/ansible/modules/messaging/rabbitmq_queue.py b/lib/ansible/modules/messaging/rabbitmq_queue.py index 706eb6eebc..9d2c490feb 100644 --- a/lib/ansible/modules/messaging/rabbitmq_queue.py +++ b/lib/ansible/modules/messaging/rabbitmq_queue.py @@ -33,84 +33,67 @@ options: - Whether the queue should be present or absent - Only present implemented atm choices: [ "present", "absent" ] - required: false default: present login_user: description: - rabbitMQ user for connection - required: false default: guest login_password: description: - rabbitMQ password for connection - required: false - default: false + type: bool + default: 'no' login_host: description: - rabbitMQ host for connection - required: false default: localhost login_port: description: - rabbitMQ management api port - required: false default: 15672 vhost: description: - rabbitMQ virtual host - required: false default: "/" durable: description: - whether queue is durable or not - required: false - choices: [ "yes", "no" ] - default: yes + type: bool + default: 'yes' auto_delete: description: - if the queue should delete itself after all queues/queues unbound from it - required: false - choices: [ "yes", "no" ] - default: no + type: bool + default: 'no' message_ttl: description: - How long a message can live in queue before it is discarded (milliseconds) - required: False default: forever auto_expires: description: - How long a queue can be unused before it is automatically deleted (milliseconds) - required: false default: forever max_length: description: - How many messages can the queue contain before it starts rejecting - required: false default: no limit dead_letter_exchange: description: - Optional name of an exchange to which messages will be republished if they - are rejected or expire - required: false - default: None dead_letter_routing_key: description: - Optional replacement routing key to use when a message is dead-lettered. - Original routing key will be used if unset - required: false - default: None max_priority: description: - Maximum number of priority levels for the queue to support. - If not set, the queue will not support message priorities. - Larger numbers indicate higher priority. - required: false - default: None version_added: "2.4" arguments: description: - extra arguments for queue. If defined this argument is a key/value dictionary - required: false default: {} ''' diff --git a/lib/ansible/modules/messaging/rabbitmq_user.py b/lib/ansible/modules/messaging/rabbitmq_user.py index f309e11139..c4662f5a7a 100644 --- a/lib/ansible/modules/messaging/rabbitmq_user.py +++ b/lib/ansible/modules/messaging/rabbitmq_user.py @@ -26,20 +26,15 @@ options: description: - Name of user to add required: true - default: null aliases: [username, name] password: description: - Password of user to add. - To change the password of an existing user, you must also specify C(force=yes). - required: false - default: null tags: description: - User tags specified as comma delimited - required: false - default: null permissions: description: - a list of dicts, each dict contains vhost, configure_priv, write_priv, and read_priv, @@ -47,18 +42,15 @@ options: - This option should be preferable when you care about all permissions of the user. - You should use vhost, configure_priv, write_priv, and read_priv options instead if you care about permissions for just some vhosts. - required: false default: [] vhost: description: - vhost to apply access privileges. - This option will be ignored when permissions option is used. - required: false default: / node: description: - erlang node name of the rabbit we wish to configure - required: false default: rabbit version_added: "1.2" configure_priv: @@ -67,7 +59,6 @@ options: for the specified vhost. - By default all actions are restricted. - This option will be ignored when permissions option is used. - required: false default: ^$ write_priv: description: @@ -75,7 +66,6 @@ options: for the specified vhost. - By default all actions are restricted. - This option will be ignored when permissions option is used. - required: false default: ^$ read_priv: description: @@ -83,18 +73,15 @@ options: for the specified vhost. - By default all actions are restricted. - This option will be ignored when permissions option is used. - required: false default: ^$ force: description: - Deletes and recreates the user. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' state: description: - Specify if user is to be added or removed - required: false default: present choices: [present, absent] ''' diff --git a/lib/ansible/modules/messaging/rabbitmq_vhost.py b/lib/ansible/modules/messaging/rabbitmq_vhost.py index 3de2e89f18..bc85d92ec9 100644 --- a/lib/ansible/modules/messaging/rabbitmq_vhost.py +++ b/lib/ansible/modules/messaging/rabbitmq_vhost.py @@ -26,19 +26,17 @@ options: description: - The name of the vhost to manage required: true - default: null aliases: [vhost] node: description: - erlang node name of the rabbit we wish to configure - required: false default: rabbit version_added: "1.2" tracing: description: - Enable/disable tracing for a vhost - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' aliases: [trace] state: description: diff --git a/lib/ansible/modules/monitoring/datadog_event.py b/lib/ansible/modules/monitoring/datadog_event.py index 5036a647a9..2bfb669a36 100644 --- a/lib/ansible/modules/monitoring/datadog_event.py +++ b/lib/ansible/modules/monitoring/datadog_event.py @@ -28,13 +28,10 @@ version_added: "1.3" author: - "Artūras `arturaz` Šlajus (@arturaz)" - "Naoya Nakazawa (@n0ts)" -notes: [] -requirements: [] options: api_key: description: ["Your DataDog API key."] required: true - default: null app_key: description: ["Your DataDog app key."] required: true @@ -42,47 +39,36 @@ options: title: description: ["The event title."] required: true - default: null text: description: ["The body of the event."] required: true - default: null date_happened: description: - POSIX timestamp of the event. - Default value is now. - required: false default: now priority: description: ["The priority of the event."] - required: false default: normal choices: [normal, low] host: description: ["Host name to associate with the event."] - required: false default: "{{ ansible_hostname }}" version_added: "2.4" tags: description: ["Comma separated list of tags to apply to the event."] - required: false - default: null alert_type: description: ["Type of alert."] - required: false default: info choices: ['error', 'warning', 'info', 'success'] aggregation_key: description: ["An arbitrary string to use for aggregation."] - required: false - default: null 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. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: 1.5.1 ''' diff --git a/lib/ansible/modules/monitoring/datadog_monitor.py b/lib/ansible/modules/monitoring/datadog_monitor.py index 474d7a5dd6..dd98ac355b 100644 --- a/lib/ansible/modules/monitoring/datadog_monitor.py +++ b/lib/ansible/modules/monitoring/datadog_monitor.py @@ -36,20 +36,14 @@ options: choices: ['present', 'absent', 'mute', 'unmute'] tags: description: ["A list of tags to associate with your monitor when creating or updating. This can help you categorize and filter monitors."] - required: false - default: None version_added: "2.2" type: description: - "The type of the monitor." - The 'event alert'is available starting at Ansible 2.1 - required: false - default: null choices: ['metric alert', 'service check', 'event alert'] query: description: ["The monitor query to notify on with syntax varying depending on what type of monitor you are creating."] - required: false - default: null name: description: ["The name of the alert."] required: true @@ -57,16 +51,13 @@ options: description: - A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. Monitor message template variables can be accessed by using double square brackets, i.e '[[' and ']]'. - required: false - default: null silenced: description: ["Dictionary of scopes to timestamps or None. Each scope will be muted until the given POSIX timestamp or forever if the value is None. "] - required: false default: "" notify_no_data: description: ["A boolean indicating whether this monitor will notify when data stops reporting.."] - required: false - default: False + type: bool + default: 'no' no_data_timeframe: description: - The number of minutes before a monitor will notify when data stops reporting. Must be at least 2x the monitor timeframe for metric @@ -75,52 +66,39 @@ options: default: 2x timeframe for metric, 2 minutes for service timeout_h: description: ["The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state."] - required: false - default: null renotify_interval: description: - The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved. - required: false - default: null escalation_message: description: - A message to include with a re-notification. Supports the '@username' notification we allow elsewhere. Not applicable if renotify_interval is None - required: false - default: null notify_audit: description: ["A boolean indicating whether tagged users will be notified on changes to this monitor."] - required: false - default: False + type: bool + default: 'no' thresholds: description: - A dictionary of thresholds by status. This option is only available for service checks and metric alerts. Because each of them can have multiple thresholds, we don't define them directly in the query."] - required: false default: {'ok': 1, 'critical': 1, 'warning': 1} locked: description: ["A boolean indicating whether changes to this monitor should be restricted to the creator or admins."] - required: false - default: False + type: bool + default: 'no' version_added: "2.2" require_full_window: description: - A boolean indicating whether this monitor needs a full window of data before it's evaluated. We highly recommend you set this to False for sparse metrics, otherwise some evaluations will be skipped. - required: false - default: null version_added: "2.3" new_host_delay: description: ["A positive integer representing the number of seconds to wait before evaluating the monitor for new hosts. This gives the host time to fully initialize."] - required: false - default: null version_added: "2.4" id: description: ["The id of the alert. If set, will be used instead of the name to locate the alert."] - required: false - default: null version_added: "2.3" ''' diff --git a/lib/ansible/modules/monitoring/honeybadger_deployment.py b/lib/ansible/modules/monitoring/honeybadger_deployment.py index 50f68b32f4..b8b500ace9 100644 --- a/lib/ansible/modules/monitoring/honeybadger_deployment.py +++ b/lib/ansible/modules/monitoring/honeybadger_deployment.py @@ -32,32 +32,23 @@ options: user: description: - The username of the person doing the deployment - required: false - default: None repo: description: - URL of the project repository - required: false - default: None revision: description: - A hash, number, tag, or other identifier showing what revision was deployed - required: false - default: None url: description: - Optional URL to submit the notification to. - required: false default: "https://api.honeybadger.io/v1/deploys" validate_certs: description: - If C(no), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] -requirements: [] ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/icinga2_host.py b/lib/ansible/modules/monitoring/icinga2_host.py index 8e1bcff230..bb05996227 100644 --- a/lib/ansible/modules/monitoring/icinga2_host.py +++ b/lib/ansible/modules/monitoring/icinga2_host.py @@ -31,14 +31,14 @@ options: description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - default: 'yes' type: bool + default: 'yes' 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: 'yes' type: bool + default: 'yes' url_username: description: - The username for use in HTTP basic authentication. @@ -53,8 +53,8 @@ options: responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request. - default: 'no' type: bool + default: 'no' client_cert: description: - PEM formatted certificate chain file to be used for SSL client @@ -68,7 +68,6 @@ options: state: description: - Apply feature state. - required: false choices: [ "present", "absent" ] default: present name: @@ -82,17 +81,13 @@ options: description: - The template used to define the host. - Template cannot be modified after object creation. - required: false - default: None check_command: description: - The command used to check if the host is alive. - required: false default: "hostalive" display_name: description: - The name used to display the host. - required: false default: if none is give it is the value of the parameter ip: description: @@ -101,8 +96,6 @@ options: variables: description: - List of variables. - required: false - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/logicmonitor.py b/lib/ansible/modules/monitoring/logicmonitor.py index 21cc2c32a2..3151e46e39 100644 --- a/lib/ansible/modules/monitoring/logicmonitor.py +++ b/lib/ansible/modules/monitoring/logicmonitor.py @@ -50,7 +50,6 @@ options: NOTE Host and Hostgroup tasks should always be performed via delegate_to: localhost. There are no benefits to running these tasks on the remote host and doing so will typically cause problems. required: true - default: null choices: ['collector', 'host', 'datsource', 'hostgroup'] action: description: @@ -60,94 +59,76 @@ options: - "Update: Update properties, description, or groups (target=host) for an object in your LogicMonitor account." - "SDT: Schedule downtime for an object in your LogicMonitor account." required: true - default: null choices: ['add', 'remove', 'update', 'sdt'] company: description: - The LogicMonitor account company name. If you would log in to your account at "superheroes.logicmonitor.com" you would use "superheroes." required: true - default: null user: description: - A LogicMonitor user name. The module will authenticate and perform actions on behalf of this user. required: true - default: null password: description: - The password of the specified LogicMonitor user required: true - default: null collector: description: - The fully qualified domain name of a collector in your LogicMonitor account. - This is required for the creation of a LogicMonitor host (target=host action=add). - This is required for updating, removing or scheduling downtime for hosts if 'displayname' isn't specified (target=host action=update action=remove action=sdt). - required: false - default: null hostname: description: - The hostname of a host in your LogicMonitor account, or the desired hostname of a device to manage. - Optional for managing hosts (target=host). - required: false default: 'hostname -f' displayname: description: - The display name of a host in your LogicMonitor account or the desired display name of a device to manage. - Optional for managing hosts (target=host). - required: false default: 'hostname -f' description: description: - The long text description of the object in your LogicMonitor account. - Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update). - required: false default: "" properties: description: - A dictionary of properties to set on the LogicMonitor host or host group. - Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update). - This parameter will add or update existing properties in your LogicMonitor account. - required: false default: {} groups: description: - A list of groups that the host should be a member of. - Optional for managing hosts (target=host; action=add or action=update). - required: false default: [] id: description: - ID of the datasource to target. - Required for management of LogicMonitor datasources (target=datasource). - required: false - default: null fullpath: description: - The fullpath of the host group object you would like to manage. - Recommend running on a single Ansible host. - Required for management of LogicMonitor host groups (target=hostgroup). - required: false - default: null alertenable: description: - A boolean flag to turn alerting on or off for an object. - Optional for managing all hosts (action=add or action=update). - required: false - default: true - choices: [true, false] + type: bool + default: 'yes' starttime: description: - The time that the Scheduled Down Time (SDT) should begin. - Optional for managing SDT (action=sdt). - Y-m-d H:M - required: false default: Now duration: description: - The duration (minutes) of the Scheduled Down Time (SDT). - Optional for putting an object into SDT (action=sdt). - required: false default: 30 ... ''' diff --git a/lib/ansible/modules/monitoring/logicmonitor_facts.py b/lib/ansible/modules/monitoring/logicmonitor_facts.py index 0b98cf2705..d69ae23cd0 100644 --- a/lib/ansible/modules/monitoring/logicmonitor_facts.py +++ b/lib/ansible/modules/monitoring/logicmonitor_facts.py @@ -29,49 +29,39 @@ options: description: - The LogicMonitor object you wish to manage. required: true - default: null choices: ['host', 'hostgroup'] company: description: - The LogicMonitor account company name. If you would log in to your account at "superheroes.logicmonitor.com" you would use "superheroes". required: true - default: null user: description: - A LogicMonitor user name. The module will authenticate and perform actions on behalf of this user. required: true - default: null password: description: - The password for the chosen LogicMonitor User. - If an md5 hash is used, the digest flag must be set to true. required: true - default: null collector: description: - The fully qualified domain name of a collector in your LogicMonitor account. - This is optional for querying a LogicMonitor host when a displayname is specified. - This is required for querying a LogicMonitor host when a displayname is not specified. - required: false - default: null hostname: description: - The hostname of a host in your LogicMonitor account, or the desired hostname of a device to add into monitoring. - Required for managing hosts (target=host). - required: false default: 'hostname -f' displayname: description: - The display name of a host in your LogicMonitor account or the desired display name of a device to add into monitoring. - required: false default: 'hostname -f' fullpath: description: - The fullpath of the hostgroup object you would like to manage. - Recommend running on a single ansible host. - Required for management of LogicMonitor host groups (target=hostgroup). - required: false - default: null ... ''' diff --git a/lib/ansible/modules/monitoring/logstash_plugin.py b/lib/ansible/modules/monitoring/logstash_plugin.py index 304ce84232..bb48915b13 100644 --- a/lib/ansible/modules/monitoring/logstash_plugin.py +++ b/lib/ansible/modules/monitoring/logstash_plugin.py @@ -28,30 +28,22 @@ options: state: description: - Apply plugin state. - required: False choices: ["present", "absent"] default: present plugin_bin: description: - Specify logstash-plugin to use for plugin management. - required: False default: /usr/share/logstash/bin/logstash-plugin proxy_host: description: - Proxy host to use during plugin installation. - required: False - default: None proxy_port: description: - Proxy port to use during plugin installation. - required: False - default: None version: description: - Specify plugin Version of the plugin to install. If plugin exists with previous version, it will NOT be updated. - required: False - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/monit.py b/lib/ansible/modules/monitoring/monit.py index d79dbb58e8..17be42e7cf 100644 --- a/lib/ansible/modules/monitoring/monit.py +++ b/lib/ansible/modules/monitoring/monit.py @@ -25,22 +25,18 @@ options: description: - The name of the I(monit) program/process to manage required: true - default: null state: description: - The state of service required: true - default: null choices: [ "present", "started", "stopped", "restarted", "monitored", "unmonitored", "reloaded" ] timeout: description: - If there are pending actions for the service monitored by monit, then Ansible will check for up to this many seconds to verify the requested action has been performed. Ansible will sleep for five seconds between each check. - required: false default: 300 version_added: "2.1" -requirements: [ ] author: "Darryl Stoflet (@dstoflet)" ''' diff --git a/lib/ansible/modules/monitoring/nagios.py b/lib/ansible/modules/monitoring/nagios.py index 1cf7480418..892fbc322c 100644 --- a/lib/ansible/modules/monitoring/nagios.py +++ b/lib/ansible/modules/monitoring/nagios.py @@ -46,31 +46,25 @@ options: host: description: - Host to operate on in Nagios. - required: false - default: null cmdfile: description: - Path to the nagios I(command file) (FIFO pipe). Only required if auto-detection fails. - required: false default: auto-detected author: description: - Author to leave downtime comments as. Only usable with the C(downtime) action. - required: false default: Ansible comment: version_added: "2.0" description: - Comment for C(downtime) action. - required: false default: Scheduling downtime minutes: description: - Minutes to schedule downtime for. - Only usable with the C(downtime) action. - required: false default: 30 services: description: diff --git a/lib/ansible/modules/monitoring/pagerduty.py b/lib/ansible/modules/monitoring/pagerduty.py index 7d9f57af03..4656f1fbfd 100644 --- a/lib/ansible/modules/monitoring/pagerduty.py +++ b/lib/ansible/modules/monitoring/pagerduty.py @@ -32,83 +32,53 @@ options: description: - Create a maintenance window or get a list of ongoing windows. required: true - default: null choices: [ "running", "started", "ongoing", "absent" ] - aliases: [] name: description: - PagerDuty unique subdomain. required: true - default: null - choices: [] - aliases: [] user: description: - PagerDuty user ID. required: true - default: null - choices: [] - aliases: [] passwd: description: - PagerDuty user password. required: true - default: null - choices: [] - aliases: [] token: description: - A pagerduty token, generated on the pagerduty site. Can be used instead of user/passwd combination. required: true - default: null - choices: [] - aliases: [] version_added: '1.8' requester_id: description: - ID of user making the request. Only needed when using a token and creating a maintenance_window. required: true - default: null - choices: [] - aliases: [] version_added: '1.8' service: description: - A comma separated list of PagerDuty service IDs. - required: false - default: null - choices: [] aliases: [ services ] hours: description: - Length of maintenance window in hours. - required: false default: 1 - choices: [] - aliases: [] minutes: description: - Maintenance window in minutes (this is added to the hours). - required: false default: 0 - choices: [] - aliases: [] version_added: '1.8' desc: description: - Short description of maintenance window. - required: false default: Created by Ansible - choices: [] - aliases: [] 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. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: 1.5.1 ''' diff --git a/lib/ansible/modules/monitoring/pingdom.py b/lib/ansible/modules/monitoring/pingdom.py index 3fdf696301..7ebad7043e 100644 --- a/lib/ansible/modules/monitoring/pingdom.py +++ b/lib/ansible/modules/monitoring/pingdom.py @@ -29,37 +29,23 @@ options: description: - Define whether or not the check should be running or paused. required: true - default: null choices: [ "running", "paused" ] - aliases: [] checkid: description: - Pingdom ID of the check. required: true - default: null - choices: [] - aliases: [] uid: description: - Pingdom user ID. required: true - default: null - choices: [] - aliases: [] passwd: description: - Pingdom user password. required: true - default: null - choices: [] - aliases: [] key: description: - Pingdom API key. required: true - default: null - choices: [] - aliases: [] notes: - This module does not yet have support to add/remove checks. ''' diff --git a/lib/ansible/modules/monitoring/sensu_check.py b/lib/ansible/modules/monitoring/sensu_check.py index afa259f40f..a773a53c5d 100644 --- a/lib/ansible/modules/monitoring/sensu_check.py +++ b/lib/ansible/modules/monitoring/sensu_check.py @@ -33,22 +33,19 @@ options: description: - Whether the check should be present or not choices: [ 'present', 'absent' ] - required: false default: present path: description: - Path to the json file of the check to be added/removed. - Will be created if it does not exist (unless I(state=absent)). - The parent folders need to exist when I(state=present), otherwise an error will be thrown - required: false default: /etc/sensu/conf.d/checks.json backup: description: - Create a backup file (if yes), including the timestamp information so - you can get the original file back if you somehow clobbered it incorrectly. - choices: [ 'yes', 'no' ] - required: false - default: no + type: bool + default: 'no' command: description: - Path to the sensu check to run (not required when I(state=absent)) @@ -56,113 +53,85 @@ options: handlers: description: - List of handlers to notify when the check fails - required: false default: [] subscribers: description: - List of subscribers/channels this check should run for - See sensu_subscribers to subscribe a machine to a channel - required: false default: [] interval: description: - Check interval in seconds - required: false - default: null timeout: description: - Timeout for the check - required: false default: 10 ttl: description: - Time to live in seconds until the check is considered stale - required: false - default: null version_added: 2.4 handle: description: - Whether the check should be handled or not - choices: [ 'yes', 'no' ] - required: false - default: yes + type: bool + default: 'yes' subdue_begin: description: - When to disable handling of check failures - required: false - default: null subdue_end: description: - When to enable handling of check failures - required: false - default: null dependencies: description: - Other checks this check depends on, if dependencies fail, - handling of this check will be disabled - required: false default: [] metric: description: - Whether the check is a metric - choices: [ 'yes', 'no' ] - required: false - default: no + type: bool + default: 'no' standalone: description: - Whether the check should be scheduled by the sensu client or server - This option obviates the need for specifying the I(subscribers) option - choices: [ 'yes', 'no' ] - required: false - default: no + type: bool + default: 'no' publish: description: - Whether the check should be scheduled at all. - You can still issue it via the sensu api - choices: [ 'yes', 'no' ] - required: false - default: yes + type: bool + default: 'yes' occurrences: description: - Number of event occurrences before the handler should take action - required: false default: 1 refresh: description: - Number of seconds handlers should wait before taking second action - required: false - default: null aggregate: description: - Classifies the check as an aggregate check, - making it available via the aggregate API - choices: [ 'yes', 'no' ] - required: false - default: no + type: bool + default: 'no' low_flap_threshold: description: - The low threshold for flap detection - required: false - default: null high_flap_threshold: description: - The high threshold for flap detection - required: false - default: null custom: version_added: "2.1" description: - A hash/dictionary of custom parameters for mixing to the configuration. - You can't rewrite others module parameters using this - required: false default: {} source: version_added: "2.1" description: - The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch). - required: false - default: null -requirements: [ ] author: "Anders Ingemann (@andsens)" ''' diff --git a/lib/ansible/modules/monitoring/sensu_client.py b/lib/ansible/modules/monitoring/sensu_client.py index 1eccaf6e68..4da3adabb3 100644 --- a/lib/ansible/modules/monitoring/sensu_client.py +++ b/lib/ansible/modules/monitoring/sensu_client.py @@ -24,17 +24,14 @@ options: description: - Whether the client should be present or not choices: [ 'present', 'absent' ] - required: False default: present name: description: - A unique name for the client. The name cannot contain special characters or spaces. - required: False default: System hostname as determined by Ruby Socket.gethostname (provided by Sensu) address: description: - An address to help identify and reach the client. This is only informational, usually an IP address or hostname. - required: False default: Non-loopback IPv4 address as determined by Ruby Socket.ip_address_list (provided by Sensu) subscriptions: description: @@ -42,73 +39,50 @@ options: - These subscriptions determine which monitoring checks are executed by the client, as check requests are sent to subscriptions. - The subscriptions array items must be strings. required: True - default: null safe_mode: description: - If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check. - choices: [ 'true', 'false' ] - required: False - default: false + type: bool + default: 'no' redact: description: - Client definition attributes to redact (values) when logging and sending client keepalives. - required: False - default: null socket: description: - The socket definition scope, used to configure the Sensu client socket. - required: False - default: null keepalives: description: - If Sensu should monitor keepalives for this client. - choices: [ 'true', 'false' ] - required: False - default: true + type: bool + default: 'yes' keepalive: description: - The keepalive definition scope, used to configure Sensu client keepalives behavior (e.g. keepalive thresholds, etc). - required: False - default: null registration: description: - The registration definition scope, used to configure Sensu registration event handlers. - required: False - default: null deregister: description: - If a deregistration event should be created upon Sensu client process stop. - choices: [ 'true', 'false' ] - required: False - default: false + type: bool + default: 'no' deregistration: description: - The deregistration definition scope, used to configure automated Sensu client de-registration. - required: False - default: null ec2: description: - The ec2 definition scope, used to configure the Sensu Enterprise AWS EC2 integration (Sensu Enterprise users only). - required: False - default: null chef: description: - The chef definition scope, used to configure the Sensu Enterprise Chef integration (Sensu Enterprise users only). - required: False - default: null puppet: description: - The puppet definition scope, used to configure the Sensu Enterprise Puppet integration (Sensu Enterprise users only). - required: False - default: null servicenow: description: - The servicenow definition scope, used to configure the Sensu Enterprise ServiceNow integration (Sensu Enterprise users only). - required: False - default: null notes: - Check mode is supported -requirements: [ ] ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/sensu_handler.py b/lib/ansible/modules/monitoring/sensu_handler.py index d0e9c171cd..88d6341825 100644 --- a/lib/ansible/modules/monitoring/sensu_handler.py +++ b/lib/ansible/modules/monitoring/sensu_handler.py @@ -24,87 +24,66 @@ options: description: - Whether the handler should be present or not choices: [ 'present', 'absent' ] - required: False default: present name: description: - A unique name for the handler. The name cannot contain special characters or spaces. required: True - default: null type: description: - The handler type choices: [ 'pipe', 'tcp', 'udp', 'transport', 'set' ] required: True - default: null filter: description: - The Sensu event filter (name) to use when filtering events for the handler. - required: False - default: null filters: description: - An array of Sensu event filters (names) to use when filtering events for the handler. - Each array item must be a string. - required: False - default: null severities: description: - An array of check result severities the handler will handle. - 'NOTE: event resolution bypasses this filtering.' choices: [ 'warning', 'critical', 'unknown' ] - required: False - default: null mutator: description: - The Sensu event mutator (name) to use to mutate event data for the handler. - required: False - default: null timeout: description: - The handler execution duration timeout in seconds (hard stop). - Only used by pipe and tcp handler types. - required: False default: 10 handle_silenced: description: - If events matching one or more silence entries should be handled. - required: False - default: False + type: bool + default: 'no' handle_flapping: description: - If events in the flapping state should be handled. - required: False - default: False + type: bool + default: 'no' command: description: - The handler command to be executed. - The event data is passed to the process via STDIN. - 'NOTE: the command attribute is only required for Pipe handlers (i.e. handlers configured with "type": "pipe").' - required: False - default: null socket: description: - The socket definition scope, used to configure the TCP/UDP handler socket. - 'NOTE: the socket attribute is only required for TCP/UDP handlers (i.e. handlers configured with "type": "tcp" or "type": "udp").' - required: False - default: null pipe: description: - The pipe definition scope, used to configure the Sensu transport pipe. - 'NOTE: the pipe attribute is only required for Transport handlers (i.e. handlers configured with "type": "transport").' - required: False - default: null handlers: description: - An array of Sensu event handlers (names) to use for events using the handler set. - Each array item must be a string. - 'NOTE: the handlers attribute is only required for handler sets (i.e. handlers configured with "type": "set").' - required: True - default: null notes: - Check mode is supported -requirements: [ ] ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/stackdriver.py b/lib/ansible/modules/monitoring/stackdriver.py index 80e8b5dd71..a33058a4ea 100644 --- a/lib/ansible/modules/monitoring/stackdriver.py +++ b/lib/ansible/modules/monitoring/stackdriver.py @@ -25,59 +25,41 @@ options: description: - API key. required: true - default: null event: description: - The type of event to send, either annotation or deploy choices: ['annotation', 'deploy'] - required: false - default: null revision_id: description: - The revision of the code that was deployed. Required for deploy events - required: false - default: null deployed_by: description: - The person or robot responsible for deploying the code - required: false default: "Ansible" deployed_to: description: - "The environment code was deployed to. (ie: development, staging, production)" - required: false - default: null repository: description: - The repository (or project) deployed - required: false - default: null msg: description: - The contents of the annotation message, in plain text.  Limited to 256 characters. Required for annotation. - required: false - default: null annotated_by: description: - The person or robot who the annotation should be attributed to. - required: false default: "Ansible" level: description: - one of INFO/WARN/ERROR, defaults to INFO if not supplied.  May affect display. choices: ['INFO', 'WARN', 'ERROR'] - required: false default: 'INFO' instance_id: description: - id of an EC2 instance that this event should be attached to, which will limit the contexts where this event is shown - required: false - default: null event_epoch: description: - "Unix timestamp of where the event should appear in the timeline, defaults to now. Be careful with this." - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/statusio_maintenance.py b/lib/ansible/modules/monitoring/statusio_maintenance.py index 851bffad16..71436e2109 100644 --- a/lib/ansible/modules/monitoring/statusio_maintenance.py +++ b/lib/ansible/modules/monitoring/statusio_maintenance.py @@ -30,17 +30,14 @@ options: title: description: - A descriptive title for the maintenance window - required: false default: "A new maintenance window" desc: description: - Message describing the maintenance window - required: false default: "Created by Ansible" state: description: - Desired state of the package. - required: false default: "present" choices: ["present", "absent"] api_id: @@ -58,73 +55,61 @@ options: url: description: - Status.io API URL. A private apiary can be used instead. - required: false default: "https://api.status.io" components: description: - The given name of your component (server name) - required: false aliases: ['component'] - default: None containers: description: - The given name of your container (data center) - required: false aliases: ['container'] - default: None all_infrastructure_affected: description: - If it affects all components and containers - required: false - default: false + type: bool + default: 'no' automation: description: - Automatically start and end the maintenance window - required: false - default: false + type: bool + default: 'no' maintenance_notify_now: description: - Notify subscribers now - required: false - default: false + type: bool + default: 'no' maintenance_notify_72_hr: description: - Notify subscribers 72 hours before maintenance start time - required: false - default: false + type: bool + default: 'no' maintenance_notify_24_hr: description: - Notify subscribers 24 hours before maintenance start time - required: false - default: false + type: bool + default: 'no' maintenance_notify_1_hr: description: - Notify subscribers 1 hour before maintenance start time - required: false - default: false + type: bool + default: 'no' maintenance_id: description: - The maintenance id number when deleting a maintenance window - required: false - default: None minutes: description: - The length of time in UTC that the maintenance will run \ (starting from playbook runtime) - required: false default: 10 start_date: description: - Date maintenance is expected to start (Month/Day/Year) (UTC) - End Date is worked out from start_date + minutes - required: false - default: None start_time: description: - Time maintenance is expected to start (Hour:Minutes) (UTC) - End Time is worked out from start_time + minutes - required: false - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/monitoring/uptimerobot.py b/lib/ansible/modules/monitoring/uptimerobot.py index 22426cfb76..59cff51f5b 100644 --- a/lib/ansible/modules/monitoring/uptimerobot.py +++ b/lib/ansible/modules/monitoring/uptimerobot.py @@ -27,23 +27,15 @@ options: description: - Define whether or not the monitor should be running or paused. required: true - default: null choices: [ "started", "paused" ] - aliases: [] monitorid: description: - ID of the monitor to check. required: true - default: null - choices: [] - aliases: [] apikey: description: - Uptime Robot API key. required: true - default: null - choices: [] - aliases: [] notes: - Support for adding and removing monitors and alert contacts has not yet been implemented. ''' diff --git a/lib/ansible/modules/monitoring/zabbix/zabbix_host.py b/lib/ansible/modules/monitoring/zabbix/zabbix_host.py index 1a9a5a2d0d..5922da5a2c 100644 --- a/lib/ansible/modules/monitoring/zabbix/zabbix_host.py +++ b/lib/ansible/modules/monitoring/zabbix/zabbix_host.py @@ -46,11 +46,9 @@ options: host_groups: description: - List of host groups the host is part of. - required: false link_templates: description: - List of templates linked to the host. - default: None inventory_mode: description: - Configure the inventory mode. @@ -77,7 +75,6 @@ options: proxy: description: - The name of the Zabbix proxy to be used. - default: None interfaces: description: - List of interfaces to be created for the host (see example below). @@ -158,8 +155,8 @@ options: force: description: - Overwrite the host configuration, even if already present. + type: bool default: 'yes' - choices: [ 'yes', 'no' ] version_added: '2.0' extends_documentation_fragment: - zabbix diff --git a/lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py b/lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py index f619bd928c..ad896e7364 100644 --- a/lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py +++ b/lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py @@ -28,7 +28,6 @@ options: state: description: - Create or remove a maintenance window. Maintenance window to remove is identified by name. - required: false default: present choices: [ "present", "absent" ] host_names: @@ -38,8 +37,6 @@ options: C(host_name) is an alias for C(host_names). B(Required) option when C(state) is I(present) and no C(host_groups) specified. - required: false - default: null aliases: [ "host_name" ] host_groups: description: @@ -48,13 +45,10 @@ options: C(host_group) is an alias for C(host_groups). B(Required) option when C(state) is I(present) and no C(host_names) specified. - required: false - default: null aliases: [ "host_group" ] minutes: description: - Length of maintenance window in minutes. - required: false default: 10 name: description: @@ -68,8 +62,8 @@ options: collect_data: description: - Type of maintenance. With data collection, or without. - required: false - default: "true" + type: bool + default: 'yes' extends_documentation_fragment: - zabbix diff --git a/lib/ansible/modules/net_tools/cloudflare_dns.py b/lib/ansible/modules/net_tools/cloudflare_dns.py index fbd0e06ed8..d51f77f4aa 100644 --- a/lib/ansible/modules/net_tools/cloudflare_dns.py +++ b/lib/ansible/modules/net_tools/cloudflare_dns.py @@ -35,68 +35,53 @@ options: required: true port: description: Service port. Required for C(type=SRV) - required: false - default: null priority: description: Record priority. Required for C(type=MX) and C(type=SRV) - required: false default: "1" proto: - description: Service protocol. Required for C(type=SRV). Common values are tcp and udp. (Before Ansible 2.6 only tcp and udp were available). - required: false - default: null + description: + - Service protocol. Required for C(type=SRV). + - Common values are tcp and udp. + - Before Ansible 2.6 only tcp and udp were available. proxied: description: Proxy through cloudflare network or just use DNS - required: false - default: no + type: bool + default: 'no' version_added: "2.3" record: description: - Record to add. Required if C(state=present). Default is C(@) (e.g. the zone name) - required: false default: "@" aliases: [ "name" ] service: description: Record service. Required for C(type=SRV) - required: false - default: null solo: description: - Whether the record should be the only one for that record type and record name. Only use with C(state=present) - This will delete all other records with the same record name and type. - required: false - default: null state: description: - Whether the record(s) should exist or not - required: false choices: [ 'present', 'absent' ] default: present timeout: description: - Timeout for Cloudflare API calls - required: false default: 30 ttl: description: - The TTL to give the new record. Must be between 120 and 2,147,483,647 seconds, or 1 for automatic. - required: false default: 1 (automatic) type: description: - The type of DNS record to create. Required if C(state=present) - required: false choices: [ 'A', 'AAAA', 'CNAME', 'TXT', 'SRV', 'MX', 'NS', 'SPF' ] - default: null value: description: - The record value. Required for C(state=present) - required: false - default: null aliases: [ "content" ] weight: description: Service weight. Required for C(type=SRV) - required: false default: "1" zone: description: diff --git a/lib/ansible/modules/net_tools/dnsimple.py b/lib/ansible/modules/net_tools/dnsimple.py index 5739ee8a04..57e5355302 100644 --- a/lib/ansible/modules/net_tools/dnsimple.py +++ b/lib/ansible/modules/net_tools/dnsimple.py @@ -24,73 +24,52 @@ options: - > Account email. If omitted, the env variables DNSIMPLE_EMAIL and DNSIMPLE_API_TOKEN will be looked for. If those aren't found, a C(.dnsimple) file will be looked for, see: U(https://github.com/mikemaccana/dnsimple-python#getting-started) - required: false - default: null account_api_token: description: - Account API token. See I(account_email) for info. - required: false - default: null domain: description: - Domain to work with. Can be the domain name (e.g. "mydomain.com") or the numeric ID of the domain in DNSimple. If omitted, a list of domains will be returned. - If domain is present but the domain doesn't exist, it will be created. - required: false - default: null record: description: - Record to add, if blank a record for the domain will be created, supports the wildcard (*) - required: false - default: null record_ids: description: - List of records to ensure they either exist or don't exist - required: false - default: null type: description: - The type of DNS record to create - required: false choices: [ 'A', 'ALIAS', 'CNAME', 'MX', 'SPF', 'URL', 'TXT', 'NS', 'SRV', 'NAPTR', 'PTR', 'AAAA', 'SSHFP', 'HINFO', 'POOL' ] - default: null ttl: description: - The TTL to give the new record - required: false default: 3600 (one hour) value: description: - Record value - "Must be specified when trying to ensure a record exists" - required: false - default: null priority: description: - Record priority - required: false - default: null state: description: - whether the record should exist or not - required: false choices: [ 'present', 'absent' ] - default: null solo: description: - Whether the record should be the only one for that record type and record name. Only use with state=present on a record - required: false - default: null requirements: [ dnsimple ] author: "Alex Coomans (@drcapulet)" diff --git a/lib/ansible/modules/net_tools/dnsmadeeasy.py b/lib/ansible/modules/net_tools/dnsmadeeasy.py index e4093359af..8e583a1cba 100644 --- a/lib/ansible/modules/net_tools/dnsmadeeasy.py +++ b/lib/ansible/modules/net_tools/dnsmadeeasy.py @@ -25,34 +25,27 @@ options: description: - Account API Key. required: true - default: null account_secret: description: - Account Secret Key. required: true - default: null domain: description: - Domain to work with. Can be the domain name (e.g. "mydomain.com") or the numeric ID of the domain in DNS Made Easy (e.g. "839989") for faster resolution required: true - default: null record_name: description: - Record name to get/create/delete/update. If record_name is not specified; all records for the domain will be returned in "result" regardless of the state argument. - required: false - default: null record_type: description: - Record type. - required: false choices: [ 'A', 'AAAA', 'CNAME', 'ANAME', 'HTTPRED', 'MX', 'NS', 'PTR', 'SRV', 'TXT' ] - default: null record_value: description: @@ -62,13 +55,10 @@ options: - > If record_value is not specified; no changes will be made and the record will be returned in 'result' (in other words, this module can be used to fetch a record's current id, type, and ttl) - required: false - default: null record_ttl: description: - record's "Time to live". Number of seconds the record remains cached in DNS servers. - required: false default: 1800 state: @@ -76,23 +66,20 @@ options: - whether the record should exist or not required: true choices: [ 'present', 'absent' ] - default: null 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. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: 1.5.1 monitor: description: - If C(yes), add or change the monitor. This is applicable only for A records. - required: true + type: bool default: 'no' - choices: ['yes', 'no'] version_added: 2.4 systemDescription: @@ -143,68 +130,58 @@ options: httpFqdn: description: - The fully qualified domain name used by the monitor. - required: false version_added: 2.4 httpFile: description: - The file at the Fqdn that the monitor queries for HTTP or HTTPS. - required: false version_added: 2.4 httpQueryString: description: - The string in the httpFile that the monitor queries for HTTP or HTTPS. - required: False version_added: 2.4 failover: description: - If C(yes), add or change the failover. This is applicable only for A records. - required: true + type: bool default: 'no' - choices: ['yes', 'no'] version_added: 2.4 autoFailover: description: - If true, fallback to the primary IP address is manual after a failover. - If false, fallback to the primary IP address is automatic after a failover. - required: true + type: bool default: 'no' - choices: ['yes', 'no'] version_added: 2.4 ip1: description: - Primary IP address for the failover. - Required if adding or changing the monitor or failover. - required: false version_added: 2.4 ip2: description: - Secondary IP address for the failover. - Required if adding or changing the failover. - required: false version_added: 2.4 ip3: description: - Tertiary IP address for the failover. - required: false version_added: 2.4 ip4: description: - Quaternary IP address for the failover. - required: false version_added: 2.4 ip5: description: - Quinary IP address for the failover. - required: false version_added: 2.4 notes: diff --git a/lib/ansible/modules/net_tools/haproxy.py b/lib/ansible/modules/net_tools/haproxy.py index f775f8e29d..79d932b89a 100644 --- a/lib/ansible/modules/net_tools/haproxy.py +++ b/lib/ansible/modules/net_tools/haproxy.py @@ -33,7 +33,6 @@ options: backend: description: - Name of the HAProxy backend pool. - required: false default: auto-detected drain: description: @@ -41,25 +40,22 @@ options: determined by wait_interval and wait_retries is reached. Continue only after the status changes to 'MAINT'. This overrides the shutdown_sessions option. - default: false version_added: "2.4" host: description: - Name of the backend host to change. required: true - default: null shutdown_sessions: description: - When disabling a server, immediately terminate all the sessions attached to the specified server. This can be used to terminate long-running sessions after a server is put into maintenance mode. Overridden by the drain option. - required: false - default: false + type: bool + default: 'no' socket: description: - Path to the HAProxy socket file. - required: false default: /var/run/haproxy.sock state: description: @@ -67,31 +63,28 @@ options: - Note that C(drain) state was added in version 2.4. It is supported only by HAProxy version 1.5 or later, if used on versions < 1.5, it will be ignored. required: true - default: null choices: [ "enabled", "disabled", "drain" ] fail_on_not_found: description: - Fail whenever trying to enable/disable a backend host that does not exist - required: false - default: false + type: bool + default: 'no' version_added: "2.2" wait: description: - Wait until the server reports a status of 'UP' when `state=enabled`, status of 'MAINT' when `state=disabled` or status of 'DRAIN' when `state=drain` - required: false - default: false + type: bool + default: 'no' version_added: "2.0" wait_interval: description: - Number of seconds to wait between retries. - required: false default: 5 version_added: "2.0" wait_retries: description: - Number of times to check for status after changing the state. - required: false default: 25 version_added: "2.0" weight: @@ -100,8 +93,6 @@ options: the new weight will be relative to the initially configured weight. Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/net_tools/ldap/ldap_attr.py b/lib/ansible/modules/net_tools/ldap/ldap_attr.py index 081a9c5853..a1784768da 100644 --- a/lib/ansible/modules/net_tools/ldap/ldap_attr.py +++ b/lib/ansible/modules/net_tools/ldap/ldap_attr.py @@ -43,42 +43,33 @@ requirements: - python-ldap options: bind_dn: - required: false - default: null description: - A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism. If this is blank, we'll use an anonymous bind. bind_pw: - required: false - default: null description: - The password to use with I(bind_dn). dn: - required: true description: - The DN of the entry to modify. - name: required: true + name: description: - The name of the attribute to modify. + required: true server_uri: - required: false - default: ldapi:/// description: - A URI to the LDAP server. The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location. + default: ldapi:/// start_tls: - required: false - choices: ['yes', 'no'] - default: 'no' description: - If true, we'll use the START_TLS LDAP extension. + type: bool + default: 'no' state: - required: false - choices: [present, absent, exact] - default: present description: - The state of the attribute values. If C(present), all given values will be added if they're missing. If C(absent), all given @@ -86,19 +77,20 @@ options: will be forced to exactly those provided and no others. If I(state=exact) and I(value) is empty, all values for this attribute will be removed. + choices: [present, absent, exact] + default: present values: - required: true description: - The value(s) to add or remove. This can be a string or a list of strings. The complex argument format is required in order to pass a list of strings (see examples). + required: true validate_certs: - required: false - choices: ['yes', 'no'] - default: 'yes' description: - If C(no), SSL certificates will not be validated. This should only be used on sites using self-signed certificates. + type: bool + default: 'yes' version_added: "2.4" """ diff --git a/lib/ansible/modules/net_tools/ldap/ldap_entry.py b/lib/ansible/modules/net_tools/ldap/ldap_entry.py index 35743f63a4..73fb10bd6c 100644 --- a/lib/ansible/modules/net_tools/ldap/ldap_entry.py +++ b/lib/ansible/modules/net_tools/ldap/ldap_entry.py @@ -37,68 +37,54 @@ requirements: - python-ldap options: bind_dn: - required: false - default: null description: - A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism. If this is blank, we'll use an anonymous bind. bind_pw: - required: false - default: null description: - The password to use with I(bind_dn). dn: - required: true description: - The DN of the entry to add or remove. + required: true attributes: - required: false - default: null description: - If I(state=present), attributes necessary to create an entry. Existing entries are never modified. To assert specific attribute values on an existing entry, use M(ldap_attr) module instead. objectClass: - required: false - default: null description: - If I(state=present), value or list of values to use when creating the entry. It can either be a string or an actual list of strings. params: - required: false - default: null description: - List of options which allows to overwrite any of the task or the I(attributes) options. To remove an option, set the value of the option to C(null). server_uri: - required: false - default: ldapi:/// description: - A URI to the LDAP server. The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location. + default: ldapi:/// start_tls: - required: false - choices: ['yes', 'no'] - default: 'no' description: - If true, we'll use the START_TLS LDAP extension. + type: bool + default: 'no' state: - required: false - choices: [present, absent] - default: present description: - The target state of the entry. + choices: [present, absent] + default: present validate_certs: - required: false - choices: ['yes', 'no'] - default: 'yes' description: - If C(no), SSL certificates will not be validated. This should only be used on sites using self-signed certificates. + type: bool + default: 'yes' version_added: "2.4" """ diff --git a/lib/ansible/modules/net_tools/nios/nios_host_record.py b/lib/ansible/modules/net_tools/nios/nios_host_record.py index aa9ac0b144..b1073ac18f 100644 --- a/lib/ansible/modules/net_tools/nios/nios_host_record.py +++ b/lib/ansible/modules/net_tools/nios/nios_host_record.py @@ -29,7 +29,6 @@ options: - Specifies the fully qualified hostname to add or remove from the system required: true - default: null view: description: - Sets the DNS view to associate this host record with. The DNS @@ -42,8 +41,6 @@ options: description: - Configures the IPv4 addresses for this host record. This argument accepts a list of values (see suboptions) - required: false - default: null aliases: - ipv4 suboptions: @@ -51,19 +48,15 @@ options: description: - Configures the IPv4 address for the host record required: true - default: null aliases: - address mac: description: - Configures the hardware MAC address for the host record - required: false ipv6addrs: description: - Configures the IPv6 addresses for the host record. This argument accepts a list of values (see options) - required: false - default: null aliases: - ipv6 suboptions: @@ -71,33 +64,27 @@ options: description: - Configures the IPv6 address for the host record required: true - default: null aliases: - address ttl: description: - Configures the TTL to be associated with this host record - required: false - default: null extattrs: description: - Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration. - required: false comment: description: - Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance. - required: false state: description: - Configures the intended state of the instance of the object on the NIOS server. When this value is set to C(present), the object is configured on the device and when this value is set to C(absent) the value is removed (if necessary) from the device. - required: false default: present choices: - present diff --git a/lib/ansible/modules/net_tools/nios/nios_network.py b/lib/ansible/modules/net_tools/nios/nios_network.py index 42f5b3d1a6..5d73677ec8 100644 --- a/lib/ansible/modules/net_tools/nios/nios_network.py +++ b/lib/ansible/modules/net_tools/nios/nios_network.py @@ -29,7 +29,6 @@ options: - Specifies the network to add or remove from the system. The value should use CIDR notation. required: true - default: null aliases: - name - cidr @@ -45,55 +44,42 @@ options: the configured network instance. This argument accepts a list of values (see suboptions). When configuring suboptions at least one of C(name) or C(num) must be specified. - required: false - default: null suboptions: name: description: - The name of the DHCP option to configure - required: false - default: null num: description: - The number of the DHCP option to configure - required: false value: description: - The value of the DHCP option specified by C(name) required: true - default: null use_option: description: - Only applies to a subset of options (see NIOS API documentation) - required: false type: bool - default: true + default: 'yes' vendor_class: description: - The name of the space this DHCP option is associated to - required: false default: DHCP extattrs: description: - Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration. - required: false - default: null comment: description: - Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance. - required: false - default: null state: description: - Configures the intended state of the instance of the object on the NIOS server. When this value is set to C(present), the object is configured on the device and when this value is set to C(absent) the value is removed (if necessary) from the device. - required: false default: present choices: - present diff --git a/lib/ansible/modules/net_tools/nios/nios_network_view.py b/lib/ansible/modules/net_tools/nios/nios_network_view.py index 93e488e580..8cf24ef96e 100644 --- a/lib/ansible/modules/net_tools/nios/nios_network_view.py +++ b/lib/ansible/modules/net_tools/nios/nios_network_view.py @@ -36,22 +36,17 @@ options: - Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration. - required: false - default: null comment: description: - Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance. - required: false - default: null state: description: - Configures the intended state of the instance of the object on the NIOS server. When this value is set to C(present), the object is configured on the device and when this value is set to C(absent) the value is removed (if necessary) from the device. - required: false default: present choices: - present diff --git a/lib/ansible/modules/net_tools/nios/nios_zone.py b/lib/ansible/modules/net_tools/nios/nios_zone.py index b65d3f32ef..de5b6e51e7 100644 --- a/lib/ansible/modules/net_tools/nios/nios_zone.py +++ b/lib/ansible/modules/net_tools/nios/nios_zone.py @@ -29,7 +29,6 @@ options: - Specifies the qualified domain name to either add or remove from the NIOS instance based on the configured C(state) value. required: true - default: null aliases: - name view: @@ -44,17 +43,14 @@ options: grid_primary: description: - Configures the grid primary servers for this zone. - required: false suboptions: name: description: - The name of the grid primary server required: true - default: null grid_secondaries: description: - Configures the grid secondary servers for this zone. - required: false suboptions: name: description: @@ -65,20 +61,17 @@ options: - Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration. - required: false comment: description: - Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance. - required: false state: description: - Configures the intended state of the instance of the object on the NIOS server. When this value is set to C(present), the object is configured on the device and when this value is set to C(absent) the value is removed (if necessary) from the device. - required: false default: present choices: - present diff --git a/lib/ansible/modules/net_tools/nmcli.py b/lib/ansible/modules/net_tools/nmcli.py index 18e334dea3..6e204ba026 100644 --- a/lib/ansible/modules/net_tools/nmcli.py +++ b/lib/ansible/modules/net_tools/nmcli.py @@ -28,204 +28,150 @@ description: - "On Ubuntu and Debian like systems, install dependencies as 'apt-get install -y libnm-glib-dev'" options: state: - required: True - choices: [ present, absent ] description: - Whether the device should exist or not, taking action if the state is different from what is stated. + required: True + choices: [ present, absent ] autoconnect: - required: False - default: "yes" - type: bool description: - Whether the connection should start on boot. - Whether the connection profile can be automatically activated + type: bool + default: 'yes' conn_name: - required: True description: - 'Where conn_name will be the name used to call the connection. when not provided a default name is generated: [-][-]' + required: True ifname: - required: False - default: conn_name description: - Where IFNAME will be the what we call the interface name. - interface to bind the connection to. The connection will only be applicable to this interface name. - A special value of "*" can be used for interface-independent connections. - The ifname argument is mandatory for all connection types except bond, team, bridge and vlan. + default: conn_name type: - required: False - choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, bridge-slave, vlan, generic ] description: - This is the type of device or network connection that you wish to create or modify. - "type C(generic) is added in version 2.5." + choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, bridge-slave, vlan, generic ] mode: - required: False - choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ] - default: balence-rr description: - This is the type of device or network connection that you wish to create for a bond, team or bridge. + choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ] + default: balence-rr master: - required: False - default: None description: - master ] STP forwarding delay, in seconds + default: 15 hellotime: - required: False - default: 2 description: - This is only used with bridge - [hello-time <1-10>] STP hello time, in seconds + default: 2 maxage: - required: False - default: 20 description: - This is only used with bridge - [max-age <6-42>] STP maximum message age, in seconds + default: 20 ageingtime: - required: False - default: 300 description: - This is only used with bridge - [ageing-time <0-1000000>] the Ethernet MAC address aging time, in seconds + default: 300 mac: - required: False - default: None description: - > This is only used with bridge - MAC address of the bridge (note: this requires a recent kernel feature, originally introduced in 3.15 upstream kernel) slavepriority: - required: False - default: 32 description: - This is only used with 'bridge-slave' - [<0-63>] - STP priority of this slave + default: 32 path_cost: - required: False - default: 100 description: - This is only used with 'bridge-slave' - [<1-65535>] - STP port cost for destinations via this slave + default: 100 hairpin: - required: False - default: yes description: - This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the frame was received on. + type: bool + default: 'yes' vlanid: - required: False - default: None description: - This is only used with VLAN - VLAN ID in range <0-4095> vlandev: - required: False - default: None description: - This is only used with VLAN - parent device this VLAN is on, can use ifname flags: - required: False - default: None description: - This is only used with VLAN - flags ingress: - required: False - default: None description: - This is only used with VLAN - VLAN ingress priority mapping egress: - required: False - default: None description: - This is only used with VLAN - VLAN egress priority mapping diff --git a/lib/ansible/modules/net_tools/nsupdate.py b/lib/ansible/modules/net_tools/nsupdate.py index 518bdbd947..74cc279f52 100644 --- a/lib/ansible/modules/net_tools/nsupdate.py +++ b/lib/ansible/modules/net_tools/nsupdate.py @@ -75,7 +75,6 @@ options: value: description: - Sets the record value. - default: None ''' diff --git a/lib/ansible/modules/net_tools/omapi_host.py b/lib/ansible/modules/net_tools/omapi_host.py index e6f60a00ee..316cf356dd 100644 --- a/lib/ansible/modules/net_tools/omapi_host.py +++ b/lib/ansible/modules/net_tools/omapi_host.py @@ -36,7 +36,6 @@ options: name: description: - Sets the host lease hostname (mandatory if state=present). - default: None host: description: - Sets OMAPI server host to interact with. @@ -60,18 +59,15 @@ options: ip: description: - Sets the lease host IP address. - required: false - default: None statements: description: - Attach a list of OMAPI DHCP statements with host lease (without ending semicolon). - required: false default: [] ddns: description: - Enable dynamic DNS updates for this host. - required: false - default: false + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/a10/a10_server.py b/lib/ansible/modules/network/a10/a10_server.py index a1bb77ddb8..8350ee6620 100644 --- a/lib/ansible/modules/network/a10/a10_server.py +++ b/lib/ansible/modules/network/a10/a10_server.py @@ -33,8 +33,6 @@ options: version_added: "2.3" description: - set active-partition - required: false - default: null server_name: description: - The SLB (Server Load Balancer) server name. @@ -43,13 +41,10 @@ options: server_ip: description: - The SLB server IPv4 address. - required: false - default: null aliases: ['ip', 'address'] server_status: description: - The SLB virtual server status. - required: false default: enabled aliases: ['status'] choices: ['enabled', 'disabled'] @@ -59,23 +54,19 @@ options: dictionary which specifies the C(port:) and C(protocol:), but can also optionally specify the C(status:). See the examples below for details. This parameter is required when C(state) is C(present). - required: false - default: null aliases: ['port'] state: description: - This is to specify the operation to create, update or remove SLB server. - required: false default: present choices: ['present', 'absent'] validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. - required: false version_added: 2.3 + type: bool default: 'yes' - choices: ['yes', 'no'] ''' diff --git a/lib/ansible/modules/network/a10/a10_server_axapi3.py b/lib/ansible/modules/network/a10/a10_server_axapi3.py index 8e8951dc30..a0ab55aa85 100644 --- a/lib/ansible/modules/network/a10/a10_server_axapi3.py +++ b/lib/ansible/modules/network/a10/a10_server_axapi3.py @@ -40,7 +40,6 @@ options: server_status: description: - The SLB (Server Load Balancer) virtual server status. - required: false default: enable aliases: ['action'] choices: ['enable', 'disable'] @@ -48,23 +47,19 @@ options: description: - A list of ports to create for the server. Each list item should be a dictionary which specifies the C(port:) and C(protocol:). - required: false - default: null aliases: ['port'] operation: description: - Create, Update or Remove SLB server. For create and update operation, we use the IP address and server name specified in the POST message. For delete operation, we use the server name in the request URI. - required: false default: create choices: ['create', 'update', 'remove'] validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] ''' diff --git a/lib/ansible/modules/network/a10/a10_service_group.py b/lib/ansible/modules/network/a10/a10_service_group.py index dc3dcb3645..943fe29c3b 100644 --- a/lib/ansible/modules/network/a10/a10_service_group.py +++ b/lib/ansible/modules/network/a10/a10_service_group.py @@ -39,25 +39,20 @@ options: version_added: "2.3" description: - set active-partition - required: false - default: null service_group: description: - The SLB (Server Load Balancing) service-group name required: true - default: null aliases: ['service', 'pool', 'group'] service_group_protocol: description: - The SLB service-group protocol of TCP or UDP. - required: false default: tcp aliases: ['proto', 'protocol'] choices: ['tcp', 'udp'] service_group_method: description: - The SLB service-group load balancing method, such as round-robin or weighted-rr. - required: false default: round-robin aliases: ['method'] choices: @@ -77,16 +72,13 @@ options: - A list of servers to add to the service group. Each list item should be a dictionary which specifies the C(server:) and C(port:), but can also optionally specify the C(status:). See the examples below for details. - required: false - default: null aliases: ['server', 'member'] validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] ''' diff --git a/lib/ansible/modules/network/a10/a10_virtual_server.py b/lib/ansible/modules/network/a10/a10_virtual_server.py index 1c3afea626..02c17ab4a7 100644 --- a/lib/ansible/modules/network/a10/a10_virtual_server.py +++ b/lib/ansible/modules/network/a10/a10_virtual_server.py @@ -38,24 +38,18 @@ options: version_added: "2.3" description: - set active-partition - required: false - default: null virtual_server: description: - The SLB (Server Load Balancing) virtual server name. required: true - default: null aliases: ['vip', 'virtual'] virtual_server_ip: description: - The SLB virtual server IPv4 address. - required: false - default: null aliases: ['ip', 'address'] virtual_server_status: description: - The SLB virtual server status, such as enabled or disabled. - required: false default: enable aliases: ['status'] choices: ['enabled', 'disabled'] @@ -65,14 +59,12 @@ options: dictionary which specifies the C(port:) and C(type:), but can also optionally specify the C(service_group:) as well as the C(status:). See the examples below for details. This parameter is required when C(state) is C(present). - required: false validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] ''' diff --git a/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py b/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py index 7fa46b8f23..e4bc884705 100644 --- a/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py +++ b/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py @@ -39,7 +39,6 @@ options: - The APIC defaults new Subject to Filter bindings to C(none). choices: [ log, none ] aliases: [ directive ] - default: none subject: description: - The name of the Contract Subject. diff --git a/lib/ansible/modules/network/aireos/aireos_command.py b/lib/ansible/modules/network/aireos/aireos_command.py index 12521be35b..e52cc5a1f4 100644 --- a/lib/ansible/modules/network/aireos/aireos_command.py +++ b/lib/ansible/modules/network/aireos/aireos_command.py @@ -41,8 +41,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] match: description: @@ -52,7 +50,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -61,7 +58,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -69,7 +65,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/aireos/aireos_config.py b/lib/ansible/modules/network/aireos/aireos_config.py index 2b62565e5f..f7b42a510e 100644 --- a/lib/ansible/modules/network/aireos/aireos_config.py +++ b/lib/ansible/modules/network/aireos/aireos_config.py @@ -30,8 +30,6 @@ options: in the device run-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] src: description: @@ -40,8 +38,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -49,16 +45,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -67,7 +59,6 @@ options: If match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'none'] backup: @@ -77,9 +68,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' running_config: description: - The module, by default, will connect to the remote device and @@ -89,17 +79,14 @@ options: every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null aliases: ['config'] save: description: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false - default: no type: bool + default: 'no' diff_against: description: - When using the C(ansible-playbook --diff) command line argument @@ -110,7 +97,6 @@ options: - When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. - required: false choices: ['intended', 'running'] diff_ignore_lines: description: @@ -118,7 +104,6 @@ options: ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. - required: false intended_config: description: - The C(intended_config) provides the master configuration that @@ -128,7 +113,6 @@ options: of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). - required: false """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/aruba/aruba_command.py b/lib/ansible/modules/network/aruba/aruba_command.py index 85d11df2a0..b6500c8955 100644 --- a/lib/ansible/modules/network/aruba/aruba_command.py +++ b/lib/ansible/modules/network/aruba/aruba_command.py @@ -41,8 +41,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] match: description: @@ -52,7 +50,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -61,7 +58,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -69,7 +65,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/aruba/aruba_config.py b/lib/ansible/modules/network/aruba/aruba_config.py index 7f69ff32ee..d9e8902641 100644 --- a/lib/ansible/modules/network/aruba/aruba_config.py +++ b/lib/ansible/modules/network/aruba/aruba_config.py @@ -31,8 +31,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -40,8 +38,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -49,8 +45,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -58,16 +52,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -78,7 +68,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -89,7 +78,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] backup: @@ -99,9 +87,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' running_config: description: - The module, by default, will connect to the remote device and @@ -111,8 +98,6 @@ options: every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null aliases: ['config'] save_when: description: @@ -127,7 +112,6 @@ options: I(never), the running-config will never be copied to the startup-config. If the argument is set to I(changed), then the running-config will only be copied to the startup-config if the task has made a change. - required: false default: never choices: ['always', 'never', 'modified', 'changed'] version_added: "2.5" @@ -143,7 +127,6 @@ options: - When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. - required: false choices: ['startup', 'intended', 'running'] diff_ignore_lines: description: @@ -151,7 +134,6 @@ options: ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. - required: false intended_config: description: - The C(intended_config) provides the master configuration that @@ -161,15 +143,14 @@ options: of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). - required: false encrypt: description: - This allows an Aruba controller's passwords and keys to be displayed in plain text when set to I(false) or encrypted when set to I(true). If set to I(false), the setting will re-encrypt at the end of the module run. Backups are still encrypted even when set to I(false). - required: false - default: true + type: bool + default: 'yes' version_added: "2.5" """ diff --git a/lib/ansible/modules/network/asa/asa_acl.py b/lib/ansible/modules/network/asa/asa_acl.py index 0a7c1fa6f7..75e4742e2b 100644 --- a/lib/ansible/modules/network/asa/asa_acl.py +++ b/lib/ansible/modules/network/asa/asa_acl.py @@ -38,16 +38,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a changed needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -56,7 +52,6 @@ options: match is set to I(strict), command lines are matched with respect to position. Finally if match is set to I(exact), command lines must be an equal match. - required: false default: line choices: ['line', 'strict', 'exact'] replace: @@ -67,7 +62,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] force: @@ -76,9 +70,8 @@ options: current devices running-config. When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured. - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' config: description: - The module, by default, will connect to the remote device and @@ -88,8 +81,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparison. - required: false - default: null """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/asa/asa_command.py b/lib/ansible/modules/network/asa/asa_command.py index 06b19c77f0..e98155e280 100644 --- a/lib/ansible/modules/network/asa/asa_command.py +++ b/lib/ansible/modules/network/asa/asa_command.py @@ -40,8 +40,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] match: description: @@ -51,7 +49,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -60,7 +57,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -68,7 +64,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/asa/asa_config.py b/lib/ansible/modules/network/asa/asa_config.py index 0b302eae3d..0a529d6133 100644 --- a/lib/ansible/modules/network/asa/asa_config.py +++ b/lib/ansible/modules/network/asa/asa_config.py @@ -32,8 +32,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -41,8 +39,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -50,8 +46,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -59,16 +53,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -79,7 +69,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -90,7 +79,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct - required: false default: line choices: ['line', 'block'] backup: @@ -100,43 +88,37 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' config: description: - The C(config) argument allows the playbook designer to supply the base configuration to be used to validate configuration changes necessary. If this argument is provided, the module will not download the running-config from the remote node. - required: false - default: null defaults: description: - This argument specifies whether or not to collect all defaults when getting the remote device running config. When enabled, the module will get the current config by issuing the command C(show running-config all). - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' passwords: description: - This argument specifies to include passwords in the config when retrieving the running-config from the remote device. This includes passwords related to VPN endpoints. This argument is mutually exclusive with I(defaults). - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' save: description: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/cloudengine/ce_aaa_server.py b/lib/ansible/modules/network/cloudengine/ce_aaa_server.py index e2952501c1..f7cb805fd5 100644 --- a/lib/ansible/modules/network/cloudengine/ce_aaa_server.py +++ b/lib/ansible/modules/network/cloudengine/ce_aaa_server.py @@ -33,69 +33,48 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present', 'absent'] authen_scheme_name: description: - Name of an authentication scheme. The value is a string of 1 to 32 characters. - required: false - default: null first_authen_mode: description: - Preferred authentication mode. - required: false - default: null choices: ['invalid', 'local', 'hwtacacs', 'radius', 'none'] author_scheme_name: description: - Name of an authorization scheme. The value is a string of 1 to 32 characters. - required: false - default: null first_author_mode: description: - Preferred authorization mode. - required: false - default: null choices: ['invalid', 'local', 'hwtacacs', 'if-authenticated', 'none'] acct_scheme_name: description: - Accounting scheme name. The value is a string of 1 to 32 characters. - required: false - default: null accounting_mode: description: - Accounting Mode. - required: false - default: null choices: ['invalid', 'hwtacacs', 'radius', 'none'] domain_name: description: - Name of a domain. The value is a string of 1 to 64 characters. - required: false - default: null radius_server_group: description: - RADIUS server group's name. The value is a string of 1 to 32 case-insensitive characters. - required: false - default: null hwtacas_template: description: - Name of a HWTACACS template. The value is a string of 1 to 32 case-insensitive characters. - required: false - default: null local_user_group: description: - Name of the user group where the user belongs. The user inherits all the rights of the user group. The value is a string of 1 to 32 characters. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py b/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py index db18711f39..7bb04568bc 100644 --- a/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py +++ b/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py @@ -33,138 +33,95 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present', 'absent'] local_user_name: description: - Name of a local user. The value is a string of 1 to 253 characters. - required: false - default: null local_password: description: - Login password of a user. The password can contain letters, numbers, and special characters. The value is a string of 1 to 255 characters. - required: false - default: null local_service_type: description: - The type of local user login through, such as ftp ssh snmp telnet. - required: false - default: null local_ftp_dir: description: - FTP user directory. The value is a string of 1 to 255 characters. - required: false - default: null local_user_level: description: - Login level of a local user. The value is an integer ranging from 0 to 15. - required: false - default: null local_user_group: description: - Name of the user group where the user belongs. The user inherits all the rights of the user group. The value is a string of 1 to 32 characters. - required: false - default: null radius_group_name: description: - RADIUS server group's name. The value is a string of 1 to 32 case-insensitive characters. - required: false - default: null radius_server_type: description: - Type of Radius Server. - required: false - default: null choices: ['Authentication', 'Accounting'] radius_server_ip: description: - IPv4 address of configured server. The value is a string of 0 to 255 characters, in dotted decimal notation. - required: false - default: null radius_server_ipv6: description: - IPv6 address of configured server. The total length is 128 bits. - required: false - default: null radius_server_port: description: - Configured server port for a particular server. The value is an integer ranging from 1 to 65535. - required: false - default: null radius_server_mode: description: - Configured primary or secondary server for a particular server. - required: false - default: null choices: ['Secondary-server', 'Primary-server'] radius_vpn_name: description: - Set VPN instance. The value is a string of 1 to 31 case-sensitive characters. - required: false - default: null radius_server_name: description: - Hostname of configured server. The value is a string of 0 to 255 case-sensitive characters. - required: false - default: null hwtacacs_template: description: - Name of a HWTACACS template. The value is a string of 1 to 32 case-insensitive characters. - required: false - default: null hwtacacs_server_ip: description: - Server IPv4 address. Must be a valid unicast IP address. The value is a string of 0 to 255 characters, in dotted decimal notation. - required: false - default: null hwtacacs_server_ipv6: description: - Server IPv6 address. Must be a valid unicast IP address. The total length is 128 bits. - required: false - default: null hwtacacs_server_type: description: - Hwtacacs server type. - required: false - default: null choices: ['Authentication', 'Authorization', 'Accounting', 'Common'] hwtacacs_is_secondary_server: description: - Whether the server is secondary. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' hwtacacs_vpn_name: description: - VPN instance name. - required: false - default: null hwtacacs_is_public_net: description: - Set the public-net. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' hwtacacs_server_host_name: description: - Hwtacacs server host name. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_acl.py b/lib/ansible/modules/network/cloudengine/ce_acl.py index 433c31c762..d28f45227a 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl.py @@ -33,7 +33,6 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent','delete_acl'] acl_name: @@ -47,84 +46,59 @@ options: description: - ACL number. The value is an integer ranging from 2000 to 2999. - required: false - default: null acl_step: description: - ACL step. The value is an integer ranging from 1 to 20. The default value is 5. - required: false - default: null acl_description: description: - ACL description. The value is a string of 1 to 127 characters. - required: false - default: null rule_name: description: - Name of a basic ACL rule. The value is a string of 1 to 32 characters. The value is case-insensitive, and cannot contain spaces or begin with an underscore (_). - required: false - default: null rule_id: description: - ID of a basic ACL rule in configuration mode. The value is an integer ranging from 0 to 4294967294. - required: false - default: null rule_action: description: - Matching mode of basic ACL rules. - required: false - default: null choices: ['permit','deny'] source_ip: description: - Source IP address. The value is a string of 0 to 255 characters.The default value is 0.0.0.0. The value is in dotted decimal notation. - required: false - default: null src_mask: description: - Mask of a source IP address. The value is an integer ranging from 1 to 32. - required: false - default: null frag_type: description: - Type of packet fragmentation. - required: false - default: null choices: ['fragment', 'clear_fragment'] vrf_name: description: - VPN instance name. The value is a string of 1 to 31 characters.The default value is _public_. - required: false - default: null time_range: description: - Name of a time range in which an ACL rule takes effect. The value is a string of 1 to 32 characters. The value is case-insensitive, and cannot contain spaces. The name must start with an uppercase or lowercase letter. In addition, the word "all" cannot be specified as a time range name. - required: false - default: null rule_description: description: - Description about an ACL rule. The value is a string of 1 to 127 characters. - required: false - default: null log_flag: description: - Flag of logging matched data packets. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_acl_advance.py b/lib/ansible/modules/network/cloudengine/ce_acl_advance.py index 76678f347a..44afb57480 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl_advance.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl_advance.py @@ -47,159 +47,107 @@ options: description: - ACL number. The value is an integer ranging from 3000 to 3999. - required: false - default: null acl_step: description: - ACL step. The value is an integer ranging from 1 to 20. The default value is 5. - required: false - default: null acl_description: description: - ACL description. The value is a string of 1 to 127 characters. - required: false - default: null rule_name: description: - Name of a basic ACL rule. The value is a string of 1 to 32 characters. - required: false - default: null rule_id: description: - ID of a basic ACL rule in configuration mode. The value is an integer ranging from 0 to 4294967294. - required: false - default: null rule_action: description: - Matching mode of basic ACL rules. - required: false - default: null choices: ['permit','deny'] protocol: description: - Protocol type. - required: false - default: null choices: ['ip', 'icmp', 'igmp', 'ipinip', 'tcp', 'udp', 'gre', 'ospf'] source_ip: description: - Source IP address. The value is a string of 0 to 255 characters.The default value is 0.0.0.0. The value is in dotted decimal notation. - required: false - default: null src_mask: description: - Source IP address mask. The value is an integer ranging from 1 to 32. - required: false - default: null src_pool_name: description: - Name of a source pool. The value is a string of 1 to 32 characters. - required: false - default: null dest_ip: description: - Destination IP address. The value is a string of 0 to 255 characters.The default value is 0.0.0.0. The value is in dotted decimal notation. - required: false - default: null dest_mask: description: - Destination IP address mask. The value is an integer ranging from 1 to 32. - required: false - default: null dest_pool_name: description: - Name of a destination pool. The value is a string of 1 to 32 characters. - required: false - default: null src_port_op: description: - Range type of the source port. - required: false - default: null choices: ['lt','eq', 'gt', 'range'] src_port_begin: description: - Start port number of the source port. The value is an integer ranging from 0 to 65535. - required: false - default: null src_port_end: description: - End port number of the source port. The value is an integer ranging from 0 to 65535. - required: false - default: null src_port_pool_name: description: - Name of a source port pool. The value is a string of 1 to 32 characters. - required: false - default: null dest_port_op: description: - Range type of the destination port. - required: false - default: null choices: ['lt','eq', 'gt', 'range'] dest_port_begin: description: - Start port number of the destination port. The value is an integer ranging from 0 to 65535. - required: false - default: null dest_port_end: description: - End port number of the destination port. The value is an integer ranging from 0 to 65535. - required: false - default: null dest_port_pool_name: description: - Name of a destination port pool. The value is a string of 1 to 32 characters. - required: false - default: null frag_type: description: - Type of packet fragmentation. - required: false - default: null choices: ['fragment', 'clear_fragment'] precedence: description: - Data packets can be filtered based on the priority field. The value is an integer ranging from 0 to 7. - required: false - default: null tos: description: - ToS value on which data packet filtering is based. The value is an integer ranging from 0 to 15. - required: false - default: null dscp: description: - Differentiated Services Code Point. The value is an integer ranging from 0 to 63. - required: false - default: null icmp_name: description: - ICMP name. - required: false - default: null choices: ['unconfiged', 'echo', 'echo-reply', 'fragmentneed-DFset', 'host-redirect', 'host-tos-redirect', 'host-unreachable', 'information-reply', 'information-request', 'net-redirect', 'net-tos-redirect', 'net-unreachable', 'parameter-problem', @@ -210,67 +158,48 @@ options: description: - ICMP type. This parameter is available only when the packet protocol is ICMP. The value is an integer ranging from 0 to 255. - required: false - default: null icmp_code: description: - ICMP message code. Data packets can be filtered based on the ICMP message code. The value is an integer ranging from 0 to 255. - required: false - default: null ttl_expired: description: - Whether TTL Expired is matched, with the TTL value of 1. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' vrf_name: description: - VPN instance name. The value is a string of 1 to 31 characters.The default value is _public_. - required: false - default: null syn_flag: description: - TCP flag value. The value is an integer ranging from 0 to 63. - required: false - default: null tcp_flag_mask: description: - TCP flag mask value. The value is an integer ranging from 0 to 63. - required: false - default: null established: description: - Match established connections. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' time_range: description: - Name of a time range in which an ACL rule takes effect. - required: false - default: null rule_description: description: - Description about an ACL rule. - required: false - default: null igmp_type: description: - Internet Group Management Protocol. - required: false - default: null choices: ['host-query', 'mrouter-adver', 'mrouter-solic', 'mrouter-termi', 'mtrace-resp', 'mtrace-route', 'v1host-report', 'v2host-report', 'v2leave-group', 'v3host-report'] log_flag: description: - Flag of logging matched data packets. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_global.py b/lib/ansible/modules/network/cloudengine/ce_bfd_global.py index 76584086a0..3629b299eb 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_global.py @@ -32,61 +32,44 @@ options: bfd_enable: description: - Enables the global Bidirectional Forwarding Detection (BFD) function. - required: false - default: null choices: ['enable', 'disable'] default_ip: description: - Specifies the default multicast IP address. The value ranges from 224.0.0.107 to 224.0.0.250. - required: false - default: null tos_exp_dynamic: description: - Indicates the priority of BFD control packets for dynamic BFD sessions. The value is an integer ranging from 0 to 7. The default priority is 7, which is the highest priority of BFD control packets. - required: false - default: null tos_exp_static: description: - Indicates the priority of BFD control packets for static BFD sessions. The value is an integer ranging from 0 to 7. The default priority is 7, which is the highest priority of BFD control packets. - required: false - default: null damp_init_wait_time: description: - Specifies an initial flapping suppression time for a BFD session. The value is an integer ranging from 1 to 3600000, in milliseconds. The default value is 2000. - required: false - default: null damp_max_wait_time: description: - Specifies a maximum flapping suppression time for a BFD session. The value is an integer ranging from 1 to 3600000, in milliseconds. The default value is 15000. - required: false - default: null damp_second_wait_time: description: - Specifies a secondary flapping suppression time for a BFD session. The value is an integer ranging from 1 to 3600000, in milliseconds. The default value is 5000. - required: false - default: null delay_up_time: description: - Specifies the delay before a BFD session becomes Up. The value is an integer ranging from 1 to 600, in seconds. The default value is 0, indicating that a BFD session immediately becomes Up. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_session.py b/lib/ansible/modules/network/cloudengine/ce_bfd_session.py index 8f06e420ba..3dbe6f03bb 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_session.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_session.py @@ -35,55 +35,41 @@ options: - Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces. required: true - default: null create_type: description: - BFD session creation mode, the currently created BFD session only supports static or static auto-negotiation mode. - required: false - default: null choices: ['static', 'auto'] addr_type: description: - Specifies the peer IP address type. - required: false - default: null choices: ['ipv4'] out_if_name: description: - Specifies the type and number of the interface bound to the BFD session. - required: false - default: null dest_addr: description: - Specifies the peer IP address bound to the BFD session. - required: false - default: null src_addr: description: - Indicates the source IP address carried in BFD packets. - required: false - default: null vrf_name: description: - Specifies the name of a Virtual Private Network (VPN) instance that is bound to a BFD session. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value _public_ is reserved and cannot be used as the VPN instance name. - required: false - default: null use_default_ip: description: - Indicates the default multicast IP address that is bound to a BFD session. By default, BFD uses the multicast IP address 224.0.0.184. You can set the multicast IP address by running the default-ip-address command. The value is a bool type. - required: false - default: false + type: bool + default: 'no' state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_view.py b/lib/ansible/modules/network/cloudengine/ce_bfd_view.py index b7d1f3563d..5bb40ab128 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_view.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_view.py @@ -34,70 +34,53 @@ options: - Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces. required: true - default: null local_discr: description: - Specifies the local discriminator of a BFD session. The value is an integer that ranges from 1 to 16384. - required: false - default: null remote_discr: description: - Specifies the remote discriminator of a BFD session. The value is an integer that ranges from 1 to 4294967295. - required: false - default: null min_tx_interval: description: - Specifies the minimum interval for receiving BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds. - required: false - default: null min_rx_interval: description: - Specifies the minimum interval for sending BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds. - required: false - default: null detect_multi: description: - Specifies the local detection multiplier of a BFD session. The value is an integer that ranges from 3 to 50. - required: false - default: null wtr_interval: description: - Specifies the WTR time of a BFD session. The value is an integer that ranges from 1 to 60, in minutes. The default value is 0. - required: false - default: null tos_exp: description: - Specifies a priority for BFD control packets. The value is an integer ranging from 0 to 7. The default value is 7, which is the highest priority. - required: false - default: null admin_down: description: - Enables the BFD session to enter the AdminDown state. By default, a BFD session is enabled. The default value is bool type. - required: false - default: false + type: bool + default: 'no' description: description: - Specifies the description of a BFD session. The value is a string of 1 to 51 case-sensitive characters with spaces. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] +extends_documentation_fragment: ce """ EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp.py b/lib/ansible/modules/network/cloudengine/ce_bgp.py index 9ae43ba34e..96bdc48692 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp.py @@ -33,54 +33,41 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] as_number: description: - Local AS number. The value is a string of 1 to 11 characters. - required: false - default: null graceful_restart: description: - Enable GR of the BGP speaker in the specified address family, peer address, or peer group. - required: false default: no_use choices: ['no_use','true','false'] time_wait_for_rib: description: - Period of waiting for the End-Of-RIB flag. The value is an integer ranging from 3 to 3000. The default value is 600. - required: false - default: null as_path_limit: description: - Maximum number of AS numbers in the AS_Path attribute. The default value is 255. - required: false - default: null check_first_as: description: - Check the first AS in the AS_Path of the update messages from EBGP peers. - required: false default: no_use choices: ['no_use','true','false'] confed_id_number: description: - Confederation ID. The value is a string of 1 to 11 characters. - required: false - default: null confed_nonstanded: description: - Configure the device to be compatible with devices in a nonstandard confederation. - required: false default: no_use choices: ['no_use','true','false'] bgp_rid_auto_sel: description: - The function to automatically select router IDs for all VPN BGP instances is enabled. - required: false default: no_use choices: ['no_use','true','false'] keep_all_routes: @@ -89,101 +76,73 @@ options: BGP connection setup. If the value is false, the system stores only BGP update messages that are received from peers and pass the configured import policy. - required: false default: no_use choices: ['no_use','true','false'] memory_limit: description: - Support BGP RIB memory protection. - required: false default: no_use choices: ['no_use','true','false'] gr_peer_reset: description: - Peer disconnection through GR. - required: false default: no_use choices: ['no_use','true','false'] is_shutdown: description: - Interrupt BGP all neighbor. - required: false default: no_use choices: ['no_use','true','false'] suppress_interval: description: - Suppress interval. - required: false - default: null hold_interval: description: - Hold interval. - required: false - default: null clear_interval: description: - Clear interval. - required: false - default: null confed_peer_as_num: description: - Confederation AS number, in two-byte or four-byte format. The value is a string of 1 to 11 characters. - required: false - default: null vrf_name: description: - Name of a BGP instance. The name is a case-sensitive string of characters. - required: false - default: null vrf_rid_auto_sel: description: - If the value is true, VPN BGP instances are enabled to automatically select router IDs. If the value is false, VPN BGP instances are disabled from automatically selecting router IDs. - required: false default: no_use choices: ['no_use','true','false'] router_id: description: - ID of a router that is in IPv4 address format. - required: false - default: null keepalive_time: description: - If the value of a timer changes, the BGP peer relationship between the routers is disconnected. The value is an integer ranging from 0 to 21845. The default value is 60. - required: false - default: null hold_time: description: - Hold time, in seconds. The value of the hold time can be 0 or range from 3 to 65535. - required: false - default: null min_hold_time: description: - Min hold time, in seconds. The value of the hold time can be 0 or range from 20 to 65535. - required: false - default: null conn_retry_time: description: - ConnectRetry interval. The value is an integer, in seconds. The default value is 32s. - required: false - default: null ebgp_if_sensitive: description: - If the value is true, After the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are deleted immediately when the interface goes Down. If the value is false, After the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are not deleted immediately when the interface goes Down. - required: false default: no_use choices: ['no_use','true','false'] default_af_type: description: - Type of a created address family, which can be IPv4 unicast or IPv6 unicast. The default type is IPv4 unicast. - required: false - default: null choices: ['ipv4uni','ipv6uni'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp_af.py b/lib/ansible/modules/network/cloudengine/ce_bgp_af.py index 01508ce929..c9855cd675 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_af.py @@ -33,7 +33,6 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] vrf_name: @@ -51,64 +50,50 @@ options: description: - Specify the maximum number of equal-cost IBGP routes. The value is an integer ranging from 1 to 65535. - required: false - default: null ibgp_ecmp_nexthop_changed: description: - If the value is true, the next hop of an advertised route is changed to the advertiser itself in IBGP load-balancing scenarios. If the value is false, the next hop of an advertised route is not changed to the advertiser itself in IBGP load-balancing scenarios. - required: false choices: ['no_use','true','false'] default: no_use max_load_ebgp_num: description: - Specify the maximum number of equal-cost EBGP routes. The value is an integer ranging from 1 to 65535. - required: false - default: null ebgp_ecmp_nexthop_changed: description: - If the value is true, the next hop of an advertised route is changed to the advertiser itself in EBGP load-balancing scenarios. If the value is false, the next hop of an advertised route is not changed to the advertiser itself in EBGP load-balancing scenarios. - required: false choices: ['no_use','true','false'] default: no_use maximum_load_balance: description: - Specify the maximum number of equal-cost routes in the BGP routing table. The value is an integer ranging from 1 to 65535. - required: false - default: null ecmp_nexthop_changed: description: - If the value is true, the next hop of an advertised route is changed to the advertiser itself in BGP load-balancing scenarios. If the value is false, the next hop of an advertised route is not changed to the advertiser itself in BGP load-balancing scenarios. - required: false choices: ['no_use','true','false'] default: no_use default_local_pref: description: - Set the Local-Preference attribute. The value is an integer. The value is an integer ranging from 0 to 4294967295. - required: false - default: null default_med: description: - Specify the Multi-Exit-Discriminator (MED) of BGP routes. The value is an integer ranging from 0 to 4294967295. - required: false - default: null default_rt_import_enable: description: - If the value is true, importing default routes to the BGP routing table is allowed. If the value is false, importing default routes to the BGP routing table is not allowed. - required: false choices: ['no_use','true','false'] default: no_use router_id: @@ -116,60 +101,49 @@ options: - ID of a router that is in IPv4 address format. The value is a string of 0 to 255 characters. The value is in dotted decimal notation. - required: false - default: null vrf_rid_auto_sel: description: - If the value is true, VPN BGP instances are enabled to automatically select router IDs. If the value is false, VPN BGP instances are disabled from automatically selecting router IDs. - required: false choices: ['no_use','true','false'] default: no_use nexthop_third_party: description: - If the value is true, the third-party next hop function is enabled. If the value is false, the third-party next hop function is disabled. - required: false choices: ['no_use','true','false'] default: no_use summary_automatic: description: - If the value is true, automatic aggregation is enabled for locally imported routes. If the value is false, automatic aggregation is disabled for locally imported routes. - required: false choices: ['no_use','true','false'] default: no_use auto_frr_enable: description: - If the value is true, BGP auto FRR is enabled. If the value is false, BGP auto FRR is disabled. - required: false choices: ['no_use','true','false'] default: no_use load_balancing_as_path_ignore: description: - Load balancing as path ignore. - required: false choices: ['no_use','true','false'] default: no_use rib_only_enable: description: - If the value is true, BGP routes cannot be advertised to the IP routing table. If the value is false, Routes preferred by BGP are advertised to the IP routing table. - required: false choices: ['no_use','true','false'] default: no_use rib_only_policy_name: description: - Specify the name of a routing policy. The value is a string of 1 to 40 characters. - required: false - default: null active_route_advertise: description: - If the value is true, BGP is enabled to advertise only optimal routes in the RM to peers. If the value is false, BGP is not enabled to advertise only optimal routes in the RM to peers. - required: false choices: ['no_use','true','false'] default: no_use as_path_neglect: @@ -177,7 +151,6 @@ options: - If the value is true, the AS path attribute is ignored when BGP selects an optimal route. If the value is false, the AS path attribute is not ignored when BGP selects an optimal route. An AS path with a smaller length has a higher priority. - required: false choices: ['no_use','true','false'] default: no_use med_none_as_maximum: @@ -186,14 +159,12 @@ options: MED value of a route if the route's attribute does not carry a MED value. If the value is false, the system uses 0 as the MED value of a route if the route's attribute does not carry a MED value. - required: false choices: ['no_use','true','false'] default: no_use router_id_neglect: description: - If the value is true, the router ID attribute is ignored when BGP selects the optimal route. If the value is false, the router ID attribute is not ignored when BGP selects the optimal route. - required: false choices: ['no_use','true','false'] default: no_use igp_metric_ignore: @@ -203,7 +174,6 @@ options: If the value is false, the metrics of next-hop IGP routes are not compared when BGP selects an optimal route. A route with a smaller metric has a higher priority. - required: false choices: ['no_use','true','false'] default: no_use always_compare_med: @@ -212,91 +182,69 @@ options: are compared when BGP selects an optimal route. If the value is false, the MEDs of routes learned from peers in different autonomous systems are not compared when BGP selects an optimal route. - required: false choices: ['no_use','true','false'] default: no_use determin_med: description: - If the value is true, BGP deterministic-MED is enabled. If the value is false, BGP deterministic-MED is disabled. - required: false choices: ['no_use','true','false'] default: no_use preference_external: description: - Set the protocol priority of EBGP routes. The value is an integer ranging from 1 to 255. - required: false - default: null preference_internal: description: - Set the protocol priority of IBGP routes. The value is an integer ranging from 1 to 255. - required: false - default: null preference_local: description: - Set the protocol priority of a local BGP route. The value is an integer ranging from 1 to 255. - required: false - default: null prefrence_policy_name: description: - Set a routing policy to filter routes so that a configured priority is applied to the routes that match the specified policy. The value is a string of 1 to 40 characters. - required: false - default: null reflect_between_client: description: - If the value is true, route reflection is enabled between clients. If the value is false, route reflection is disabled between clients. - required: false choices: ['no_use','true','false'] default: no_use reflector_cluster_id: description: - Set a cluster ID. Configuring multiple RRs in a cluster can enhance the stability of the network. The value is an integer ranging from 1 to 4294967295. - required: false - default: null reflector_cluster_ipv4: description: - Set a cluster ipv4 address. The value is expressed in the format of an IPv4 address. - required: false - default: null rr_filter_number: description: - Set the number of the extended community filter supported by an RR group. The value is a string of 1 to 51 characters. - required: false - default: null policy_vpn_target: description: - If the value is true, VPN-Target filtering function is performed for received VPN routes. If the value is false, VPN-Target filtering function is not performed for received VPN routes. - required: false choices: ['no_use','true','false'] default: no_use next_hop_sel_depend_type: description: - Next hop select depend type. - required: false choices: ['default','dependTunnel', 'dependIp'] default: default nhp_relay_route_policy_name: description: - Specify the name of a route-policy for route iteration. The value is a string of 1 to 40 characters. - required: false - default: null ebgp_if_sensitive: description: - If the value is true, after the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are deleted immediately when the interface goes Down. If the value is false, after the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are not deleted immediately when the interface goes Down. - required: false choices: ['no_use','true','false'] default: no_use reflect_chg_path: @@ -305,99 +253,77 @@ options: based on an export policy. If the value is false, the route reflector is disabled from modifying route path attributes based on an export policy. - required: false choices: ['no_use','true','false'] default: no_use add_path_sel_num: description: - Number of Add-Path routes. The value is an integer ranging from 2 to 64. - required: false - default: null route_sel_delay: description: - Route selection delay. The value is an integer ranging from 0 to 3600. - required: false - default: null allow_invalid_as: description: - Allow routes with BGP origin AS validation result Invalid to be selected. If the value is true, invalid routes can participate in route selection. If the value is false, invalid routes cannot participate in route selection. - required: false choices: ['no_use','true','false'] default: no_use policy_ext_comm_enable: description: - If the value is true, modifying extended community attributes is allowed. If the value is false, modifying extended community attributes is not allowed. - required: false choices: ['no_use','true','false'] default: no_use supernet_uni_adv: description: - If the value is true, the function to advertise supernetwork unicast routes is enabled. If the value is false, the function to advertise supernetwork unicast routes is disabled. - required: false choices: ['no_use','true','false'] default: no_use supernet_label_adv: description: - If the value is true, the function to advertise supernetwork label is enabled. If the value is false, the function to advertise supernetwork label is disabled. - required: false choices: ['no_use','true','false'] default: no_use ingress_lsp_policy_name: description: - Ingress lsp policy name. - required: false - default: null originator_prior: description: - Originator prior. - required: false choices: ['no_use','true','false'] default: no_use lowest_priority: description: - If the value is true, enable reduce priority to advertise route. If the value is false, disable reduce priority to advertise route. - required: false choices: ['no_use','true','false'] default: no_use relay_delay_enable: description: - If the value is true, relay delay enable. If the value is false, relay delay disable. - required: false choices: ['no_use','true','false'] default: no_use import_protocol: description: - Routing protocol from which routes can be imported. - required: false choices: ['direct', 'ospf', 'isis', 'static', 'rip', 'ospfv3', 'ripng'] - default: null import_process_id: description: - Process ID of an imported routing protocol. The value is an integer ranging from 0 to 4294967295. - required: false - default: null network_address: description: - Specify the IP address advertised by BGP. The value is a string of 0 to 255 characters. - required: false - default: null mask_len: description: - Specify the mask length of an IP address. The value is an integer ranging from 0 to 128. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py index 604eb9e5f6..202281884d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py @@ -33,7 +33,6 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] vrf_name: @@ -54,33 +53,26 @@ options: description: - Description of a peer, which can be letters or digits. The value is a string of 1 to 80 characters. - required: false - default: null fake_as: description: - Fake AS number that is specified for a local peer. The value is a string of 1 to 11 characters. - required: false - default: null dual_as: description: - If the value is true, the EBGP peer can use either a fake AS number or the actual AS number. If the value is false, the EBGP peer can only use a fake AS number. - required: false choices: ['no_use','true','false'] default: no_use conventional: description: - If the value is true, the router has all extended capabilities. If the value is false, the router does not have all extended capabilities. - required: false choices: ['no_use','true','false'] default: no_use route_refresh: description: - If the value is true, BGP is enabled to advertise REFRESH packets. If the value is false, the route refresh function is enabled. - required: false choices: ['no_use','true','false'] default: no_use is_ignore: @@ -88,146 +80,108 @@ options: - If the value is true, the session with a specified peer is torn down and all related routing entries are cleared. If the value is false, the session with a specified peer is retained. - required: false choices: ['no_use','true','false'] default: no_use local_if_name: description: - Name of a source interface that sends BGP packets. The value is a string of 1 to 63 characters. - required: false - default: null ebgp_max_hop: description: - Maximum number of hops in an indirect EBGP connection. The value is an ranging from 1 to 255. - required: false - default: null valid_ttl_hops: description: - Enable GTSM on a peer or peer group. The valid-TTL-Value parameter is used to specify the number of TTL hops to be detected. The value is an integer ranging from 1 to 255. - required: false - default: null connect_mode: description: - The value can be Connect-only, Listen-only, or Both. - required: false - default: null is_log_change: description: - If the value is true, BGP is enabled to record peer session status and event information. If the value is false, BGP is disabled from recording peer session status and event information. - required: false choices: ['no_use','true','false'] default: no_use pswd_type: description: - Enable BGP peers to establish a TCP connection and perform the Message Digest 5 (MD5) authentication for BGP messages. - required: false choices: ['null','cipher','simple'] - default: null pswd_cipher_text: description: - The character string in a password identifies the contents of the password, spaces not supported. The value is a string of 1 to 255 characters. - required: false - default: null keep_alive_time: description: - Specify the Keepalive time of a peer or peer group. The value is an integer ranging from 0 to 21845. The default value is 60. - required: false - default: null hold_time: description: - Specify the Hold time of a peer or peer group. The value is 0 or an integer ranging from 3 to 65535. - required: false - default: null min_hold_time: description: - Specify the Min hold time of a peer or peer group. - required: false - default: null key_chain_name: description: - Specify the Keychain authentication name used when BGP peers establish a TCP connection. The value is a string of 1 to 47 case-insensitive characters. - required: false - default: null conn_retry_time: description: - ConnectRetry interval. The value is an integer ranging from 1 to 65535. - required: false - default: null tcp_MSS: description: - Maximum TCP MSS value used for TCP connection establishment for a peer. The value is an integer ranging from 176 to 4096. - required: false - default: null mpls_local_ifnet_disable: description: - If the value is true, peer create MPLS Local IFNET disable. If the value is false, peer create MPLS Local IFNET enable. - required: false choices: ['no_use','true','false'] default: no_use prepend_global_as: description: - Add the global AS number to the Update packets to be advertised. - required: false choices: ['no_use','true','false'] default: no_use prepend_fake_as: description: - Add the Fake AS number to received Update packets. - required: false choices: ['no_use','true','false'] default: no_use is_bfd_block: description: - If the value is true, peers are enabled to inherit the BFD function from the peer group. If the value is false, peers are disabled to inherit the BFD function from the peer group. - required: false choices: ['no_use','true','false'] default: no_use multiplier: description: - Specify the detection multiplier. The default value is 3. The value is an integer ranging from 3 to 50. - required: false - default: null is_bfd_enable: description: - If the value is true, BFD is enabled. If the value is false, BFD is disabled. - required: false choices: ['no_use','true','false'] default: no_use rx_interval: description: - Specify the minimum interval at which BFD packets are received. The value is an integer ranging from 50 to 1000, in milliseconds. - required: false - default: null tx_interval: description: - Specify the minimum interval at which BFD packets are sent. The value is an integer ranging from 50 to 1000, in milliseconds. - required: false - default: null is_single_hop: description: - If the value is true, the system is enabled to preferentially use the single-hop mode for BFD session setup between IBGP peers. If the value is false, the system is disabled from preferentially using the single-hop mode for BFD session setup between IBGP peers. - required: false choices: ['no_use','true','false'] default: no_use ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py index e46419f11f..0e2cb70b60 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py @@ -48,64 +48,54 @@ options: description: - If the value is true, advertised IRB routes are distinguished. If the value is false, advertised IRB routes are not distinguished. - required: false default: no_use choices: ['no_use','true','false'] advertise_arp: description: - If the value is true, advertised ARP routes are distinguished. If the value is false, advertised ARP routes are not distinguished. - required: false default: no_use choices: ['no_use','true','false'] advertise_remote_nexthop: description: - If the value is true, the remote next-hop attribute is advertised to peers. If the value is false, the remote next-hop attribute is not advertised to any peers. - required: false default: no_use choices: ['no_use','true','false'] advertise_community: description: - If the value is true, the community attribute is advertised to peers. If the value is false, the community attribute is not advertised to peers. - required: false default: no_use choices: ['no_use','true','false'] advertise_ext_community: description: - If the value is true, the extended community attribute is advertised to peers. If the value is false, the extended community attribute is not advertised to peers. - required: false default: no_use choices: ['no_use','true','false'] discard_ext_community: description: - If the value is true, the extended community attribute in the peer route information is discarded. If the value is false, the extended community attribute in the peer route information is not discarded. - required: false default: no_use choices: ['no_use','true','false'] allow_as_loop_enable: description: - If the value is true, repetitive local AS numbers are allowed. If the value is false, repetitive local AS numbers are not allowed. - required: false default: no_use choices: ['no_use','true','false'] allow_as_loop_limit: description: - Set the maximum number of repetitive local AS number. The value is an integer ranging from 1 to 10. - required: false - default: null keep_all_routes: description: - If the value is true, the system stores all route update messages received from all peers (groups) after BGP connection setup. If the value is false, the system stores only BGP update messages that are received from peers and pass the configured import policy. - required: false default: no_use choices: ['no_use','true','false'] nexthop_configure: @@ -114,21 +104,16 @@ options: local, The next hop is changed to the local IP address. invariable, Prevent the device from changing the next hop of each imported IGP route when advertising it to its BGP peers. - required: false - default: null choices: ['null', 'local', 'invariable'] preferred_value: description: - Assign a preferred value for the routes learned from a specified peer. The value is an integer ranging from 0 to 65535. - required: false - default: null public_as_only: description: - If the value is true, sent BGP update messages carry only the public AS number but do not carry private AS numbers. If the value is false, sent BGP update messages can carry private AS numbers. - required: false default: no_use choices: ['no_use','true','false'] public_as_only_force: @@ -136,39 +121,31 @@ options: - If the value is true, sent BGP update messages carry only the public AS number but do not carry private AS numbers. If the value is false, sent BGP update messages can carry private AS numbers. - required: false default: no_use choices: ['no_use','true','false'] public_as_only_limited: description: - Limited use public as number. - required: false default: no_use choices: ['no_use','true','false'] public_as_only_replace: description: - Private as replaced by public as number. - required: false default: no_use choices: ['no_use','true','false'] public_as_only_skip_peer_as: description: - Public as only skip peer as. - required: false default: no_use choices: ['no_use','true','false'] route_limit: description: - Configure the maximum number of routes that can be accepted from a peer. The value is an integer ranging from 1 to 4294967295. - required: false - default: null route_limit_percent: description: - Specify the percentage of routes when a router starts to generate an alarm. The value is an integer ranging from 1 to 100. - required: false - default: null route_limit_type: description: - Noparameter, After the number of received routes exceeds the threshold and the timeout @@ -179,32 +156,24 @@ options: maximum number of routes allowed have been received. IdleTimeout, After the number of received routes exceeds the threshold and the timeout timer expires, the connection that is interrupted is automatically re-established. - required: false - default: null choices: ['noparameter', 'alertOnly', 'idleForever', 'idleTimeout'] route_limit_idle_timeout: description: - Specify the value of the idle-timeout timer to automatically reestablish the connections after they are cut off when the number of routes exceeds the set threshold. The value is an integer ranging from 1 to 1200. - required: false - default: null rt_updt_interval: description: - Specify the minimum interval at which Update packets are sent. The value is an integer, in seconds. The value is an integer ranging from 0 to 600. - required: false - default: null redirect_ip: description: - Redirect ip. - required: false default: no_use choices: ['no_use','true','false'] redirect_ip_vaildation: description: - Redirect ip vaildation. - required: false default: no_use choices: ['no_use','true','false'] reflect_client: @@ -212,7 +181,6 @@ options: - If the value is true, the local device functions as the route reflector and a peer functions as a client of the route reflector. If the value is false, the route reflector and client functions are not configured. - required: false default: no_use choices: ['no_use','true','false'] substitute_as_enable: @@ -221,89 +189,64 @@ options: the local AS number is enabled. If the value is false, the function to replace a specified peer's AS number in the AS-Path attribute with the local AS number is disabled. - required: false default: no_use choices: ['no_use','true','false'] import_rt_policy_name: description: - Specify the filtering policy applied to the routes learned from a peer. The value is a string of 1 to 40 characters. - required: false - default: null export_rt_policy_name: description: - Specify the filtering policy applied to the routes to be advertised to a peer. The value is a string of 1 to 40 characters. - required: false - default: null import_pref_filt_name: description: - Specify the IPv4 filtering policy applied to the routes received from a specified peer. The value is a string of 1 to 169 characters. - required: false - default: null export_pref_filt_name: description: - Specify the IPv4 filtering policy applied to the routes to be advertised to a specified peer. The value is a string of 1 to 169 characters. - required: false - default: null import_as_path_filter: description: - Apply an AS_Path-based filtering policy to the routes received from a specified peer. The value is an integer ranging from 1 to 256. - required: false - default: null export_as_path_filter: description: - Apply an AS_Path-based filtering policy to the routes to be advertised to a specified peer. The value is an integer ranging from 1 to 256. - required: false - default: null import_as_path_name_or_num: description: - A routing strategy based on the AS path list for routing received by a designated peer. - required: false - default: null export_as_path_name_or_num: description: - Application of a AS path list based filtering policy to the routing of a specified peer. - required: false - default: null import_acl_name_or_num: description: - Apply an IPv4 ACL-based filtering policy to the routes received from a specified peer. The value is a string of 1 to 32 characters. - required: false - default: null export_acl_name_or_num: description: - Apply an IPv4 ACL-based filtering policy to the routes to be advertised to a specified peer. The value is a string of 1 to 32 characters. - required: false - default: null ipprefix_orf_enable: description: - If the value is true, the address prefix-based Outbound Route Filter (ORF) capability is enabled for peers. If the value is false, the address prefix-based Outbound Route Filter (ORF) capability is disabled for peers. - required: false default: no_use choices: ['no_use','true','false'] is_nonstd_ipprefix_mod: description: - If the value is true, Non-standard capability codes are used during capability negotiation. If the value is false, RFC-defined standard ORF capability codes are used during capability negotiation. - required: false default: no_use choices: ['no_use','true','false'] orftype: description: - ORF Type. The value is an integer ranging from 0 to 65535. - required: false - default: null orf_mode: description: - ORF mode. @@ -311,35 +254,26 @@ options: receive, ORF for incoming packets. send, ORF for outgoing packets. both, ORF for incoming and outgoing packets. - required: false - default: null choices: ['null', 'receive', 'send', 'both'] soostring: description: - Configure the Site-of-Origin (SoO) extended community attribute. The value is a string of 3 to 21 characters. - required: false - default: null default_rt_adv_enable: description: - If the value is true, the function to advertise default routes to peers is enabled. If the value is false, the function to advertise default routes to peers is disabled. - required: false default: no_use choices: ['no_use','true', 'false'] default_rt_adv_policy: description: - Specify the name of a used policy. The value is a string. The value is a string of 1 to 40 characters. - required: false - default: null default_rt_match_mode: description: - null, Null. matchall, Advertise the default route if all matching conditions are met. matchany, Advertise the default route if any matching condition is met. - required: false - default: null choices: ['null', 'matchall', 'matchany'] add_path_mode: description: @@ -347,34 +281,27 @@ options: receive, Support receiving Add-Path routes. send, Support sending Add-Path routes. both, Support receiving and sending Add-Path routes. - required: false - default: null choices: ['null', 'receive', 'send', 'both'] adv_add_path_num: description: - The number of addPath advertise route. The value is an integer ranging from 2 to 64. - required: false - default: null origin_as_valid: description: - If the value is true, Application results of route announcement. If the value is false, Routing application results are not notified. - required: false default: no_use choices: ['no_use','true', 'false'] vpls_enable: description: - If the value is true, vpls enable. If the value is false, vpls disable. - required: false default: no_use choices: ['no_use','true', 'false'] vpls_ad_disable: description: - If the value is true, enable vpls-ad. If the value is false, disable vpls-ad. - required: false default: no_use choices: ['no_use','true', 'false'] update_pkt_standard_compatible: @@ -383,7 +310,6 @@ options: the message has no label. If the value is false, When the vpnv4 multicast neighbor receives and updates the message, the message has label. - required: false default: no_use choices: ['no_use','true', 'false'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_command.py b/lib/ansible/modules/network/cloudengine/ce_command.py index 402edd3cbb..daf8e2f90d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_command.py +++ b/lib/ansible/modules/network/cloudengine/ce_command.py @@ -50,8 +50,6 @@ options: the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples. - required: false - default: null match: description: - The I(match) argument is used in conjunction with the @@ -60,7 +58,6 @@ options: then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all retries: description: @@ -68,7 +65,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. - required: false default: 10 interval: description: @@ -76,7 +72,6 @@ options: of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/cloudengine/ce_config.py b/lib/ansible/modules/network/cloudengine/ce_config.py index 57ef2619b1..481ef09b55 100644 --- a/lib/ansible/modules/network/cloudengine/ce_config.py +++ b/lib/ansible/modules/network/cloudengine/ce_config.py @@ -39,16 +39,12 @@ options: in the device current-configuration. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null parents: description: - The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - The I(src) argument provides a path to the configuration file @@ -57,8 +53,6 @@ options: or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) and I(parents) arguments. - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -66,16 +60,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -86,7 +76,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the current-configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -97,7 +86,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] backup: @@ -107,9 +95,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false type: bool - default: false + default: 'no' config: description: - The module, by default, will connect to the remote device and @@ -119,8 +106,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null defaults: description: - The I(defaults) argument will influence how the current-configuration @@ -128,9 +113,8 @@ options: the command used to collect the current-configuration is append with the all keyword. When the value is set to false, the command is issued without the all keyword. - required: false type: bool - default: false + default: 'no' save: description: - The C(save) argument instructs the module to save the @@ -139,9 +123,8 @@ options: no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed. - required: false type: bool - default: false + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/cloudengine/ce_dldp.py b/lib/ansible/modules/network/cloudengine/ce_dldp.py index 899dcd8ace..dce3ed6fba 100644 --- a/lib/ansible/modules/network/cloudengine/ce_dldp.py +++ b/lib/ansible/modules/network/cloudengine/ce_dldp.py @@ -42,40 +42,28 @@ options: enable: description: - Set global DLDP enable state. - required: false - default: null choices: ['enable', 'disable'] work_mode: description: - Set global DLDP work-mode. - required: false - default: null choices: ['enhance', 'normal'] time_internal: description: - Specifies the interval for sending Advertisement packets. The value is an integer ranging from 1 to 100, in seconds. The default interval for sending Advertisement packets is 5 seconds. - required: false - default: null auth_mode: description: - Specifies authentication algorithm of DLDP. - required: false - default: null choices: ['md5', 'simple', 'sha', 'hmac-sha256', 'none'] auth_pwd: description: - Specifies authentication password. The value is a string of 1 to 16 case-sensitive plaintexts or 24/32/48/108/128 case-sensitive encrypted characters. The string excludes a question mark (?). - required: false - default: null reset: description: - Specify whether reset DLDP state of disabled interfaces. - required: false - default: null choices: ['enable', 'disable'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py b/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py index 409280f9f1..8dc9f6265d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py @@ -42,31 +42,22 @@ options: enable: description: - Set interface DLDP enable state. - required: false - default: null choices: ['enable', 'disable'] mode_enable: description: - Set DLDP compatible-mode enable state. - required: false - default: null choices: ['enable', 'disable'] local_mac: description: - Set the source MAC address for DLDP packets sent in the DLDP-compatible mode. The value of MAC address is in H-H-H format. H contains 1 to 4 hexadecimal digits. - required: false - default: null reset: description: - Specify whether reseting interface DLDP state. - required: false - default: null choices: ['enable', 'disable'] state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py b/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py index 98a418fd30..31f2ff20b3 100644 --- a/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py +++ b/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py @@ -47,39 +47,30 @@ options: mode: description: - Specifies the working mode of an Eth-Trunk interface. - required: false - default: null choices: ['manual','lacp-dynamic','lacp-static'] min_links: description: - Specifies the minimum number of Eth-Trunk member links in the Up state. The value is an integer ranging from 1 to the maximum number of interfaces that can be added to a Eth-Trunk interface. - required: false - default: null hash_type: description: - Hash algorithm used for load balancing among Eth-Trunk member interfaces. - required: false - default: null choices: ['src-dst-ip', 'src-dst-mac', 'enhanced', 'dst-ip', 'dst-mac', 'src-ip', 'src-mac'] members: description: - List of interfaces that will be managed in a given Eth-Trunk. The interface name must be full name. - required: false - default: null force: description: - When true it forces Eth-Trunk members to match what is declared in the members param. This can be used to remove members. - required: false - default: false + type: bool + default: 'no' state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py b/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py index a26e8b3efd..8e1c5ab09d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py @@ -50,7 +50,6 @@ options: evpn: description: - Create or delete an EVPN instance for a VXLAN in BD view. - required: false choices: ['enable','disable'] default: 'enable' route_distinguisher: @@ -69,14 +68,10 @@ options: - 5) 32-bit IP address:2-byte user-defined number. For example, 192.168.122.15:1. An IP address ranges from 0.0.0.0 to 255.255.255.255, and a user-defined number is an integer ranging from 0 to 65535. - 6) 'auto' specifies the RD that is automatically generated. - required: false - default: null vpn_target_both: description: - Add VPN targets to both the import and export VPN target lists of a BD EVPN instance. The format is the same as route_distinguisher. - required: false - default: null vpn_target_import: description: - Add VPN targets to the import VPN target list of a BD EVPN instance. @@ -86,12 +81,9 @@ options: description: - Add VPN targets to the export VPN target list of a BD EVPN instance. The format is the same as route_distinguisher. - required: false - default: null state: description: - Manage the state of the resource. - required: false choices: ['present','absent'] default: 'present' ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py index 30dae0b05f..f10ba7fa3d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py @@ -36,48 +36,33 @@ options: as_number: description: - Specifies integral AS number. The value is an integer ranging from 1 to 4294967295. - required: False - default: null peer_address: description: - Specifies the IPv4 address of a BGP EVPN peer. The value is in dotted decimal notation. - required: False - default: null peer_group_name: description: - Specify the name of a peer group that BGP peers need to join. The value is a string of 1 to 47 case-sensitive characters, spaces not supported. - required: False - default: null peer_enable: description: - Enable or disable a BGP device to exchange routes with a specified peer or peer group in the address family view. - required: False - default: null choices: ['true','false'] advertise_router_type: description: - Configures a device to advertise routes to its BGP EVPN peers. - required: False - default: null choices: ['arp','irb'] vpn_name: description: - Associates a specified VPN instance with the IPv4 address family. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. - required: False - default: null advertise_l2vpn_evpn: description: - Enable or disable a device to advertise IP routes imported to a VPN instance to its EVPN instance. - required: False - default: null choices: ['enable','disable'] state: description: - Manage the state of the resource. - required: False default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py index a94826fe5b..72a7040770 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py @@ -37,42 +37,30 @@ options: - Specifies the number of the AS, in integer format. The value is an integer that ranges from 1 to 4294967295. required: true - default: null bgp_instance: description: - Specifies the name of a BGP instance. The value of instance-name can be an integer 1 or a string of 1 to 31. - required: false - default: null bgp_evpn_enable: description: - Enable or disable the BGP-EVPN address family. - required: false choices: ['enable','disable'] default: 'enable' peer_type: description: - Specify the peer type. - required: false choices: ['group_name','ipv4_address'] - default: null peer: description: - Specifies the IPv4 address or the group name of a peer. - required: false - default: null reflect_client: description: - Configure the local device as the route reflector and the peer or peer group as the client of the route reflector. - required: false choices: ['enable','disable'] - default: null policy_vpn_target: description: - Enable or disable the VPN-Target filtering. - required: false choices: ['enable','disable'] - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_file_copy.py b/lib/ansible/modules/network/cloudengine/ce_file_copy.py index 7fea815991..b491338322 100644 --- a/lib/ansible/modules/network/cloudengine/ce_file_copy.py +++ b/lib/ansible/modules/network/cloudengine/ce_file_copy.py @@ -45,8 +45,6 @@ options: - Remote file path of the copy. Remote directories must exist. If omitted, the name of the local file will be used. The maximum length of I(remote_file) is C(4096). - required: false - default: null file_system: description: - The remote file system of the device. If omitted, @@ -59,7 +57,6 @@ options: 3) C(chassis ID/slot number#flash) is root directory of the flash memory on a device in a stack. For example, C(1/5#flash) indicates the flash memory whose chassis ID is 1 and slot number is 5. - required: false default: 'flash:' ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py b/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py index fbf64129e4..af1ba621a9 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py @@ -33,14 +33,11 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] debug_time_stamp: description: - Timestamp type of debugging information. - required: false - default: null choices: ['date_boot', 'date_second', 'date_tenthsecond', 'date_millisecond', 'shortdate_second', 'shortdate_tenthsecond', 'shortdate_millisecond', 'formatdate_second', 'formatdate_tenthsecond', 'formatdate_millisecond'] @@ -49,25 +46,18 @@ options: - Module name of the rule. The value is a string of 1 to 31 case-insensitive characters. The default value is default. Please use lower-case letter, such as [aaa, acl, arp, bfd]. - required: false - default: null channel_id: description: - Number of a channel. The value is an integer ranging from 0 to 9. The default value is 0. - required: false - default: null debug_enable: description: - Whether a device is enabled to output debugging information. - required: false default: no_use choices: ['no_use','true','false'] debug_level: description: - Debug level permitted to output. - required: false - default: null choices: ['emergencies', 'alert', 'critical', 'error', 'warning', 'notification', 'informational', 'debugging'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_global.py b/lib/ansible/modules/network/cloudengine/ce_info_center_global.py index 8ad5a2615c..44aba9b968 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_global.py @@ -33,138 +33,95 @@ options: info_center_enable: description: - Whether the info-center function is enabled. The value is of the Boolean type. - required: false - default: null choices: ['true','false'] packet_priority: description: - Set the priority of the syslog packet.The value is an integer ranging from 0 to 7. The default value is 0. - required: false - default: null suppress_enable: description: - Whether a device is enabled to suppress duplicate statistics. The value is of the Boolean type. - required: false - default: null - choices: ['true','false'] + choices: [ 'false', 'true' ] logfile_max_num: description: - Maximum number of log files of the same type. The default value is 200. - The value range for log files is[3, 500], for security files is [1, 3],and for operation files is [1, 7]. - required: false - default: null logfile_max_size: description: - Maximum size (in MB) of a log file. The default value is 32. - The value range for log files is [4, 8, 16, 32], for security files is [1, 4], - and for operation files is [1, 4]. - required: false default: 32 choices: ['4', '8', '16', '32'] channel_id: description: - Number for channel. The value is an integer ranging from 0 to 9. The default value is 0. - required: false - default: null channel_cfg_name: description: - Channel name.The value is a string of 1 to 30 case-sensitive characters. The default value is console. - required: false default: console channel_out_direct: description: - Direction of information output. - required: false - default: null choices: ['console','monitor','trapbuffer','logbuffer','snmp','logfile'] filter_feature_name: description: - Feature name of the filtered log. The value is a string of 1 to 31 case-insensitive characters. - required: false - default: null filter_log_name: description: - Name of the filtered log. The value is a string of 1 to 63 case-sensitive characters. - required: false - default: null ip_type: description: - Log server address type, IPv4 or IPv6. - required: false - default: null choices: ['ipv4','ipv6'] server_ip: description: - Log server address, IPv4 or IPv6 type. The value is a string of 0 to 255 characters. The value can be an valid IPv4 or IPv6 address. - required: false - default: null server_domain: description: - Server name. The value is a string of 1 to 255 case-sensitive characters. - required: false - default: null is_default_vpn: description: - Use the default VPN or not. - required: false - default: False + type: bool + default: 'no' vrf_name: description: - VPN name on a log server. The value is a string of 1 to 31 case-sensitive characters. The default value is _public_. - required: false - default: null level: description: - Level of logs saved on a log server. - required: false - default: null choices: ['emergencies','alert','critical','error','warning','notification','informational','debugging'] server_port: description: - Number of a port sending logs.The value is an integer ranging from 1 to 65535. For UDP, the default value is 514. For TCP, the default value is 601. For TSL, the default value is 6514. - required: false - default: null facility: description: - Log record tool. - required: false - default: null choices: ['local0','local1','local2','local3','local4','local5','local6','local7'] channel_name: description: - Channel name. The value is a string of 1 to 30 case-sensitive characters. - required: false - default: null timestamp: description: - Log server timestamp. The value is of the enumerated type and case-sensitive. - required: false - default: null choices: ['UTC', 'localtime'] transport_mode: description: - Transport mode. The value is of the enumerated type and case-sensitive. - required: false - default: null choices: ['tcp','udp'] ssl_policy_name: description: - SSL policy name. The value is a string of 1 to 23 case-sensitive characters. - required: false - default: null source_ip: description: - Log source ip address, IPv4 or IPv6 type. The value is a string of 0 to 255. The value can be an valid IPv4 or IPv6 address. - required: false - default: null state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_log.py b/lib/ansible/modules/network/cloudengine/ce_info_center_log.py index d79740931c..2a6d8b8bf7 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_log.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_log.py @@ -33,53 +33,40 @@ options: log_time_stamp: description: - Sets the timestamp format of logs. - required: false - default: null choices: ['date_boot', 'date_second', 'date_tenthsecond', 'date_millisecond', 'shortdate_second', 'shortdate_tenthsecond', 'shortdate_millisecond', 'formatdate_second', 'formatdate_tenthsecond', 'formatdate_millisecond'] log_buff_enable: description: - Enables the Switch to send logs to the log buffer. - required: false default: no_use choices: ['no_use','true', 'false'] log_buff_size: description: - Specifies the maximum number of logs in the log buffer. The value is an integer that ranges from 0 to 10240. If logbuffer-size is 0, logs are not displayed. - required: false - default: null module_name: description: - Specifies the name of a module. The value is a module name in registration logs. - required: false - default: null channel_id: description: - Specifies a channel ID. The value is an integer ranging from 0 to 9. - required: false - default: null log_enable: description: - Indicates whether log filtering is enabled. - required: false default: no_use choices: ['no_use','true', 'false'] log_level: description: - Specifies a log severity. - required: false - default: null choices: ['emergencies', 'alert', 'critical', 'error', 'warning', 'notification', 'informational', 'debugging'] state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py b/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py index c2a116895e..8a45c8fcef 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py @@ -33,53 +33,40 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] trap_time_stamp: description: - Timestamp format of alarm information. - required: false - default: null choices: ['date_boot', 'date_second', 'date_tenthsecond', 'date_millisecond', 'shortdate_second', 'shortdate_tenthsecond', 'shortdate_millisecond', 'formatdate_second', 'formatdate_tenthsecond', 'formatdate_millisecond'] trap_buff_enable: description: - Whether a trap buffer is enabled to output information. - required: false default: no_use choices: ['no_use','true','false'] trap_buff_size: description: - Size of a trap buffer. The value is an integer ranging from 0 to 1024. The default value is 256. - required: false - default: null module_name: description: - Module name of the rule. The value is a string of 1 to 31 case-insensitive characters. The default value is default. Please use lower-case letter, such as [aaa, acl, arp, bfd]. - required: false - default: null channel_id: description: - Number of a channel. The value is an integer ranging from 0 to 9. The default value is 0. - required: false - default: null trap_enable: description: - Whether a device is enabled to output alarms. - required: false default: no_use choices: ['no_use','true','false'] trap_level: description: - Trap level permitted to output. - required: false - default: null choices: ['emergencies', 'alert', 'critical', 'error', 'warning', 'notification', 'informational', 'debugging'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_interface.py b/lib/ansible/modules/network/cloudengine/ce_interface.py index 8e5fdc54f2..2090ebacd7 100644 --- a/lib/ansible/modules/network/cloudengine/ce_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_interface.py @@ -35,13 +35,9 @@ options: interface: description: - Full name of interface, i.e. 40GE1/0/10, Tunnel1. - required: false - default: null interface_type: description: - Interface type to be configured from the device. - required: false - default: null choices: ['ge', '10ge', '25ge', '4x10ge', '40ge', '100ge', 'vlanif', 'loopback', 'meth', 'eth-trunk', 'nve', 'tunnel', 'ethernet', 'fcoe-port', 'fabric-port', 'stack-port', 'null'] admin_state: @@ -50,31 +46,24 @@ options: The value is an enumerated type. up, An interface is in the administrative Up state. down, An interface is in the administrative Down state. - required: false - default: null choices: ['up', 'down'] description: description: - Specifies an interface description. The value is a string of 1 to 242 case-sensitive characters, spaces supported but question marks (?) not supported. - required: false - default: null mode: description: - Manage Layer 2 or Layer 3 state of the interface. - required: false - default: null choices: ['layer2', 'layer3'] l2sub: description: - Specifies whether the interface is a Layer 2 sub-interface. - required: false - default: false + type: bool + default: 'no' state: description: - Specify desired state of the resource. - required: true default: present choices: ['present', 'absent', 'default'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py b/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py index e2ccef4c32..baef6da1c5 100644 --- a/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py +++ b/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py @@ -48,56 +48,41 @@ options: description: - The cost associated with this interface. Valid values are an integer in the range from 1 to 65535. - required: false - default: null hello_interval: description: - Time between sending successive hello packets. Valid values are an integer in the range from 1 to 65535. - required: false - default: null dead_interval: description: - Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer in the range from 1 to 235926000. - required: false - default: null silent_interface: description: - Setting to true will prevent this interface from receiving HELLO packets. Valid values are 'true' and 'false'. - required: false - default: false + type: bool + default: 'no' auth_mode: description: - Specifies the authentication type. - required: false choices: ['none', 'null', 'hmac-sha256', 'md5', 'hmac-md5', 'simple'] - default: null auth_text_simple: description: - Specifies a password for simple authentication. The value is a string of 1 to 8 characters. - required: false - default: null auth_key_id: description: - Authentication key id when C(auth_mode) is 'hmac-sha256', 'md5' or 'hmac-md5. Valid value is an integer is in the range from 1 to 255. - required: false - default: null auth_text_md5: description: - Specifies a password for MD5, HMAC-MD5, or HMAC-SHA256 authentication. The value is a string of 1 to 255 case-sensitive characters, spaces not supported. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_ip_interface.py b/lib/ansible/modules/network/cloudengine/ce_ip_interface.py index e99b57fab5..a51e6c9058 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ip_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_ip_interface.py @@ -42,17 +42,12 @@ options: addr: description: - IPv4 or IPv6 Address. - required: false - default: null mask: description: - Subnet mask for IPv4 or IPv6 Address in decimal format. - required: false - default: null version: description: - IP address version. - required: false default: v4 choices: ['v4','v6'] ipv4_type: @@ -61,13 +56,11 @@ options: The value is an enumerated type. main, primary IP address. sub, secondary IP address. - required: false default: main choices: ['main','sub'] state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_mlag_config.py b/lib/ansible/modules/network/cloudengine/ce_mlag_config.py index 1aa4f7cf9f..5bc7b45e4f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mlag_config.py +++ b/lib/ansible/modules/network/cloudengine/ce_mlag_config.py @@ -33,55 +33,37 @@ options: dfs_group_id: description: - ID of a DFS group. The value is 1. - required: false default: present nickname: description: - The nickname bound to a DFS group. The value is an integer that ranges from 1 to 65471. - required: false - default: null pseudo_nickname: description: - A pseudo nickname of a DFS group. The value is an integer that ranges from 1 to 65471. - required: false - default: null pseudo_priority: description: - The priority of a pseudo nickname. The value is an integer that ranges from 128 to 255. The default value is 192. A larger value indicates a higher priority. - required: false - default: null ip_address: description: - IP address bound to the DFS group. The value is in dotted decimal notation. - required: false - default: null vpn_instance_name: description: - Name of the VPN instance bound to the DFS group. The value is a string of 1 to 31 case-sensitive characters without spaces. If the character string is quoted by double quotation marks, the character string can contain spaces. The value _public_ is reserved and cannot be used as the VPN instance name. - required: false - default: null priority_id: description: - Priority of a DFS group. The value is an integer that ranges from 1 to 254. The default value is 100. - required: false - default: null eth_trunk_id: description: - Name of the peer-link interface. The value is in the range from 0 to 511. - required: false - default: null peer_link_id: description: - Number of the peer-link interface. The value is 1. - required: false - default: null state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py b/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py index b01c7b2965..d75edd875f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py @@ -33,46 +33,32 @@ options: eth_trunk_id: description: - Name of the local M-LAG interface. The value is ranging from 0 to 511. - required: false - default: null dfs_group_id: description: - ID of a DFS group.The value is 1. - required: false default: present mlag_id: description: - ID of the M-LAG. The value is an integer that ranges from 1 to 2048. - required: false - default: null mlag_system_id: description: - M-LAG global LACP system MAC address. The value is a string of 0 to 255 characters. The default value is the MAC address of the Ethernet port of MPU. - required: false - default: null mlag_priority_id: description: - M-LAG global LACP system priority. The value is an integer ranging from 0 to 65535. The default value is 32768. - required: false - default: null interface: description: - Name of the interface that enters the Error-Down state when the peer-link fails. The value is a string of 1 to 63 characters. - required: false - default: null mlag_error_down: description: - Configure the interface on the slave device to enter the Error-Down state. - required: false - default: null choices: ['enable','disable'] state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] diff --git a/lib/ansible/modules/network/cloudengine/ce_mtu.py b/lib/ansible/modules/network/cloudengine/ce_mtu.py index f32677de97..9478b6dd3d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mtu.py +++ b/lib/ansible/modules/network/cloudengine/ce_mtu.py @@ -35,31 +35,22 @@ options: interface: description: - Full name of interface, i.e. 40GE1/0/22. - required: false - default: null mtu: description: - MTU for a specific interface. The value is an integer ranging from 46 to 9600, in bytes. - required: false - default: null jumbo_max: description: - Maximum frame size. The default value is 9216. The value is an integer and expressed in bytes. The value range is 1536 to 12224 for the CE12800 and 1536 to 12288 for ToR switches. - required: false - default: null jumbo_min: description: - Non-jumbo frame size threshod. The default value is 1518. The value is an integer that ranges from 1518 to jumbo_max, in bytes. - required: false - default: null state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py b/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py index a0453c33ad..1daafdae57 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py @@ -33,31 +33,23 @@ options: - Netstream timeout interval. If is active type the interval is 1-60. If is inactive ,the interval is 5-600. - required: false default: 30 type: description: - Specifies the packet type of netstream timeout active interval. - required: false choices: ['ip', 'vxlan'] - default: null state: description: - Specify desired state of the resource. - required: false choices: ['present', 'absent'] default: present timeout_type: description: - Netstream timeout type. - required: false choices: ['active', 'inactive', 'tcp-session', 'manual'] - default: null manual_slot: description: - Specifies the slot number of netstream manual timeout. - required: false - default: null """ EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_export.py b/lib/ansible/modules/network/cloudengine/ce_netstream_export.py index 076dea89a8..3e49327849 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_export.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_export.py @@ -35,52 +35,37 @@ options: - Specifies NetStream feature. required: true choices: ['ip', 'vxlan'] - default: null source_ip: description: - Specifies source address which can be IPv6 or IPv4 of the exported NetStream packet. - required: false - default: null host_ip: description: - Specifies destination address which can be IPv6 or IPv4 of the exported NetStream packet. - required: false - default: null host_port: description: - Specifies the destination UDP port number of the exported packets. The value is an integer that ranges from 1 to 65535. - required: false - default: null host_vpn: description: - Specifies the VPN instance of the exported packets carrying flow statistics. Ensure the VPN instance has been created on the device. - required: false - default: null version: description: - Sets the version of exported packets. - required: false choices: ['5', '9'] - default: null as_option: description: - Specifies the AS number recorded in the statistics as the original or the peer AS number. - required: false choices: ['origin', 'peer'] - default: null bgp_nexthop: description: - Configures the statistics to carry BGP next hop information. Currently, only V9 supports the exported packets carrying BGP next hop information. - required: false choices: ['enable','disable'] default: 'disable' state: description: - Manage the state of the resource. - required: false choices: ['present','absent'] default: present ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_global.py b/lib/ansible/modules/network/cloudengine/ce_netstream_global.py index 1dd799d61b..3fbc89830f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_global.py @@ -31,46 +31,34 @@ options: type: description: - Specifies the type of netstream global. - required: false choices: ['ip', 'vxlan'] default: 'ip' state: description: - Specify desired state of the resource. - required: false choices: ['present', 'absent'] default: present interface: description: - Netstream global interface. required: true - default: null sampler_interval: description: - Specifies the netstream sampler interval, length is 1 - 65535. - required: false - default: null sampler_direction: description: - Specifies the netstream sampler direction. - required: false choices: ['inbound', 'outbound'] - default: null statistics_direction: description: - Specifies the netstream statistic direction. - required: false choices: ['inbound', 'outbound'] - default: null statistics_record: description: - Specifies the flexible netstream statistic record, length is 1 - 32. - required: false - default: null index_switch: description: - Specifies the netstream index-switch. - required: false choices: ['16', '32'] default: '16' """ diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_template.py b/lib/ansible/modules/network/cloudengine/ce_netstream_template.py index 2abb5744d3..e20a619e12 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_template.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_template.py @@ -33,7 +33,6 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present', 'absent'] type: @@ -45,32 +44,22 @@ options: description: - Configure the name of netstream record. The value is a string of 1 to 32 case-insensitive characters. - required: false - default: null match: description: - Configure flexible flow statistics template keywords. - required: false - default: null choices: ['destination-address', 'destination-port', 'tos', 'protocol', 'source-address', 'source-port'] collect_counter: description: - Configure the number of packets and bytes that are included in the flexible flow statistics sent to NSC. - required: false - default: null choices: ['bytes', 'packets'] collect_interface: description: - Configure the input or output interface that are included in the flexible flow statistics sent to NSC. - required: false - default: null choices: ['input', 'output'] description: description: - Configure the description of netstream record. The value is a string of 1 to 80 case-insensitive characters. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ntp.py b/lib/ansible/modules/network/cloudengine/ce_ntp.py index 03a922b325..e0ed2b4e1c 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ntp.py +++ b/lib/ansible/modules/network/cloudengine/ce_ntp.py @@ -33,29 +33,20 @@ options: server: description: - Network address of NTP server. - required: false - default: null peer: description: - Network address of NTP peer. - required: false - default: null key_id: description: - Authentication key identifier to use with given NTP server or peer. - required: false - default: null is_preferred: description: - Makes given NTP server or peer the preferred NTP server or peer for the device. - required: false - default: null choices: ['enable', 'disable'] vpn_name: description: - Makes the device communicate with the given NTP server or peer over a specific vpn. - required: false default: '_public_' source_int: description: @@ -63,12 +54,9 @@ options: Must be fully qualified interface name, i.e. C(40GE1/0/22), C(vlanif10). Interface types, such as C(10GE), C(40GE), C(100GE), C(Eth-Trunk), C(LoopBack), C(MEth), C(NULL), C(Tunnel), C(Vlanif). - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py b/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py index b33fc0ca82..c3c19d0479 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py +++ b/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py @@ -43,39 +43,30 @@ options: auth_pwd: description: - Plain text with length of 1 to 255, encrypted text with length of 20 to 392. - required: false - default: null auth_mode: description: - Specify authentication algorithm. - required: false - default: null choices: ['hmac-sha256', 'md5'] auth_type: description: - Whether the given password is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it. - required: false default: encrypt choices: ['text', 'encrypt'] trusted_key: description: - Whether the given key is required to be supplied by a time source for the device to synchronize to the time source. - required: false default: 'disable' choices: ['enable', 'disable'] authentication: description: - Configure ntp authentication enable or unconfigure ntp authentication enable. - required: false - default: null choices: ['enable', 'disable'] state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ospf.py b/lib/ansible/modules/network/cloudengine/ce_ospf.py index b8c0ef51e1..98762baba3 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ospf.py +++ b/lib/ansible/modules/network/cloudengine/ce_ospf.py @@ -39,67 +39,46 @@ options: - Specifies the area ID. The area with the area-id being 0 is a backbone area. Valid values are a string, formatted as an IP address (i.e. "0.0.0.0") or as an integer between 1 and 4294967295. - required: false - default: null addr: description: - Specifies the address of the network segment where the interface resides. The value is in dotted decimal notation. - required: false - default: null mask: description: - IP network wildcard bits in decimal format between 0 and 32. - required: false - default: null auth_mode: description: - Specifies the authentication type. - required: false choices: ['none', 'hmac-sha256', 'md5', 'hmac-md5', 'simple'] - default: null auth_text_simple: description: - Specifies a password for simple authentication. The value is a string of 1 to 8 characters. - required: false - default: null auth_key_id: description: - Authentication key id when C(auth_mode) is 'hmac-sha256', 'md5' or 'hmac-md5. Valid value is an integer is in the range from 1 to 255. - required: false - default: null auth_text_md5: description: - Specifies a password for MD5, HMAC-MD5, or HMAC-SHA256 authentication. The value is a string of 1 to 255 case-sensitive characters, spaces not supported. - required: false - default: null nexthop_addr: description: - IPv4 address for configure next-hop address's weight. Valid values are a string, formatted as an IP address. - required: false - default: null nexthop_weight: description: - Indicates the weight of the next hop. The smaller the value is, the higher the preference of the route is. It is an integer that ranges from 1 to 254. - required: false - default: null max_load_balance: description: - The maximum number of paths for forward packets over multiple paths. Valid value is an integer in the range from 1 to 64. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py b/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py index 8e829622cf..dc27e9a59e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py +++ b/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py @@ -34,95 +34,71 @@ options: - The ID of the ospf process. Valid values are an integer, 1 - 4294967295, the default value is 1. required: true - default: null route_id: description: - Specifies the ospf private route id,. Valid values are a string, formatted as an IP address (i.e. "10.1.1.1") the length is 0 - 20. - required: false - default: null vrf: description: - Specifies the vpn instance which use ospf,length is 1 - 31. Valid values are a string. - required: false default: _public_ description: description: - Specifies the description information of ospf process. - required: false - default: null bandwidth: description: - Specifies the reference bandwidth used to assign ospf cost. Valid values are an integer, in Mbps, 1 - 2147483648, the default value is 100. - required: false - default: null lsaalflag: description: - Specifies the mode of timer to calculate interval of arrive LSA. If set the parameter but not specifies value, the default will be used. If true use general timer. If false use intelligent timer. - required: false - default: False + type: bool + default: 'no' lsaainterval: description: - Specifies the interval of arrive LSA when use the general timer. Valid value is an integer, in millisecond, from 0 to 10000. - required: false - default: null lsaamaxinterval: description: - Specifies the max interval of arrive LSA when use the intelligent timer. Valid value is an integer, in millisecond, from 0 to 10000, the default value is 1000. - required: false - default: null lsaastartinterval: description: - Specifies the start interval of arrive LSA when use the intelligent timer. Valid value is an integer, in millisecond, from 0 to 10000, the default value is 500. - required: false - default: null lsaaholdinterval: description: - Specifies the hold interval of arrive LSA when use the intelligent timer. Valid value is an integer, in millisecond, from 0 to 10000, the default value is 500. - required: false - default: null lsaointervalflag: description: - Specifies whether cancel the interval of LSA originate or not. If set the parameter but noe specifies value, the default will be used. true:cancel the interval of LSA originate, the interval is 0. false:do not cancel the interval of LSA originate. - required: false - default: False + type: bool + default: 'no' lsaointerval: description: - Specifies the interval of originate LSA . Valid value is an integer, in second, from 0 to 10, the default value is 5. - required: false - default: null lsaomaxinterval: description: - Specifies the max interval of originate LSA . Valid value is an integer, in millisecond, from 1 to 10000, the default value is 5000. - required: false - default: null lsaostartinterval: description: - Specifies the start interval of originate LSA . Valid value is an integer, in millisecond, from 0 to 1000, the default value is 500. - required: false - default: null lsaoholdinterval: description: - Specifies the hold interval of originate LSA . Valid value is an integer, in millisecond, from 0 to 5000, the default value is 1000. - required: false - default: null spfintervaltype: description: - Specifies the mode of timer which used to calculate SPF. @@ -130,43 +106,31 @@ options: If is intelligent-timer, then use intelligent timer. If is timer, then use second level timer. If is millisecond, then use millisecond level timer. - required: false choices: ['intelligent-timer','timer','millisecond'] default: intelligent-timer spfinterval: description: - Specifies the interval to calculate SPF when use second level timer. Valid value is an integer, in second, from 1 to 10. - required: false - default: null spfintervalmi: description: - Specifies the interval to calculate SPF when use millisecond level timer. Valid value is an integer, in millisecond, from 1 to 10000. - required: false - default: null spfmaxinterval: description: - Specifies the max interval to calculate SPF when use intelligent timer. Valid value is an integer, in millisecond, from 1 to 20000, the default value is 5000. - required: false - default: null spfstartinterval: description: - Specifies the start interval to calculate SPF when use intelligent timer. Valid value is an integer, in millisecond, from 1 to 1000, the default value is 50. - required: false - default: null spfholdinterval: description: - Specifies the hold interval to calculate SPF when use intelligent timer. Valid value is an integer, in millisecond, from 1 to 5000, the default value is 200. - required: false - default: null state: description: - Specify desired state of the resource. - required: false choices: ['present', 'absent'] default: present ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_rollback.py b/lib/ansible/modules/network/cloudengine/ce_rollback.py index 8c73f459f5..1d3addb440 100644 --- a/lib/ansible/modules/network/cloudengine/ce_rollback.py +++ b/lib/ansible/modules/network/cloudengine/ce_rollback.py @@ -35,33 +35,24 @@ options: - Specifies the label of the configuration rollback point to which system configurations are expected to roll back. The value is an integer that the system generates automatically. - required: false label: description: - Specifies a user label for a configuration rollback point. The value is a string of 1 to 256 case-sensitive ASCII characters, spaces not supported. The value must start with a letter and cannot be presented in a single hyphen (-). - required: false - default: null filename: description: - Specifies a configuration file for configuration rollback. The value is a string of 5 to 64 case-sensitive characters in the format of *.zip, *.cfg, or *.dat, spaces not supported. - required: false - default: null last: description: - Specifies the number of configuration rollback points. The value is an integer that ranges from 1 to 80. - required: false - default: null oldest: description: - Specifies the number of configuration rollback points. The value is an integer that ranges from 1 to 80. - required: false - default: null action: description: - The operation of configuration rollback. diff --git a/lib/ansible/modules/network/cloudengine/ce_sflow.py b/lib/ansible/modules/network/cloudengine/ce_sflow.py index 50d2fb788c..80154a33a0 100644 --- a/lib/ansible/modules/network/cloudengine/ce_sflow.py +++ b/lib/ansible/modules/network/cloudengine/ce_sflow.py @@ -34,45 +34,31 @@ options: agent_ip: description: - Specifies the IPv4/IPv6 address of an sFlow agent. - required: false - default: null source_ip: description: - Specifies the source IPv4/IPv6 address of sFlow packets. - required: false - default: null collector_id: description: - Specifies the ID of an sFlow collector. This ID is used when you specify the collector in subsequent sFlow configuration. - required: false - default: null choices: ['1', '2'] collector_ip: description: - Specifies the IPv4/IPv6 address of the sFlow collector. - required: false - default: null collector_ip_vpn: description: - Specifies the name of a VPN instance. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value C(_public_) is reserved and cannot be used as the VPN instance name. - required: false - default: null collector_datagram_size: description: - Specifies the maximum length of sFlow packets sent from an sFlow agent to an sFlow collector. The value is an integer, in bytes. It ranges from 1024 to 8100. The default value is 1400. - required: false - default: null collector_udp_port: description: - Specifies the UDP destination port number of sFlow packets. The value is an integer that ranges from 1 to 65535. The default value is 6343. - required: false - default: null collector_meth: description: - Configures the device to send sFlow packets through service interfaces, @@ -83,75 +69,51 @@ options: When the value is meth, the device forwards sFlow packets at the control plane. When the value is enhanced, the device forwards sFlow packets at the forwarding plane to enhance the sFlow packet forwarding capacity. - required: false - default: null choices: ['meth', 'enhanced'] collector_description: description: - Specifies the description of an sFlow collector. The value is a string of 1 to 255 case-sensitive characters without spaces. - required: false - default: null sflow_interface: description: - Full name of interface for Flow Sampling or Counter. It must be a physical interface, Eth-Trunk, or Layer 2 subinterface. - required: false - default: null sample_collector: description: - Indicates the ID list of the collector. - required: false - default: null sample_rate: description: - Specifies the flow sampling rate in the format 1/rate. The value is an integer and ranges from 1 to 4294967295. The default value is 8192. - required: false - default: null sample_length: description: - Specifies the maximum length of sampled packets. The value is an integer and ranges from 18 to 512, in bytes. The default value is 128. - required: false - default: null sample_direction: description: - Enables flow sampling in the inbound or outbound direction. - required: false - default: null choices: ['inbound', 'outbound', 'both'] counter_collector: description: - Indicates the ID list of the counter collector. - required: false - default: null counter_interval: description: - Indicates the counter sampling interval. The value is an integer that ranges from 10 to 4294967295, in seconds. The default value is 20. - required: false - default: null export_route: description: - Configures the sFlow packets sent by the switch not to carry routing information. - required: false - default: null choices: ['enable', 'disable'] rate_limit: description: - Specifies the rate of sFlow packets sent from a card to the control plane. The value is an integer that ranges from 100 to 1500, in pps. - required: false - default: null rate_limit_slot: description: - Specifies the slot where the rate of output sFlow packets is limited. If this parameter is not specified, the rate of sFlow packets sent from all cards to the control plane is limited. The value is an integer or a string of characters. - required: false - default: null forward_enp_slot: description: - Enable the Embedded Network Processor (ENP) chip function. @@ -160,13 +122,10 @@ options: If you set the sampling interval to be larger than 65535, the switch automatically restores it to 65535. The value is an integer or 'all'. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_community.py b/lib/ansible/modules/network/cloudengine/ce_snmp_community.py index 5b6142cc84..eb3c873062 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_community.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_community.py @@ -33,54 +33,35 @@ options: acl_number: description: - Access control list number. - required: false - default: null community_name: description: - Unique name to identify the community. - required: false - default: null access_right: description: - Access right read or write. - required: false - default: null choices: ['read','write'] community_mib_view: description: - Mib view name. - required: false - default: null group_name: description: - Unique name to identify the SNMPv3 group. - required: false - default: null security_level: description: - Security level indicating whether to use authentication and encryption. - required: false - default: null choices: ['noAuthNoPriv', 'authentication', 'privacy'] read_view: description: - Mib view name for read. - required: false - default: null write_view: description: - Mib view name for write. - required: false - default: null notify_view: description: - Mib view name for notification. - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py b/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py index 77284a90ba..3eb0b203f8 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py @@ -34,11 +34,9 @@ options: description: - Contact information. required: true - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_location.py b/lib/ansible/modules/network/cloudengine/ce_snmp_location.py index 1e09f1d59b..1cd5952bb8 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_location.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_location.py @@ -34,11 +34,9 @@ options: description: - Location information. required: true - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py b/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py index e2821f946e..2999227e23 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py @@ -33,73 +33,48 @@ options: version: description: - Version(s) Supported by SNMP Engine. - required: false - default: null choices: ['none', 'v1', 'v2c', 'v3', 'v1v2c', 'v1v3', 'v2cv3', 'all'] connect_port: description: - Udp port used by SNMP agent to connect the Network management. - required: false - default: null host_name: description: - Unique name to identify target host entry. - required: false - default: null address: description: - Network Address. - required: false - default: null notify_type: description: - To configure notify type as trap or inform. - required: false - default: null choices: ['trap','inform'] vpn_name: description: - VPN instance Name. - required: false - default: null recv_port: description: - UDP Port number used by network management to receive alarm messages. - required: false - default: null security_model: description: - Security Model. - required: false - default: null choices: ['v1','v2c', 'v3'] security_name: description: - Security Name. - required: false - default: null security_name_v3: description: - Security Name V3. - required: false - default: null security_level: description: - Security level indicating whether to use authentication and encryption. - required: false - default: null choices: ['noAuthNoPriv','authentication', 'privacy'] is_public_net: description: - To enable or disable Public Net-manager for target Host. - required: false default: no_use choices: ['no_use','true','false'] interface_name: description: - Name of the interface to send the trap message. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py b/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py index 0148cb6153..9dc709b809 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py @@ -33,8 +33,6 @@ options: feature_name: description: - Alarm feature name. - required: false - default: null choices: ['aaa', 'arp', 'bfd', 'bgp', 'cfg', 'configuration', 'dad', 'devm', 'dhcpsnp', 'dldp', 'driver', 'efm', 'erps', 'error-down', 'fcoe', 'fei', 'fei_comm', 'fm', 'ifnet', 'info', 'ipsg', 'ipv6', 'isis', @@ -47,25 +45,17 @@ options: trap_name: description: - Alarm trap name. - required: false - default: null interface_type: description: - Interface type. - required: false - default: null choices: ['Ethernet', 'Eth-Trunk', 'Tunnel', 'NULL', 'LoopBack', 'Vlanif', '100GE', '40GE', 'MTunnel', '10GE', 'GE', 'MEth', 'Vbdif', 'Nve'] interface_number: description: - Interface number. - required: false - default: null port_number: description: - Source port number. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_user.py b/lib/ansible/modules/network/cloudengine/ce_snmp_user.py index 59e079bf9f..65d8dbe54a 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_user.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_user.py @@ -33,50 +33,32 @@ options: acl_number: description: - Access control list number. - required: false - default: null usm_user_name: description: - Unique name to identify the USM user. - required: false - default: null aaa_local_user: description: - Unique name to identify the local user. - required: false - default: null remote_engine_id: description: - Remote engine id of the USM user. - required: false - default: null user_group: description: - Name of the group where user belongs to. - required: false - default: null auth_protocol: description: - Authentication protocol. - required: false - default: null choices: ['noAuth', 'md5', 'sha'] auth_key: description: - The authentication password. Password length, 8-255 characters. - required: false - default: null priv_protocol: description: - Encryption protocol. - required: false - default: null choices: ['noPriv', 'des56', '3des168', 'aes128', 'aes192', 'aes256'] priv_key: description: - The encryption password. Password length 8-255 characters. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_startup.py b/lib/ansible/modules/network/cloudengine/ce_startup.py index 3191e4ba2d..b2bbcf888d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_startup.py +++ b/lib/ansible/modules/network/cloudengine/ce_startup.py @@ -34,31 +34,22 @@ options: description: - Name of the configuration file that is applied for the next startup. The value is a string of 5 to 255 characters. - required: false default: present software_file: description: - File name of the system software that is applied for the next startup. The value is a string of 5 to 255 characters. - required: false - default: null patch_file: description: - Name of the patch file that is applied for the next startup. - required: false - default: null slot: description: - Position of the device.The value is a string of 1 to 32 characters. The possible value of slot is all, slave-board, or the specific slotID. - required: false - default: null action: description: - Display the startup information. - required: false choices: ['display'] - default: null ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_static_route.py b/lib/ansible/modules/network/cloudengine/ce_static_route.py index 7df26a4499..6bf5e3620f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_static_route.py +++ b/lib/ansible/modules/network/cloudengine/ce_static_route.py @@ -48,42 +48,27 @@ options: next_hop: description: - Next hop address of static route. - required: false - default: null nhp_interface: description: - Next hop interface full name of static route. - required: false - default: null vrf: description: - VPN instance of destination ip address. - required: false - default: null destvrf: description: - VPN instance of next hop ip address. - required: false - default: null tag: description: - Route tag value (numeric). - required: false - default: null description: description: - Name of the route. Used with the name parameter on the CLI. - required: false - default: null pref: description: - Preference or administrative difference of route (range 1-255). - required: false - default: null state: description: - Specify desired state of the resource. - required: false choices: ['present','absent'] default: present ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_stp.py b/lib/ansible/modules/network/cloudengine/ce_stp.py index d208c90f90..e3d4d5ba28 100644 --- a/lib/ansible/modules/network/cloudengine/ce_stp.py +++ b/lib/ansible/modules/network/cloudengine/ce_stp.py @@ -33,92 +33,65 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present', 'absent'] stp_mode: description: - Set an operation mode for the current MSTP process. The mode can be STP, RSTP, or MSTP. - required: false - default: null choices: ['stp', 'rstp', 'mstp'] stp_enable: description: - Enable or disable STP on a switch. - required: false - default: null choices: ['enable', 'disable'] stp_converge: description: - STP convergence mode. Fast means set STP aging mode to Fast. Normal means set STP aging mode to Normal. - required: false - default: null choices: ['fast', 'normal'] bpdu_protection: description: - Configure BPDU protection on an edge port. This function prevents network flapping caused by attack packets. - required: false - default: null choices: ['enable', 'disable'] tc_protection: description: - Configure the TC BPDU protection function for an MSTP process. - required: false - default: null choices: ['enable', 'disable'] tc_protection_interval: description: - Set the time the MSTP device takes to handle the maximum number of TC BPDUs and immediately refresh forwarding entries. The value is an integer ranging from 1 to 600, in seconds. - required: false - default: null tc_protection_threshold: description: - Set the maximum number of TC BPDUs that the MSTP can handle. The value is an integer ranging from 1 to 255. The default value is 1 on the switch. - required: false - default: null interface: description: - Interface name. If the value is C(all), will apply configuration to all interfaces. if the value is a special name, only support input the full name. - required: false - default: null edged_port: description: - Set the current port as an edge port. - required: false - default: null choices: ['enable', 'disable'] bpdu_filter: description: - Specify a port as a BPDU filter port. - required: false - default: null choices: ['enable', 'disable'] cost: description: - Set the path cost of the current port. The default instance is 0. - required: false - default: null root_protection: description: - Enable root protection on the current port. - required: false - default: null choices: ['enable', 'disable'] loop_protection: description: - Enable loop protection on the current port. - required: false - default: null choices: ['enable', 'disable'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_switchport.py b/lib/ansible/modules/network/cloudengine/ce_switchport.py index 865a50c5d8..f77ef7599e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_switchport.py +++ b/lib/ansible/modules/network/cloudengine/ce_switchport.py @@ -42,33 +42,23 @@ options: description: - Full name of the interface, i.e. 40GE1/0/22. required: true - default: null mode: description: - The link type of an interface. - required: false - default: null choices: ['access','trunk'] access_vlan: description: - If C(mode=access), used as the access VLAN ID, in the range from 1 to 4094. - required: false - default: null native_vlan: description: - If C(mode=trunk), used as the trunk native VLAN ID, in the range from 1 to 4094. - required: false - default: null trunk_vlans: description: - If C(mode=trunk), used as the VLAN range to ADD or REMOVE from the trunk, such as 2-10 or 2,5,10-15, etc. - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present', 'absent', 'unconfigured'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vlan.py b/lib/ansible/modules/network/cloudengine/ce_vlan.py index fef7202eb3..e002646f24 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vlan.py +++ b/lib/ansible/modules/network/cloudengine/ce_vlan.py @@ -32,27 +32,18 @@ options: vlan_id: description: - Single VLAN ID, in the range from 1 to 4094. - required: false - default: null vlan_range: description: - Range of VLANs such as C(2-10) or C(2,5,10-15), etc. - required: false - default: null name: description: - Name of VLAN, in the range from 1 to 31. - required: false - default: null description: description: - Specify VLAN description, in the range from 1 to 80. - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf.py b/lib/ansible/modules/network/cloudengine/ce_vrf.py index 82e04c8339..7cd0fc7e2e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf.py @@ -39,12 +39,9 @@ options: description: description: - Description of the vrf, the string length is 1 - 242 . - required: false - default: null state: description: - Manage the state of the resource. - required: false choices: ['present','absent'] default: present ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf_af.py b/lib/ansible/modules/network/cloudengine/ce_vrf_af.py index 39ed978b97..feb8595436 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf_af.py @@ -34,45 +34,36 @@ options: description: - VPN instance. required: true - default: null vrf_aftype: description: - VPN instance address family. - required: false choices: ['v4','v6'] default: v4 route_distinguisher: description: - VPN instance route distinguisher,the RD used to distinguish same route prefix from different vpn. The RD must be setted before setting vpn_target_value. - required: false vpn_target_state: description: - Manage the state of the vpn target. - required: false choices: ['present','absent'] vpn_target_type: description: - VPN instance vpn target type. - required: false choices: ['export_extcommunity', 'import_extcommunity'] - default: null vpn_target_value: description: - VPN instance target value. Such as X.X.X.X:number<0-65535> or number<0-65535>:number<0-4294967295> or number<0-65535>.number<0-65535>:number<0-65535> or number<65536-4294967295>:number<0-65535> but not support 0:0 and 0.0:0. - required: false evpn: description: - Is extend vpn or normal vpn. - required: false - choices: ['true', 'false'] - default: false + type: bool + default: 'no' state: description: - Manage the state of the af. - required: false choices: ['present','absent'] default: present ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrrp.py b/lib/ansible/modules/network/cloudengine/ce_vrrp.py index 3a5a71dbc0..1b16aedeed 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrrp.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrrp.py @@ -33,120 +33,88 @@ options: interface: description: - Name of an interface. The value is a string of 1 to 63 characters. - required: false - default: null vrid: description: - VRRP backup group ID. The value is an integer ranging from 1 to 255. - required: false default: present virtual_ip : description: - Virtual IP address. The value is a string of 0 to 255 characters. - required: false - default: null vrrp_type: description: - Type of a VRRP backup group. - required: false choices: ['normal', 'member', 'admin'] - default: null admin_ignore_if_down: description: - mVRRP ignores an interface Down event. - required: false - default: False + type: bool + default: 'no' admin_vrid: description: - Tracked mVRRP ID. The value is an integer ranging from 1 to 255. - required: false - default: null admin_interface: description: - Tracked mVRRP interface name. The value is a string of 1 to 63 characters. - required: false - default: null admin_flowdown: description: - Disable the flowdown function for service VRRP. - required: false - default: False + type: bool + default: 'no' priority: description: - Configured VRRP priority. The value ranges from 1 to 254. The default value is 100. A larger value indicates a higher priority. - required: false - default: null version: description: - VRRP version. The default version is v2. - required: false choices: ['v2','v3'] - default: null advertise_interval: description: - Configured interval between sending advertisements, in milliseconds. Only the master router sends VRRP advertisements. The default value is 1000 milliseconds. - required: false - default: null preempt_timer_delay: description: - Preemption delay. The value is an integer ranging from 0 to 3600. The default value is 0. - required: false - default: null gratuitous_arp_interval: description: - Interval at which gratuitous ARP packets are sent, in seconds. The value ranges from 30 to 1200.The default value is 300. - required: false - default: null recover_delay: description: - Delay in recovering after an interface goes Up. The delay is used for interface flapping suppression. The value is an integer ranging from 0 to 3600. The default value is 0 seconds. - required: false - default: null holding_multiplier: description: - The configured holdMultiplier.The value is an integer ranging from 3 to 10. The default value is 3. - required: false - default: null auth_mode: description: - Authentication type used for VRRP packet exchanges between virtual routers. The values are noAuthentication, simpleTextPassword, md5Authentication. The default value is noAuthentication. - required: false choices: ['simple','md5','none'] - default: null is_plain: description: - Select the display mode of an authentication key. By default, an authentication key is displayed in ciphertext. - required: false - default: False + type: bool + default: 'no' auth_key: description: - This object is set based on the authentication type. When noAuthentication is specified, the value is empty. When simpleTextPassword or md5Authentication is specified, the value is a string of 1 to 8 characters in plaintext and displayed as a blank text for security. - required: false - default: null fast_resume: description: - mVRRP's fast resume mode. - required: false choices: ['enable','disable'] - default: null state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py index b687a60312..1a09d04f48 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py @@ -32,67 +32,46 @@ options: evn_bgp: description: - Enables EVN BGP. - required: false choices: ['enable', 'disable'] - default: null evn_source_ip: description: - Specifies the source address of an EVN BGP peer. The value is in dotted decimal notation. - required: false - default: null evn_peer_ip: description: - Specifies the IP address of an EVN BGP peer. The value is in dotted decimal notation. - required: false - default: null evn_server: description: - Configures the local device as the router reflector (RR) on the EVN network. - required: false choices: ['enable', 'disable'] - default: null evn_reflect_client: description: - Configures the local device as the route reflector (RR) and its peer as the client. - required: false choices: ['enable', 'disable'] - default: null vbdif_name: description: - Full name of VBDIF interface, i.e. Vbdif100. - required: false - default: null arp_collect_host: description: - Enables EVN BGP or BGP EVPN to collect host information. - required: false choices: ['enable', 'disable'] - default: null host_collect_protocol: description: - Enables EVN BGP or BGP EVPN to advertise host information. - required: false choices: ['bgp','none'] - default: null bridge_domain_id: description: - Specifies a BD(bridge domain) ID. The value is an integer ranging from 1 to 16777215. - required: false - default: null arp_suppress: description: - Enables ARP broadcast suppression in a BD. - required: false choices: ['enable', 'disable'] - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py index e88d6bbb85..7a09f52547 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py @@ -36,101 +36,72 @@ options: description: - Specifies the ID of a DFS group. The value must be 1. - required: false - default: null dfs_source_ip: description: - Specifies the IPv4 address bound to a DFS group. The value is in dotted decimal notation. - required: false - default: null dfs_source_vpn: description: - Specifies the name of a VPN instance bound to a DFS group. The value is a string of 1 to 31 case-sensitive characters without spaces. If the character string is quoted by double quotation marks, the character string can contain spaces. The value C(_public_) is reserved and cannot be used as the VPN instance name. - required: false - default: null dfs_udp_port: description: - Specifies the UDP port number of the DFS group. The value is an integer that ranges from 1025 to 65535. - required: false - default: null dfs_all_active: description: - Creates all-active gateways. - required: false choices: ['enable', 'disable'] - default: null dfs_peer_ip: description: - Configure the IP address of an all-active gateway peer. The value is in dotted decimal notation. - required: false - default: null dfs_peer_vpn: description: - Specifies the name of the VPN instance that is associated with all-active gateway peer. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value C(_public_) is reserved and cannot be used as the VPN instance name. - required: false - default: null vpn_instance: description: - Specifies the name of a VPN instance. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value C(_public_) is reserved and cannot be used as the VPN instance name. - required: false - default: null vpn_vni: description: - Specifies a VNI ID. Binds a VXLAN network identifier (VNI) to a virtual private network (VPN) instance. The value is an integer ranging from 1 to 16000000. - required: false - default: null vbdif_name: description: - Full name of VBDIF interface, i.e. Vbdif100. - required: false - default: null vbdif_bind_vpn: description: - Specifies the name of the VPN instance that is associated with the interface. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value C(_public_) is reserved and cannot be used as the VPN instance name. - required: false - default: null vbdif_mac: description: - Specifies a MAC address for a VBDIF interface. The value is in the format of H-H-H. Each H is a 4-digit hexadecimal number, such as C(00e0) or C(fc01). If an H contains less than four digits, 0s are added ahead. For example, C(e0) is equal to C(00e0). A MAC address cannot be all 0s or 1s or a multicast MAC address. - required: false - default: null arp_distribute_gateway: description: - Enable the distributed gateway function on VBDIF interface. - required: false choices: ['enable','disable'] - default: null arp_direct_route: description: - Enable VLINK direct route on VBDIF interface. - required: false choices: ['enable','disable'] - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py index d560d04bf7..17335986b2 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py @@ -33,57 +33,40 @@ options: description: - Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215. - required: false - default: null tunnel_mode_vxlan: description: - Set the tunnel mode to VXLAN when configuring the VXLAN feature. - required: false choices: ['enable', 'disable'] - default: null nvo3_prevent_loops: description: - Loop prevention of VXLAN traffic in non-enhanced mode. When the device works in non-enhanced mode, inter-card forwarding of VXLAN traffic may result in loops. - required: false choices: ['enable', 'disable'] - default: null nvo3_acl_extend: description: - Enabling or disabling the VXLAN ACL extension function. - required: false choices: ['enable', 'disable'] - default: null nvo3_gw_enhanced: description: - Configuring the Layer 3 VXLAN Gateway to Work in Non-loopback Mode. - required: false choices: ['l2', 'l3'] - default: null nvo3_service_extend: description: - Enabling or disabling the VXLAN service extension function. - required: false choices: ['enable', 'disable'] - default: null nvo3_eth_trunk_hash: description: - Eth-Trunk from load balancing VXLAN packets in optimized mode. - required: false choices: ['enable','disable'] - default: null nvo3_ecmp_hash: description: - Load balancing of VXLAN packets through ECMP in optimized mode. - required: false choices: ['enable', 'disable'] - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py index 879ee3477e..9b0db2ffef 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py @@ -34,45 +34,30 @@ options: bridge_domain_id: description: - Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215. - required: false - default: null vni_id: description: - Specifies a VXLAN network identifier (VNI) ID. The value is an integer ranging from 1 to 16000000. - required: false - default: null nve_name: description: - Specifies the number of an NVE interface. The value ranges from 1 to 2. - required: false - default: null nve_mode: description: - Specifies the working mode of an NVE interface. - required: false - default: null choices: ['mode-l2','mode-l3'] peer_list_ip: description: - Specifies the IP address of a remote VXLAN tunnel endpoints (VTEP). The value is in dotted decimal notation. - required: false - default: null protocol_type: description: - The operation type of routing protocol. - required: false - default: null choices: ['bgp','null'] source_ip: description: - Specifies an IP address for a source VTEP. The value is in dotted decimal notation. - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py index 0db4d514ad..d24b81a6f7 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py @@ -33,46 +33,33 @@ options: description: - Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215. - required: false - default: null bind_vlan_id: description: - Specifies the VLAN binding to a BD(Bridge Domain). The value is an integer ranging ranging from 1 to 4094. - required: false - default: null l2_sub_interface: description: - Specifies an Sub-Interface full name, i.e. "10GE1/0/41.1". The value is a string of 1 to 63 case-insensitive characters, spaces supported. - required: false - default: null encapsulation: description: - Specifies an encapsulation type of packets allowed to pass through a Layer 2 sub-interface. choices: ['dot1q', 'default', 'untag', 'qinq', 'none'] - required: false - default: null ce_vid: description: - When I(encapsulation) is 'dot1q', specifies a VLAN ID in the outer VLAN tag. When I(encapsulation) is 'qinq', specifies an outer VLAN ID for double-tagged packets to be received by a Layer 2 sub-interface. The value is an integer ranging from 1 to 4094. - required: false - default: null pe_vid: description: - When I(encapsulation) is 'qinq', specifies an inner VLAN ID for double-tagged packets to be received by a Layer 2 sub-interface. The value is an integer ranging from 1 to 4094. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/cloudvision/cv_server_provision.py b/lib/ansible/modules/network/cloudvision/cv_server_provision.py index ba1dd2bc35..aebc73c993 100644 --- a/lib/ansible/modules/network/cloudvision/cv_server_provision.py +++ b/lib/ansible/modules/network/cloudvision/cv_server_provision.py @@ -50,7 +50,6 @@ options: - The port number to use when making API calls to the CVP node. This will default to the default port for the specified protocol. Port 80 for http and port 443 for https. - default: None protocol: description: - The protocol to use when making API calls to CVP. CVP defaults to https @@ -89,7 +88,6 @@ options: specified does not support this the module will exit out with no changes. If a template is specified that requires a port vlan but no port vlan is specified the module will exit out with no changes. - default: None template: description: - A path to a Jinja formatted template file that contains the @@ -116,9 +114,8 @@ options: change, execute it and wait for the task to complete. If the option is False then the task will remain in the Pending state in CVP for a network administrator to review and execute. - default: False type: bool -notes: + default: 'no' requirements: [Jinja2, cvprac >= 0.7.0] ''' diff --git a/lib/ansible/modules/network/cnos/cnos_image.py b/lib/ansible/modules/network/cnos/cnos_image.py index 77a4c7c5e6..6479075965 100644 --- a/lib/ansible/modules/network/cnos/cnos_image.py +++ b/lib/ansible/modules/network/cnos/cnos_image.py @@ -55,35 +55,28 @@ options: to download the firmware image. The choices are FTP, SFTP, TFTP, or SCP. Any other protocols will result in error. If this parameter is not specified, there is no default value to be used. required: true - default: null choices: [SFTP, SCP, FTP, TFTP] serverip: description: - This specifies the IP Address of the remote server from where the software image will be downloaded. required: true - default: null imgpath: description: - This specifies the full file path of the image located on the remote server. In case the relative path is used as the variable value, the root folder for the user of the server needs to be specified. required: true - default: null imgtype: description: - This specifies the firmware image type to be downloaded required: true - default: null choices: [all, boot, os, onie] serverusername: description: - Specify the username for the server relating to the protocol used. required: true - default: null serverpassword: description: - Specify the password for the server relating to the protocol used. - required: false - default: null ''' EXAMPLES = ''' Tasks : The following are examples of using the module cnos_image. These are written in the main.yml file of the tasks directory. diff --git a/lib/ansible/modules/network/cnos/cnos_vlan.py b/lib/ansible/modules/network/cnos/cnos_vlan.py index 7ef652ddfc..52a7adb323 100644 --- a/lib/ansible/modules/network/cnos/cnos_vlan.py +++ b/lib/ansible/modules/network/cnos/cnos_vlan.py @@ -57,35 +57,26 @@ options: description: - This is an overloaded vlan first argument. Usage of this argument can be found is the User Guide referenced above. required: true - default: null choices: [access-map, dot1q, filter, <1-3999> VLAN ID 1-3999 or range] vlanArg2: description: - This is an overloaded vlan second argument. Usage of this argument can be found is the User Guide referenced above. - required: false - default: null choices: [VLAN Access Map name,egress-only,name, flood,state, ip] vlanArg3: description: - This is an overloaded vlan third argument. Usage of this argument can be found is the User Guide referenced above. - required: false - default: null choices: [action, match, statistics, enter VLAN id or range of vlan, ascii name for the VLAN, ipv4 or ipv6, active or suspend, fast-leave, last-member-query-interval, mrouter, querier, querier-timeout, query-interval, query-max-response-time, report-suppression, robustness-variable, startup-query-count, startup-query-interval, static-group] vlanArg4: description: - This is an overloaded vlan fourth argument. Usage of this argument can be found is the User Guide referenced above. - required: false - default: null choices: [drop or forward or redirect, ip or mac,Interval in seconds,ethernet, port-aggregation, Querier IP address, Querier Timeout in seconds, Query Interval in seconds, Query Max Response Time in seconds, Robustness Variable value, Number of queries sent at startup, Query Interval at startup] vlanArg5: description: - This is an overloaded vlan fifth argument. Usage of this argument can be found is the User Guide referenced above. - required: false - default: null choices: [access-list name, Slot/chassis number, Port Aggregation Number] ''' diff --git a/lib/ansible/modules/network/cumulus/_cl_img_install.py b/lib/ansible/modules/network/cumulus/_cl_img_install.py index 7342c70abb..f44d718c70 100644 --- a/lib/ansible/modules/network/cumulus/_cl_img_install.py +++ b/lib/ansible/modules/network/cumulus/_cl_img_install.py @@ -43,15 +43,11 @@ options: and version is set to '2.5.0', then the module will assume it is installing '2.5.0' not '2.2.3'. If version is not included, then the module will assume '2.2.3' is the version to install. - default: None - required: false switch_slot: description: - Switch slots after installing the image. To run the installed code, reboot the switch. - choices: ['yes', 'no'] - default: 'no' - required: false + type: bool requirements: ["Cumulus Linux OS"] diff --git a/lib/ansible/modules/network/dellos10/dellos10_command.py b/lib/ansible/modules/network/dellos10/dellos10_command.py index 8ffae97ebe..a88c56b683 100644 --- a/lib/ansible/modules/network/dellos10/dellos10_command.py +++ b/lib/ansible/modules/network/dellos10/dellos10_command.py @@ -43,8 +43,6 @@ options: before moving forward. If the conditional is not true within the configured number of I(retries), the task fails. See examples. - required: false - default: null version_added: "2.2" match: description: @@ -54,7 +52,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.5" @@ -64,7 +61,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -72,7 +68,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/dellos10/dellos10_config.py b/lib/ansible/modules/network/dellos10/dellos10_config.py index 369807e25f..85fe00bc81 100644 --- a/lib/ansible/modules/network/dellos10/dellos10_config.py +++ b/lib/ansible/modules/network/dellos10/dellos10_config.py @@ -34,8 +34,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. This argument is mutually exclusive with I(src). - required: false - default: null aliases: ['commands'] parents: description: @@ -43,8 +41,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -52,8 +48,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -61,16 +55,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -81,7 +71,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -92,7 +81,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] update: @@ -104,7 +92,6 @@ options: device running configuration. When you set this argument to I(check) the configuration updates are determined but not actually configured on the remote device. - required: false default: merge choices: ['merge', 'check'] save: @@ -112,9 +99,8 @@ options: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' config: description: - The module, by default, will connect to the remote device and @@ -124,8 +110,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null backup: description: - This argument will cause the module to create a full backup of @@ -133,9 +117,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/dellos10/dellos10_facts.py b/lib/ansible/modules/network/dellos10/dellos10_facts.py index 68ba9c1cc2..90dd1b5c10 100644 --- a/lib/ansible/modules/network/dellos10/dellos10_facts.py +++ b/lib/ansible/modules/network/dellos10/dellos10_facts.py @@ -35,8 +35,7 @@ options: values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should not be collected. - required: false - default: '!config' + default: [ '!config' ] """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/dellos6/dellos6_command.py b/lib/ansible/modules/network/dellos6/dellos6_command.py index 8f7b205019..addce851a6 100644 --- a/lib/ansible/modules/network/dellos6/dellos6_command.py +++ b/lib/ansible/modules/network/dellos6/dellos6_command.py @@ -42,8 +42,6 @@ options: before moving forward. If the conditional is not true within the configured number of I(retries), the task fails. See examples. - required: false - default: null version_added: "2.2" match: description: @@ -53,7 +51,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.5" @@ -63,7 +60,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -71,7 +67,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/dellos6/dellos6_config.py b/lib/ansible/modules/network/dellos6/dellos6_config.py index 0b3748f44f..98283a6251 100644 --- a/lib/ansible/modules/network/dellos6/dellos6_config.py +++ b/lib/ansible/modules/network/dellos6/dellos6_config.py @@ -32,8 +32,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. This argument is mutually exclusive with I(src). - required: false - default: null aliases: ['commands'] parents: description: @@ -41,8 +39,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -50,8 +46,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -59,16 +53,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -79,7 +69,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -90,7 +79,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] update: @@ -102,7 +90,6 @@ options: device running configuration. When you set this argument to I(check) the configuration updates are determined but not actually configured on the remote device. - required: false default: merge choices: ['merge', 'check'] save: @@ -110,9 +97,8 @@ options: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' config: description: - The module, by default, will connect to the remote device and @@ -122,8 +108,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null backup: description: - This argument will cause the module to create a full backup of @@ -131,9 +115,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/dellos6/dellos6_facts.py b/lib/ansible/modules/network/dellos6/dellos6_facts.py index a36ea714f0..4ea8ac70e0 100644 --- a/lib/ansible/modules/network/dellos6/dellos6_facts.py +++ b/lib/ansible/modules/network/dellos6/dellos6_facts.py @@ -35,8 +35,7 @@ options: values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should not be collected. - required: false - default: '!config' + default: [ '!config' ] """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/dellos9/dellos9_command.py b/lib/ansible/modules/network/dellos9/dellos9_command.py index b7a6715458..cdd2bb87f8 100644 --- a/lib/ansible/modules/network/dellos9/dellos9_command.py +++ b/lib/ansible/modules/network/dellos9/dellos9_command.py @@ -42,8 +42,6 @@ options: before moving forward. If the conditional is not true within the configured number of I(retries), the task fails. See examples. - required: false - default: null version_added: "2.2" match: description: @@ -53,7 +51,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.5" @@ -63,7 +60,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -71,7 +67,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 notes: diff --git a/lib/ansible/modules/network/dellos9/dellos9_config.py b/lib/ansible/modules/network/dellos9/dellos9_config.py index 4b53679939..339faaecf8 100644 --- a/lib/ansible/modules/network/dellos9/dellos9_config.py +++ b/lib/ansible/modules/network/dellos9/dellos9_config.py @@ -33,8 +33,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. This argument is mutually exclusive with I(src). - required: false - default: null aliases: ['commands'] parents: description: @@ -42,8 +40,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -51,8 +47,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -60,16 +54,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -80,7 +70,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -91,7 +80,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] update: @@ -103,7 +91,6 @@ options: device running configuration. When you set this argument to I(check) the configuration updates are determined but not actually configured on the remote device. - required: false default: merge choices: ['merge', 'check'] save: @@ -111,9 +98,8 @@ options: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false + type: bool default: no - choices: ['yes', 'no'] config: description: - The module, by default, will connect to the remote device and @@ -123,8 +109,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null backup: description: - This argument will cause the module to create a full backup of @@ -132,9 +116,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' notes: - This module requires Dell OS9 version 9.10.0.1P13 or above. diff --git a/lib/ansible/modules/network/dellos9/dellos9_facts.py b/lib/ansible/modules/network/dellos9/dellos9_facts.py index 23d7a41d8d..3c17a1b5e0 100644 --- a/lib/ansible/modules/network/dellos9/dellos9_facts.py +++ b/lib/ansible/modules/network/dellos9/dellos9_facts.py @@ -35,8 +35,7 @@ options: values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should not be collected. - required: false - default: '!config' + default: [ '!config' ] notes: - This module requires OS9 version 9.10.0.1P13 or above. diff --git a/lib/ansible/modules/network/edgeos/edgeos_config.py b/lib/ansible/modules/network/edgeos/edgeos_config.py index 6ca11069d6..1ce4af6ae4 100644 --- a/lib/ansible/modules/network/edgeos/edgeos_config.py +++ b/lib/ansible/modules/network/edgeos/edgeos_config.py @@ -36,16 +36,12 @@ options: - The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. - required: false - default: null src: description: - The C(src) argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables. - required: no - default: null match: description: - The C(match) argument controls the method used to match @@ -54,7 +50,6 @@ options: deltas are loaded. If the C(match) argument is set to C(none) the active configuration is ignored and the configuration is always loaded. - required: false default: line choices: ['line', 'none'] backup: @@ -63,15 +58,13 @@ options: configuration to the Ansible control host prior to making any changes. The backup file will be located in the backup folder in the root of the playbook - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' comment: description: - Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored. - required: false default: 'configured by edgeos_config' config: description: @@ -79,17 +72,14 @@ options: to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device. - required: false - default: null save: description: - The C(save) argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to C(True), the active configuration is saved. - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/enos/enos_command.py b/lib/ansible/modules/network/enos/enos_command.py index 0818fa60bb..c5497ab269 100644 --- a/lib/ansible/modules/network/enos/enos_command.py +++ b/lib/ansible/modules/network/enos/enos_command.py @@ -53,8 +53,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null match: description: - The I(match) argument is used in conjunction with the @@ -63,7 +61,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -72,7 +69,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -80,7 +76,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/enos/enos_config.py b/lib/ansible/modules/network/enos/enos_config.py index 265c0a6647..a247992870 100644 --- a/lib/ansible/modules/network/enos/enos_config.py +++ b/lib/ansible/modules/network/enos/enos_config.py @@ -47,8 +47,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -56,8 +54,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -65,8 +61,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -74,16 +68,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -94,7 +84,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -105,7 +94,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block', 'config'] config: @@ -117,8 +105,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null backup: description: - This argument will cause the module to create a full backup of @@ -126,23 +112,20 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' comment: description: - Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored. - required: false default: 'configured by enos_config' admin: description: - Enters into administration configuration mode for making config changes to the device. - required: false - default: false - choices: [ "yes", "no" ] + type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/eos/eos_banner.py b/lib/ansible/modules/network/eos/eos_banner.py index d080fef06c..bec70da2ba 100644 --- a/lib/ansible/modules/network/eos/eos_banner.py +++ b/lib/ansible/modules/network/eos/eos_banner.py @@ -40,14 +40,12 @@ options: - Specifies which banner that should be configured on the remote device. required: true - default: null choices: ['login', 'motd'] text: description: - The banner text that should be present in the remote device running configuration. This argument accepts a multiline string. Requires I(state=present). - default: null state: description: - Specifies whether or not the configuration is diff --git a/lib/ansible/modules/network/eos/eos_command.py b/lib/ansible/modules/network/eos/eos_command.py index 540f45f387..63952c5e4f 100644 --- a/lib/ansible/modules/network/eos/eos_command.py +++ b/lib/ansible/modules/network/eos/eos_command.py @@ -53,8 +53,6 @@ options: by the configured retries, the task fails. Note - With I(wait_for) the value in C(result['stdout']) can be accessed using C(result), that is to access C(result['stdout'][0]) use C(result[0]) See examples. - required: false - default: null aliases: ['waitfor'] version_added: "2.2" match: @@ -65,7 +63,6 @@ options: then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.2" @@ -75,7 +72,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. - required: false default: 10 interval: description: @@ -83,7 +79,6 @@ options: of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/eos/eos_config.py b/lib/ansible/modules/network/eos/eos_config.py index 2d1cd133c8..658d155437 100644 --- a/lib/ansible/modules/network/eos/eos_config.py +++ b/lib/ansible/modules/network/eos/eos_config.py @@ -44,17 +44,13 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false aliases: ['commands'] - default: null parents: description: - The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - The I(src) argument provides a path to the configuration file @@ -65,8 +61,6 @@ options: I(parents) arguments. It can be a Jinja2 template as well. src file must have same indentation as a live switch config. Arista EOS device config has 3 spaces indentation. - required: false - default: null version_added: "2.2" before: description: @@ -75,16 +69,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -95,7 +85,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -106,7 +95,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block', 'config'] force: @@ -118,9 +106,8 @@ options: - Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in Ansible 2.6. - required: false - default: false type: bool + default: 'no' backup: description: - This argument will cause the module to create a full backup of @@ -128,9 +115,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' version_added: "2.2" running_config: description: @@ -141,8 +127,6 @@ options: every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for this module. - required: false - default: null aliases: ['config'] version_added: "2.4" defaults: @@ -152,9 +136,8 @@ options: the command used to collect the running-config is append with the all keyword. When the value is set to false, the command is issued without the all keyword - required: false - default: false type: bool + default: 'no' version_added: "2.2" save: description: @@ -166,9 +149,8 @@ options: return changed. - This option is deprecated as of Ansible 2.4 and will be removed in Ansible 2.8, use C(save_when) instead. - required: false - default: false type: bool + default: 'no' version_added: "2.2" save_when: description: @@ -184,7 +166,6 @@ options: startup-config. If the argument is set to I(changed), then the running-config will only be copied to the startup-config if the task has made a change. I(changed) was added in Ansible 2.5. - required: false default: never choices: ['always', 'never', 'modified', 'changed'] version_added: "2.4" @@ -202,7 +183,6 @@ options: to any changes made to the device configuration. - When this option is configured as C(session), the diff returned will be based on the configuration session. - required: false default: session choices: ['startup', 'running', 'intended', 'session'] version_added: "2.4" @@ -212,7 +192,6 @@ options: ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. - required: false version_added: "2.4" intended_config: description: @@ -223,7 +202,6 @@ options: of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). - required: false version_added: "2.4" """ diff --git a/lib/ansible/modules/network/eos/eos_eapi.py b/lib/ansible/modules/network/eos/eos_eapi.py index 1ad7e853a7..6d822603a0 100644 --- a/lib/ansible/modules/network/eos/eos_eapi.py +++ b/lib/ansible/modules/network/eos/eos_eapi.py @@ -47,16 +47,14 @@ options: when the value is set to False, the HTTP protocol is disabled. By default, when eAPI is first configured, the HTTP protocol is disabled. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' aliases: ['enable_http'] http_port: description: - Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled. This argument accepts integer values in the valid range of 1 to 65535. - required: false default: 80 https: description: @@ -66,16 +64,14 @@ options: when the value is set to False, the HTTPS protocol is disabled. By default, when eAPI is first configured, the HTTPS protocol is enabled. - required: false - default: yes - choices: ['yes', 'no'] + type: bool + default: 'yes' aliases: ['enable_https'] https_port: description: - Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled. This argument accepts integer values in the valid range of 1 to 65535. - required: false default: 443 local_http: description: @@ -85,16 +81,14 @@ options: is enabled and restricted to connections from localhost only. When the value is set to False, the HTTP local protocol is disabled. - Note is value is independent of the C(http) argument - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' aliases: ['enable_local_http'] local_http_port: description: - Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled. This argument accepts integer values in the valid range of 1 to 65535. - required: false default: 8080 socket: description: @@ -104,9 +98,8 @@ options: requests. When the value is set to False, the UDS will not be available to handle requests. By default when eAPI is first configured, the UDS is disabled. - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' aliases: ['enable_socket'] vrf: description: @@ -114,7 +107,6 @@ options: in the specified VRF. By default, eAPI transports will listen for connections in the global table. This value requires the VRF to already be created otherwise the task will fail. - required: false default: default version_added: "2.2" config: @@ -126,8 +118,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: nul version_added: "2.2" state: description: @@ -135,7 +125,6 @@ options: on the remote device. When this argument is set to C(started), eAPI is enabled to receive requests and when this argument is C(stopped), eAPI is disabled and will not receive requests. - required: false default: started choices: ['started', 'stopped'] """ diff --git a/lib/ansible/modules/network/f5/bigip_facts.py b/lib/ansible/modules/network/f5/bigip_facts.py index 4da6d29dbf..ce97390bda 100644 --- a/lib/ansible/modules/network/f5/bigip_facts.py +++ b/lib/ansible/modules/network/f5/bigip_facts.py @@ -36,15 +36,12 @@ options: description: - BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances. - required: false - default: true - choices: [] - aliases: [] + type: bool + default: 'yes' include: description: - Fact category or list of categories to collect required: true - default: null choices: - address_class - certificate @@ -65,15 +62,10 @@ options: - virtual_address - virtual_server - vlan - aliases: [] filter: description: - Shell-style glob matching string used to filter fact keys. Not applicable for software, provision, and system_info fact categories. - required: false - default: null - choices: [] - aliases: [] extends_documentation_fragment: f5 ''' diff --git a/lib/ansible/modules/network/ios/ios_banner.py b/lib/ansible/modules/network/ios/ios_banner.py index 4ecb3f4941..8694813ce7 100644 --- a/lib/ansible/modules/network/ios/ios_banner.py +++ b/lib/ansible/modules/network/ios/ios_banner.py @@ -40,14 +40,12 @@ options: - Specifies which banner should be configured on the remote device. In Ansible 2.4 and earlier only I(login) and I(motd) were supported. required: true - default: null choices: ['login', 'motd', 'exec', 'incoming', 'slip-ppp'] text: description: - The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires I(state=present). - default: null state: description: - Specifies whether or not the configuration is diff --git a/lib/ansible/modules/network/ios/ios_command.py b/lib/ansible/modules/network/ios/ios_command.py index 90d3f32c52..8aae27ed15 100644 --- a/lib/ansible/modules/network/ios/ios_command.py +++ b/lib/ansible/modules/network/ios/ios_command.py @@ -55,8 +55,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] version_added: "2.2" match: @@ -67,7 +65,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.2" @@ -77,7 +74,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -85,7 +81,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index 326ed1a74e..321c9f0374 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -43,8 +43,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -52,8 +50,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -61,8 +57,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null version_added: "2.2" before: description: @@ -71,16 +65,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -91,9 +81,8 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false - default: line choices: ['line', 'strict', 'exact', 'none'] + default: line replace: description: - Instructs the module on the way to perform the configuration @@ -102,7 +91,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] multiline_delimiter: @@ -111,7 +99,6 @@ options: element to the IOS device. It specifies the character to use as the delimiting character. This only applies to the configuration action. - required: false default: "@" version_added: "2.3" force: @@ -123,9 +110,8 @@ options: - Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in Ansible 2.6. - required: false - default: false type: bool + default: 'no' backup: description: - This argument will cause the module to create a full backup of @@ -133,9 +119,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no type: bool + default: 'no' version_added: "2.2" running_config: description: @@ -146,8 +131,6 @@ options: every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null aliases: ['config'] version_added: "2.4" defaults: @@ -156,9 +139,8 @@ options: when getting the remote device running config. When enabled, the module will get the current config by issuing the command C(show running-config all). - required: false - default: no type: bool + default: 'no' version_added: "2.2" save: description: @@ -167,9 +149,8 @@ options: running. If check mode is specified, this argument is ignored. - This option is deprecated as of Ansible 2.4 and will be removed in Ansible 2.8, use C(save_when) instead. - required: false - default: false type: bool + default: 'no' version_added: "2.2" save_when: description: @@ -185,7 +166,6 @@ options: startup-config. If the argument is set to I(changed), then the running-config will only be copied to the startup-config if the task has made a change. I(changed) was added in Ansible 2.5. - required: false default: never choices: ['always', 'never', 'modified', 'changed'] version_added: "2.4" @@ -201,7 +181,6 @@ options: - When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. - required: false choices: ['running', 'startup', 'intended'] version_added: "2.4" diff_ignore_lines: @@ -210,7 +189,6 @@ options: ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. - required: false version_added: "2.4" intended_config: description: @@ -221,7 +199,6 @@ options: of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). - required: false version_added: "2.4" """ diff --git a/lib/ansible/modules/network/ios/ios_ping.py b/lib/ansible/modules/network/ios/ios_ping.py index 65c80a5608..7a70e3c9c3 100644 --- a/lib/ansible/modules/network/ios/ios_ping.py +++ b/lib/ansible/modules/network/ios/ios_ping.py @@ -27,7 +27,6 @@ options: count: description: - Number of packets to send. - required: false default: 5 dest: description: @@ -36,8 +35,6 @@ options: source: description: - The source IP Address. - required: false - default: null state: description: - Determines if the expected result is success or fail. @@ -46,7 +43,6 @@ options: vrf: description: - The VRF to use for forwarding. - required: false default: default notes: - For a general purpose network module, see the M(net_ping) module. diff --git a/lib/ansible/modules/network/iosxr/iosxr_banner.py b/lib/ansible/modules/network/iosxr/iosxr_banner.py index c2c019435b..be6e45afc4 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_banner.py +++ b/lib/ansible/modules/network/iosxr/iosxr_banner.py @@ -32,13 +32,11 @@ options: description: - Specifies the type of banner to configure on remote device. required: true - default: null choices: ['login', 'motd'] text: description: - Banner text to be configured. Accepts multiline string, without empty lines. Requires I(state=present). - default: null state: description: - Existential state of the configuration on the device. diff --git a/lib/ansible/modules/network/iosxr/iosxr_command.py b/lib/ansible/modules/network/iosxr/iosxr_command.py index f165c05e89..062abd3ae6 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_command.py +++ b/lib/ansible/modules/network/iosxr/iosxr_command.py @@ -45,8 +45,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] version_added: "2.2" match: @@ -57,7 +55,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.2" @@ -67,7 +64,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -75,7 +71,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/iosxr/iosxr_config.py b/lib/ansible/modules/network/iosxr/iosxr_config.py index 10a98b109f..0d0fbf4c1c 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_config.py +++ b/lib/ansible/modules/network/iosxr/iosxr_config.py @@ -37,8 +37,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -46,8 +44,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -55,8 +51,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null version_added: "2.2" before: description: @@ -65,16 +59,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -85,7 +75,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -96,7 +85,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block', 'config'] force: @@ -108,9 +96,8 @@ options: - Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in a future release. - required: false - default: false - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.2" config: description: @@ -121,8 +108,6 @@ options: every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null backup: description: - This argument will cause the module to create a full backup of @@ -130,25 +115,22 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' version_added: "2.2" comment: description: - Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored. - required: false default: 'configured by iosxr_config' version_added: "2.2" admin: description: - Enters into administration configuration mode for making config changes to the device. - required: false - default: false - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.4" """ diff --git a/lib/ansible/modules/network/ironware/ironware_command.py b/lib/ansible/modules/network/ironware/ironware_command.py index 22892f7ea5..952aa00ccf 100644 --- a/lib/ansible/modules/network/ironware/ironware_command.py +++ b/lib/ansible/modules/network/ironware/ironware_command.py @@ -40,8 +40,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null match: description: - The I(match) argument is used in conjunction with the @@ -49,7 +47,6 @@ options: is set to C(all) then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -58,7 +55,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -66,7 +62,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/ironware/ironware_config.py b/lib/ansible/modules/network/ironware/ironware_config.py index 2b8b48c913..651b8c4d75 100644 --- a/lib/ansible/modules/network/ironware/ironware_config.py +++ b/lib/ansible/modules/network/ironware/ironware_config.py @@ -32,8 +32,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -41,8 +39,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -50,8 +46,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -59,16 +53,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -79,7 +69,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -90,7 +79,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct - required: false default: line choices: ['line', 'block'] update: @@ -102,7 +90,6 @@ options: device running configuration. When the argument is set to I(check) the configuration updates are determined but not actually configured on the remote device. - required: false default: merge choices: ['merge', 'check'] commit: @@ -112,7 +99,6 @@ options: I(merge) the configuration updates are merged with the running- config. If the value is set to I(check), no changes are made to the remote host. - required: false default: merge choices: ['merge', 'check'] backup: @@ -122,17 +108,14 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' config: description: - The C(config) argument allows the playbook designer to supply the base configuration to be used to validate configuration changes necessary. If this argument is provided, the module will not download the running-config from the remote node. - required: false - default: null save_when: description: - When changes are made to the device running-configuration, the @@ -145,7 +128,6 @@ options: the last save to startup-config. If the argument is set to I(never), the running-config will never be copied to the startup-config - required: false default: never choices: ['always', 'never', 'modified'] version_added: "2.4" diff --git a/lib/ansible/modules/network/junos/junos_banner.py b/lib/ansible/modules/network/junos/junos_banner.py index dd3f8ef95a..5656e6a663 100644 --- a/lib/ansible/modules/network/junos/junos_banner.py +++ b/lib/ansible/modules/network/junos/junos_banner.py @@ -36,7 +36,6 @@ options: - The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires I(state=present). - default: null state: description: - Specifies whether or not the configuration is @@ -46,8 +45,8 @@ options: active: description: - Specifies whether or not the configuration is active or deactivated - default: True - choices: [True, False] + type: bool + default: 'yes' requirements: - ncclient (>=v0.5.2) notes: diff --git a/lib/ansible/modules/network/junos/junos_command.py b/lib/ansible/modules/network/junos/junos_command.py index cc8ae31901..ae133eed8a 100644 --- a/lib/ansible/modules/network/junos/junos_command.py +++ b/lib/ansible/modules/network/junos/junos_command.py @@ -33,15 +33,11 @@ options: is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of I(retries) has been exceeded. - required: false - default: null rpcs: description: - The C(rpcs) argument accepts a list of RPCs to be executed over a netconf session and the results from the RPC execution is return to the playbook via the modules results dictionary. - required: false - default: null version_added: "2.3" wait_for: description: @@ -50,8 +46,6 @@ options: the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] version_added: "2.2" match: @@ -62,7 +56,6 @@ options: then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] version_added: "2.2" @@ -72,7 +65,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. - required: false default: 10 interval: description: @@ -80,7 +72,6 @@ options: of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. - required: false default: 1 display: description: @@ -90,7 +81,6 @@ options: display is C(xml) and for I(commands) argument default display is C(text). Value C(set) is applicable only for fetching configuration from device. - required: false default: depends on input argument I(rpcs) or I(commands) aliases: ['format', 'output'] choices: ['text', 'json', 'xml', 'set'] diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index 10e6d7e3d2..5852362689 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -32,8 +32,6 @@ options: lines to push into the remote device. Each line must start with either C(set) or C(delete). This argument is mutually exclusive with the I(src) argument. - required: false - default: null src: description: - The I(src) argument provides a path to the configuration file @@ -41,8 +39,6 @@ options: system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) argument. - required: false - default: null version_added: "2.2" src_format: description: @@ -50,8 +46,6 @@ options: found int I(src). If the I(src_format) argument is not provided, the module will attempt to determine the format of the configuration file specified in I(src). - required: false - default: null choices: ['xml', 'set', 'text', 'json'] version_added: "2.2" rollback: @@ -61,16 +55,12 @@ options: argument. If the specified rollback identifier does not exist on the remote device, the module will fail. To rollback to the most recent commit, set the C(rollback) argument to 0. - required: false - default: null zeroize: description: - The C(zeroize) argument is used to completely sanitize the remote device configuration back to initial defaults. This argument will effectively remove all current configuration statements on the remote device. - required: false - default: null confirm: description: - The C(confirm) argument will configure a time out value for @@ -78,14 +68,12 @@ options: rolled back. If the C(confirm) argument is set to False, this argument is silently ignored. If the value for this argument is set to 0, the commit is confirmed immediately. - required: false default: 0 comment: description: - The C(comment) argument specifies a text string to be used when committing the configuration. If the C(confirm) argument is set to False, this argument is silently ignored. - required: false default: configured by junos_config replace: description: @@ -97,9 +85,8 @@ options: the equivalent, set the I(update) argument to C(replace). This argument will be removed in a future release. The C(replace) and C(update) argument is mutually exclusive. - required: false - choices: ['yes', 'no'] - default: false + type: bool + default: 'no' backup: description: - This argument will cause the module to create a full backup of @@ -107,9 +94,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' version_added: "2.2" update: description: @@ -125,7 +111,6 @@ options: it with the loaded configuration. C(replace) substitutes each hierarchy level in the loaded configuration for the corresponding level. - required: false default: merge choices: ['merge', 'override', 'replace'] version_added: "2.3" @@ -133,9 +118,8 @@ options: description: - This argument will execute commit operation on remote device. It can be used to confirm a previous commit. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' version_added: "2.4" requirements: - ncclient (>=v0.5.2) diff --git a/lib/ansible/modules/network/junos/junos_package.py b/lib/ansible/modules/network/junos/junos_package.py index fcaae78ad9..aa5c80675a 100644 --- a/lib/ansible/modules/network/junos/junos_package.py +++ b/lib/ansible/modules/network/junos/junos_package.py @@ -33,7 +33,6 @@ options: The I(src) argument can be either a localized path or a full path to the package file to install. required: true - default: null aliases: ['package'] version: description: @@ -41,8 +40,6 @@ options: version of the package that should be installed on the remote device. If the I(version) argument is not specified, then the version is extracts from the I(src) filename. - required: false - default: null reboot: description: - In order for a package to take effect, the remote device must be @@ -51,16 +48,15 @@ options: If disabled or the remote package does not need to be changed, the device will not be started. required: true - default: true - choices: ['true', 'false'] + type: bool + default: 'yes' no_copy: description: - The I(no_copy) argument is responsible for instructing the remote device on where to install the package from. When enabled, the package is transferred to the remote device prior to installing. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' validate: description: - The I(validate) argument is responsible for instructing the remote @@ -68,17 +64,16 @@ options: compatibility with the package being installed. When set to false validation is not performed. version_added: 2.5 - required: false - default: true - choices: ['true', 'false'] + type: bool + default: 'yes' force: description: - The I(force) argument instructs the module to bypass the package version check and install the packaged identified in I(src) on the remote device. required: true - default: false - choices: ['true', 'false'] + type: bool + default: 'no' requirements: - junos-eznc - ncclient (>=v0.5.2) diff --git a/lib/ansible/modules/network/junos/junos_rpc.py b/lib/ansible/modules/network/junos/junos_rpc.py index c231153f63..05d1cd13cb 100644 --- a/lib/ansible/modules/network/junos/junos_rpc.py +++ b/lib/ansible/modules/network/junos/junos_rpc.py @@ -37,8 +37,6 @@ options: - The C(args) argument provides a set of arguments for the RPC call and are encoded in the request message. This argument accepts a set of key=value arguments. - required: false - default: null attrs: description: - The C(attrs) arguments defines a list of attributes and their values @@ -50,7 +48,6 @@ options: return data. This argument accepts one of C(xml), C(text), or C(json). For C(json), the JUNOS device must be running a version of software that supports native JSON output. - required: false default: xml requirements: - ncclient (>=v0.5.2) diff --git a/lib/ansible/modules/network/junos/junos_scp.py b/lib/ansible/modules/network/junos/junos_scp.py index e03f71aafa..d0f2e80198 100644 --- a/lib/ansible/modules/network/junos/junos_scp.py +++ b/lib/ansible/modules/network/junos/junos_scp.py @@ -30,27 +30,23 @@ options: transfered. The argument C(recursive) must be C(true) to transfer directories. required: true - default: null dest: description: - The C(dest) argument specifies the path in which to receive the files. - required: false default: '.' recursive: description: - The C(recursive) argument enables recursive transfer of files and directories. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' remote_src: description: - The C(remote_src) argument enables the download of files (I(scp get)) from the remote device. The default behavior is to upload files (I(scp put)) to the remote device. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' requirements: - junos-eznc - ncclient (>=v0.5.2) diff --git a/lib/ansible/modules/network/junos/junos_user.py b/lib/ansible/modules/network/junos/junos_user.py index f936ff85e0..66a05a9176 100644 --- a/lib/ansible/modules/network/junos/junos_user.py +++ b/lib/ansible/modules/network/junos/junos_user.py @@ -34,8 +34,6 @@ options: the device configuration. This argument is mutually exclusive with the name argument. version_added: "2.4" - required: False - default: null aliases: ['users', 'collection'] name: description: @@ -43,37 +41,30 @@ options: on the system. This argument must follow appropriate usernaming conventions for the target device running JUNOS. This argument is mutually exclusive with the C(aggregate) argument. - required: false - default: null full_name: description: - The C(full_name) argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value. - required: false - default: null role: description: - The C(role) argument defines the role of the user account on the remote system. User accounts can have more than one role configured. - required: false choices: ['operator', 'read-only', 'super-user', 'unauthorized'] sshkey: description: - The C(sshkey) argument defines the public SSH key to be configured for the user account on the remote system. This argument must be a valid SSH key - required: false - default: null purge: description: - The C(purge) argument instructs the module to consider the users definition absolute. It will remove any previously configured users on the device with the exception of the current defined set of aggregate. - required: false - default: false + type: bool + default: 'no' state: description: - The C(state) argument configures the state of the user definitions @@ -81,14 +72,13 @@ options: to I(present), the user should be configured in the device active configuration and when set to I(absent) the user should not be in the device active configuration - required: false default: present choices: ['present', 'absent'] active: description: - Specifies whether or not the configuration is active or deactivated - default: True - choices: [True, False] + type: bool + default: 'yes' version_added: "2.4" requirements: - ncclient (>=v0.5.2) diff --git a/lib/ansible/modules/network/nuage/nuage_vspk.py b/lib/ansible/modules/network/nuage/nuage_vspk.py index 287bfa8ef9..6a147367e5 100644 --- a/lib/ansible/modules/network/nuage/nuage_vspk.py +++ b/lib/ansible/modules/network/nuage/nuage_vspk.py @@ -31,38 +31,30 @@ options: - Requires a I(api_url) parameter (example https://10.0.0.10:8443). - Requires a I(api_version) parameter (example v4_0). required: true - default: null type: description: - The type of entity you want to work on (example Enterprise). - This should match the objects CamelCase class name in VSPK-Python. - This Class name can be found on U(https://nuagenetworks.github.io/vspkdoc/index.html). required: true - default: null id: description: - The ID of the entity you want to work on. - In combination with I(command=find), it will only return the single entity. - In combination with I(state), it will either update or delete this entity. - Will take precedence over I(match_filter) and I(properties) whenever an entity needs to be found. - required: false - default: null parent_id: description: - The ID of the parent of the entity you want to work on. - When I(state) is specified, the entity will be gathered from this parent, if it exists, unless an I(id) is specified. - When I(command=find) is specified, the entity will be searched for in this parent, unless an I(id) is specified. - If specified, I(parent_type) also needs to be specified. - required: false - default: null parent_type: description: - The type of parent the ID is specified for (example Enterprise). - This should match the objects CamelCase class name in VSPK-Python. - This Class name can be found on U(https://nuagenetworks.github.io/vspkdoc/index.html). - If specified, I(parent_id) also needs to be specified. - required: false - default: null state: description: - Specifies the desired state of the entity. @@ -70,8 +62,6 @@ options: - If I(state=present), in case the relationship with the parent is a member relationship, will assign the entity as a member of the parent. - If I(state=absent), in case the relationship with the parent is a member relationship, will unassign the entity as a member of the parent. - Either I(state) or I(command) needs to be defined, both can not be defined at the same time. - required: false - default: null choices: - present - absent @@ -89,8 +79,6 @@ options: the module will exit with an error. - With I(command=wait_for_job), the job will always be returned, even if the state is ERROR situation. - Either I(state) or I(command) needs to be defined, both can not be defined at the same time. - required: false - default: null choices: - find - change_password @@ -100,14 +88,10 @@ options: description: - A filter used when looking (both in I(command) and I(state) for entities, in the format the Nuage VSP API expects. - If I(match_filter) is defined, it will take precedence over the I(properties), but not on the I(id) - required: false - default: null properties: description: - Properties are the key, value pairs of the different properties an entity has. - If no I(id) and no I(match_filter) is specified, these are used to find or determine if the entity exists. - required: false - default: null children: description: - Can be used to specify a set of child entities. @@ -116,8 +100,6 @@ options: - The function of each of these properties is the same as in the general task definition. - This can be used recursively - Only useable in case I(state=present). - required: false - default: null notes: - Check mode is supported, but with some caveats. It will not do any changes, and if possible try to determine if it is able do what is requested. - In case a parent id is provided from a previous task, it might be empty and if a search is possible on root, it will do so, which can impact performance. diff --git a/lib/ansible/modules/network/nxos/_nxos_ip_interface.py b/lib/ansible/modules/network/nxos/_nxos_ip_interface.py index 18600b2fd6..fcb19d9288 100644 --- a/lib/ansible/modules/network/nxos/_nxos_ip_interface.py +++ b/lib/ansible/modules/network/nxos/_nxos_ip_interface.py @@ -51,8 +51,6 @@ options: addr: description: - IPv4 or IPv6 Address. - required: false - default: null version: description: - Version of IP address. If the IP address is IPV4 version should be v4. @@ -62,30 +60,24 @@ options: mask: description: - Subnet mask for IPv4 or IPv6 Address in decimal format. - required: false - default: null dot1q: description: - Configures IEEE 802.1Q VLAN encapsulation on the subinterface. The range is from 2 to 4093. - required: false - default: null version_added: "2.5" tag: description: - Route tag for IPv4 or IPv6 Address in integer format. - required: false default: 0 version_added: "2.4" allow_secondary: description: - Allow to configure IPv4 secondary addresses on interface. - required: false - default: false + type: bool + default: 'no' version_added: "2.4" state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] requirements: diff --git a/lib/ansible/modules/network/nxos/_nxos_mtu.py b/lib/ansible/modules/network/nxos/_nxos_mtu.py index 6fe6707013..5fb069e765 100644 --- a/lib/ansible/modules/network/nxos/_nxos_mtu.py +++ b/lib/ansible/modules/network/nxos/_nxos_mtu.py @@ -42,22 +42,15 @@ options: interface: description: - Full name of interface, i.e. Ethernet1/1. - required: false - default: null mtu: description: - MTU for a specific interface. Must be an even number between 576 and 9216. - required: false - default: null sysmtu: description: - System jumbo MTU. Must be an even number between 576 and 9216. - required: false - default: null state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/_nxos_portchannel.py b/lib/ansible/modules/network/nxos/_nxos_portchannel.py index 575dfe8de1..68f8e22479 100644 --- a/lib/ansible/modules/network/nxos/_nxos_portchannel.py +++ b/lib/ansible/modules/network/nxos/_nxos_portchannel.py @@ -50,31 +50,24 @@ options: mode: description: - Mode for the port-channel, i.e. on, active, passive. - required: false default: on choices: ['active','passive','on'] min_links: description: - Min links required to keep portchannel up. - required: false - default: null members: description: - List of interfaces that will be managed in a given portchannel. - required: false - default: null force: description: - When true it forces port-channel members to match what is declared in the members param. This can be used to remove members. - required: false - choices: ['true', 'false'] - default: false + choices: [ 'false', 'true' ] + default: 'false' state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/_nxos_switchport.py b/lib/ansible/modules/network/nxos/_nxos_switchport.py index ed8c474525..a82b1c8d18 100644 --- a/lib/ansible/modules/network/nxos/_nxos_switchport.py +++ b/lib/ansible/modules/network/nxos/_nxos_switchport.py @@ -47,45 +47,32 @@ options: interface: description: - Full name of the interface, i.e. Ethernet1/1. - required: true - default: null mode: description: - Mode for the Layer 2 port. - required: false - default: null choices: ['access','trunk'] access_vlan: description: - If C(mode=access), used as the access VLAN ID. - required: false - default: null native_vlan: description: - If C(mode=trunk), used as the trunk native VLAN ID. - required: false - default: null trunk_vlans: description: - If C(mode=trunk), used as the VLAN range to ADD or REMOVE from the trunk. aliases: - trunk_add_vlans - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent', 'unconfigured'] trunk_allowed_vlans: description: - if C(mode=trunk), these are the only VLANs that will be configured on the trunk, i.e. "2-10,15". - required: false version_added: 2.2 - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_aaa_server.py b/lib/ansible/modules/network/nxos/nxos_aaa_server.py index e95fd4283c..db694dc35d 100644 --- a/lib/ansible/modules/network/nxos/nxos_aaa_server.py +++ b/lib/ansible/modules/network/nxos/nxos_aaa_server.py @@ -52,38 +52,27 @@ options: global_key: description: - Global AAA shared secret. - required: false - default: null encrypt_type: description: - The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported. - required: false - default: null choices: ['0', '7'] deadtime: description: - Duration for which a non-reachable AAA server is skipped, in minutes. Range is 1-1440. Device default is 0. - required: false - default: null server_timeout: description: - Global AAA server timeout period, in seconds. Range is 1-60. Device default is 5. - required: false - default: null directed_request: description: - Enables direct authentication requests to AAA server. Device default is disabled. - required: false - default: null choices: ['enabled', 'disabled'] state: description: - Manage the state of the resource. - required: true default: present choices: ['present','default'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py b/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py index 916ca1ea57..8cfb2951cd 100644 --- a/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py +++ b/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py @@ -48,40 +48,27 @@ options: key: description: - Shared secret for the specified host. - required: false - default: null encrypt_type: description: - The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported. - required: false - default: null choices: ['0', '7'] host_timeout: description: - Timeout period for specified host, in seconds. Range is 1-60. - required: false - default: null auth_port: description: - Alternate UDP port for RADIUS authentication. - required: false - default: null acct_port: description: - Alternate UDP port for RADIUS accounting. - required: false - default: null tacacs_port: description: - Alternate TCP port TACACS Server. - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_acl.py b/lib/ansible/modules/network/nxos/nxos_acl.py index 1c464d84ee..52eb188f7f 100644 --- a/lib/ansible/modules/network/nxos/nxos_acl.py +++ b/lib/ansible/modules/network/nxos/nxos_acl.py @@ -50,8 +50,6 @@ options: seq: description: - Sequence number of the entry (ACE). - required: false - default: null name: description: - Case sensitive name of the access list (ACL). @@ -59,143 +57,96 @@ options: action: description: - Action of the ACE. - required: false - default: null choices: ['permit', 'deny', 'remark'] remark: description: - If action is set to remark, this is the description. - required: false - default: null proto: description: - Port number or protocol (as supported by the switch). - required: false - default: null src: description: - Source ip and mask using IP/MASK notation and supports keyword 'any'. - required: false - default: null src_port_op: description: - Source port operands such as eq, neq, gt, lt, range. - required: false - default: null choices: ['any', 'eq', 'gt', 'lt', 'neq', 'range'] src_port1: description: - Port/protocol and also first (lower) port when using range operand. - required: false - default: null src_port2: description: - Second (end) port when using range operand. - required: false - default: null dest: description: - Destination ip and mask using IP/MASK notation and supports the keyword 'any'. - required: false - default: null dest_port_op: description: - Destination port operands such as eq, neq, gt, lt, range. - required: false - default: null choices: ['any', 'eq', 'gt', 'lt', 'neq', 'range'] dest_port1: description: - Port/protocol and also first (lower) port when using range operand. - required: false - default: null dest_port2: description: - Second (end) port when using range operand. - required: false - default: null log: description: - Log matches against this entry. - required: false - default: null choices: ['enable'] urg: description: - Match on the URG bit. - required: false - default: null choices: ['enable'] ack: description: - Match on the ACK bit. - required: false - default: null choices: ['enable'] psh: description: - Match on the PSH bit. - required: false - default: null choices: ['enable'] rst: description: - Match on the RST bit. - required: false - default: null choices: ['enable'] syn: description: - Match on the SYN bit. - required: false - default: null choices: ['enable'] fin: description: - Match on the FIN bit. - required: false - default: null choices: ['enable'] established: description: - Match established connections. - required: false - default: null choices: ['enable'] fragments: description: - Check non-initial fragments. - required: false - default: null choices: ['enable'] time_range: description: - Name of time-range to apply. - required: false - default: null precedence: description: - Match packets with given precedence. - required: false - default: null choices: ['critical', 'flash', 'flash-override', 'immediate', 'internet', 'network', 'priority', 'routine'] dscp: description: - Match packets with given dscp value. - required: false - default: null choices: ['af11', 'af12', 'af13', 'af21', 'af22', 'af23','af31','af32', 'af33', 'af41', 'af42', 'af43', 'cs1', 'cs2', 'cs3', 'cs4', 'cs5', 'cs6', 'cs7', 'default', 'ef'] state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent','delete_acl'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_banner.py b/lib/ansible/modules/network/nxos/nxos_banner.py index ae4a7b04e8..65bced04a5 100644 --- a/lib/ansible/modules/network/nxos/nxos_banner.py +++ b/lib/ansible/modules/network/nxos/nxos_banner.py @@ -39,14 +39,12 @@ options: - Specifies which banner that should be configured on the remote device. required: true - default: null choices: ['exec', 'motd'] text: description: - The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires I(state=present). - default: null state: description: - Specifies whether or not the configuration is present in the current diff --git a/lib/ansible/modules/network/nxos/nxos_bgp.py b/lib/ansible/modules/network/nxos/nxos_bgp.py index 1f5f9fdbd8..f8a85ede97 100644 --- a/lib/ansible/modules/network/nxos/nxos_bgp.py +++ b/lib/ansible/modules/network/nxos/nxos_bgp.py @@ -49,239 +49,167 @@ options: description: - Name of the VRF. The name 'default' is a valid VRF representing the global BGP. - required: false - default: null bestpath_always_compare_med: description: - Enable/Disable MED comparison on paths from different autonomous systems. - required: false - choices: ['true','false'] - default: null + type: bool bestpath_aspath_multipath_relax: description: - Enable/Disable load sharing across the providers with different (but equal-length) AS paths. - required: false - choices: ['true','false'] - default: null + type: bool bestpath_compare_routerid: description: - Enable/Disable comparison of router IDs for identical eBGP paths. - required: false - choices: ['true','false'] - default: null + type: bool bestpath_compare_neighborid: description: - Enable/Disable neighborid. Use this when more paths available than max path config. - choices: ['true', 'false'] + type: bool bestpath_cost_community_ignore: description: - Enable/Disable Ignores the cost community for BGP best-path calculations. - required: false - choices: ['true','false'] - default: null + type: bool bestpath_med_confed: description: - Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation. - required: false - choices: ['true','false'] - default: null + type: bool bestpath_med_missing_as_worst: description: - Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable. - required: false - choices: ['true','false'] - default: null + type: bool bestpath_med_non_deterministic: description: - Enable/Disable deterministic selection of the best MED pat from among the paths from the same autonomous system. - required: false - choices: ['true','false'] - default: null + type: bool cluster_id: description: - Route Reflector Cluster-ID. - required: false - default: null confederation_id: description: - Routing domain confederation AS. - required: false - default: null confederation_peers: description: - AS confederation parameters. - required: false - default: null disable_policy_batching: description: - Enable/Disable the batching evaluation of prefix advertisement to all peers. - required: false - choices: ['true','false'] - default: null + type: bool disable_policy_batching_ipv4_prefix_list: description: - Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list. - required: false - default: null disable_policy_batching_ipv6_prefix_list: description: - Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list. - required: false enforce_first_as: description: - Enable/Disable enforces the neighbor autonomous system to be the first AS number listed in the AS path attribute for eBGP. On NX-OS, this property is only supported in the global BGP context. - required: false - choices: ['true','false'] - default: null + type: bool event_history_cli: description: - Enable/Disable cli event history buffer. - required: false choices: ['size_small', 'size_medium', 'size_large', 'size_disable', 'default'] - default: null event_history_detail: description: - Enable/Disable detail event history buffer. - required: false choices: ['size_small', 'size_medium', 'size_large', 'size_disable', 'default'] - default: null event_history_events: description: - Enable/Disable event history buffer. - required: false choices: ['size_small', 'size_medium', 'size_large', 'size_disable', 'default'] - default: null event_history_periodic: description: - Enable/Disable periodic event history buffer. - required: false choices: ['size_small', 'size_medium', 'size_large', 'size_disable', 'default'] fast_external_fallover: description: - Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down. Only supported in the global BGP context. - required: false - choices: ['true','false'] - default: null + type: bool flush_routes: description: - Enable/Disable flush routes in RIB upon controlled restart. On NX-OS, this property is only supported in the global BGP context. - required: false - choices: ['true','false'] - default: null + type: bool graceful_restart: description: - Enable/Disable graceful restart. - required: false - choices: ['true','false'] - default: null + type: bool graceful_restart_helper: description: - Enable/Disable graceful restart helper mode. - required: false - choices: ['true','false'] - default: null + type: bool graceful_restart_timers_restart: description: - Set maximum time for a restart sent to the BGP peer. - required: false - default: null graceful_restart_timers_stalepath_time: description: - Set maximum time that BGP keeps the stale routes from the restarting BGP peer. - default: null isolate: description: - Enable/Disable isolate this router from BGP perspective. - required: false - choices: ['true','false'] - default: null + type: bool local_as: description: - Local AS number to be used within a VRF instance. - required: false - default: null log_neighbor_changes: description: - Enable/Disable message logging for neighbor up/down event. - required: false - choices: ['true','false'] - default: null + type: bool maxas_limit: description: - Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are between 1 and 512. - required: false - default: null neighbor_down_fib_accelerate: description: - Enable/Disable handle BGP neighbor down event, due to various reasons. - required: false - choices: ['true','false'] - default: null + type: bool reconnect_interval: description: - The BGP reconnection interval for dropped sessions. Valid values are between 1 and 60. - required: false - default: null router_id: description: - Router Identifier (ID) of the BGP router VRF instance. - required: false - default: null shutdown: description: - Administratively shutdown the BGP protocol. - required: false - choices: ['true','false'] - default: null + type: bool suppress_fib_pending: description: - Enable/Disable advertise only routes programmed in hardware to peers. - required: false - choices: ['true','false'] - default: null + type: bool timer_bestpath_limit: description: - Specify timeout for the first best path after a restart, in seconds. - required: false - default: null timer_bgp_hold: description: - Set BGP hold timer. - required: false - default: null timer_bgp_keepalive: description: - Set BGP keepalive timer. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_bgp_af.py b/lib/ansible/modules/network/nxos/nxos_bgp_af.py index d055274a44..76a0245ec4 100644 --- a/lib/ansible/modules/network/nxos/nxos_bgp_af.py +++ b/lib/ansible/modules/network/nxos/nxos_bgp_af.py @@ -60,115 +60,80 @@ options: - Install a backup path into the forwarding table and provide prefix independent convergence (PIC) in case of a PE-CE link failure. - required: false - choices: ['true','false'] - default: null + type: bool additional_paths_receive: description: - Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled. - required: false - choices: ['true','false'] - default: null + type: bool additional_paths_selection: description: - Configures the capability of selecting additional paths for a prefix. Valid values are a string defining the name of the route-map. - required: false - default: null additional_paths_send: description: - Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled. - required: false - choices: ['true','false'] - default: null + type: bool advertise_l2vpn_evpn: description: - Advertise evpn routes. - required: false - choices: ['true','false'] - default: null + type: bool client_to_client: description: - Configure client-to-client route reflection. - required: false - choices: ['true','false'] - default: null + type: bool dampen_igp_metric: description: - Specify dampen value for IGP metric-related changes, in seconds. Valid values are integer and keyword 'default'. - required: false - default: null dampening_state: description: - Enable/disable route-flap dampening. - required: false - choices: ['true','false'] - default: null + type: bool dampening_half_time: description: - Specify decay half-life in minutes for route-flap dampening. Valid values are integer and keyword 'default'. - required: false - default: null dampening_max_suppress_time: description: - Specify max suppress time for route-flap dampening stable route. Valid values are integer and keyword 'default'. - required: false - default: null dampening_reuse_time: description: - Specify route reuse time for route-flap dampening. Valid values are integer and keyword 'default'. - required: false dampening_routemap: description: - Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map. - required: false - default: null dampening_suppress_time: description: - Specify route suppress time for route-flap dampening. Valid values are integer and keyword 'default'. - required: false - default: null default_information_originate: description: - Default information originate. - required: false - choices: ['true','false'] - default: null + type: bool default_metric: description: - Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword 'default' - required: false - default: null distance_ebgp: description: - Sets the administrative distance for eBGP routes. Valid values are Integer or keyword 'default'. - required: false - default: null distance_ibgp: description: - Sets the administrative distance for iBGP routes. Valid values are Integer or keyword 'default'. - required: false - default: null distance_local: description: - Sets the administrative distance for local BGP routes. Valid values are Integer or keyword 'default'. - required: false - default: null inject_map: description: - An array of route-map names which will specify prefixes to @@ -178,19 +143,14 @@ options: the aggregate. For example [['lax_inject_map', 'lax_exist_map'], ['nyc_inject_map', 'nyc_exist_map', 'copy-attributes'], ['fsd_inject_map', 'fsd_exist_map']]. - required: false - default: null maximum_paths: description: - Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64. - default: null maximum_paths_ibgp: description: - Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64. - required: false - default: null networks: description: - Networks to configure. Valid value is a list of network @@ -199,14 +159,10 @@ options: optional route-map. For example [['10.0.0.0/16', 'routemap_LA'], ['192.168.1.1', 'Chicago'], ['192.168.2.0/24'], ['192.168.3.0/24', 'routemap_NYC']]. - required: false - default: null next_hop_route_map: description: - Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map. - required: false - default: null redistribute: description: - A list of redistribute directives. Multiple redistribute entries @@ -216,32 +172,23 @@ options: A route-map is highly advised but may be optional on some platforms, in which case it may be omitted from the array list. For example [['direct', 'rm_direct'], ['lisp', 'rm_lisp']]. - required: false - default: null suppress_inactive: description: - Advertises only active routes to peers. - required: false - choices: ['true','false'] - default: null + type: bool table_map: description: - Apply table-map to filter routes downloaded into URIB. Valid values are a string. - required: false - default: null table_map_filter: description: - Filters routes rejected by the route-map and does not download them to the RIB. - required: false - choices: ['true','false'] - default: null + type: bool state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_bgp_neighbor.py b/lib/ansible/modules/network/nxos/nxos_bgp_neighbor.py index 62767c2bef..b11425a7fa 100644 --- a/lib/ansible/modules/network/nxos/nxos_bgp_neighbor.py +++ b/lib/ansible/modules/network/nxos/nxos_bgp_neighbor.py @@ -44,7 +44,6 @@ options: description: - Name of the VRF. The name 'default' is a valid VRF representing the global bgp. - required: false default: default neighbor: description: @@ -54,82 +53,58 @@ options: description: description: - Description of the neighbor. - required: false - default: null connected_check: description: - Configure whether or not to check for directly connected peer. - required: false - choices: ['true', 'false'] - default: null + type: bool capability_negotiation: description: - Configure whether or not to negotiate capability with this neighbor. - required: false - choices: ['true', 'false'] - default: null + type: bool dynamic_capability: description: - Configure whether or not to enable dynamic capability. - required: false - choices: ['true', 'false'] - default: null + type: bool ebgp_multihop: description: - Specify multihop TTL for a remote peer. Valid values are integers between 2 and 255, or keyword 'default' to disable this property. - required: false - default: null local_as: description: - Specify the local-as number for the eBGP neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or 'default', which means not to configure it. - required: false - default: null log_neighbor_changes: description: - Specify whether or not to enable log messages for neighbor up/down event. - required: false choices: ['enable', 'disable', 'inherit'] - default: null low_memory_exempt: description: - Specify whether or not to shut down this neighbor under memory pressure. - required: false - choices: ['true', 'false'] - default: null + type: bool maximum_peers: description: - Specify Maximum number of peers for this neighbor prefix Valid values are between 1 and 1000, or 'default', which does not impose the limit. Note that this parameter is accepted only on neighbors with address/prefix. - required: false - default: null pwd: description: - Specify the password for neighbor. Valid value is string. - required: false - default: null pwd_type: description: - Specify the encryption type the password will use. Valid values are '3des' or 'cisco_type_7' encryption or keyword 'default'. - required: false choices: ['3des', 'cisco_type_7', 'default'] - default: null remote_as: description: - Specify Autonomous System Number of the neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or 'default', which means not to configure it. - required: false - default: null remove_private_as: description: - Specify the config to remove private AS number from outbound @@ -137,53 +112,38 @@ options: 'disable' to disable this config, 'all' to remove all private AS number, or 'replace-as', to replace the private AS number. - required: false choices: ['enable', 'disable', 'all', 'replace-as'] - default: null shutdown: description: - Configure to administratively shutdown this neighbor. - required: false - choices: ['true','false'] - default: null + type: bool suppress_4_byte_as: description: - Configure to suppress 4-byte AS Capability. - required: false - choices: ['true','false'] - default: null + type: bool timers_keepalive: description: - Specify keepalive timer value. Valid values are integers between 0 and 3600 in terms of seconds, or 'default', which is 60. - required: false - default: null timers_holdtime: description: - Specify holdtime timer value. Valid values are integers between 0 and 3600 in terms of seconds, or 'default', which is 180. - required: false - default: null transport_passive_only: description: - Specify whether or not to only allow passive connection setup. Valid values are 'true', 'false', and 'default', which defaults to 'false'. This property can only be configured when the neighbor is in 'ip' address format without prefix length. - required: false - choices: ['true','false'] - default: null + type: bool update_source: description: - Specify source interface of BGP session and updates. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_bgp_neighbor_af.py b/lib/ansible/modules/network/nxos/nxos_bgp_neighbor_af.py index 28032c2c98..fab53226ac 100644 --- a/lib/ansible/modules/network/nxos/nxos_bgp_neighbor_af.py +++ b/lib/ansible/modules/network/nxos/nxos_bgp_neighbor_af.py @@ -47,7 +47,6 @@ options: description: - Name of the VRF. The name 'default' is a valid VRF representing the global bgp. - required: false default: default neighbor: description: @@ -71,9 +70,7 @@ options: (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer). - required: false choices: ['enable','disable', 'inherit'] - default: null additional_paths_send: description: - Valid values are enable for basic command enablement; disable @@ -81,9 +78,7 @@ options: (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer). - required: false choices: ['enable','disable', 'inherit'] - default: null advertise_map_exist: description: - Conditional route advertisement. This property requires two @@ -92,8 +87,6 @@ options: name, or simply 'default' e.g. ['my_advertise_map', 'my_exist_map']. This command is mutually exclusive with the advertise_map_non_exist property. - required: false - default: null advertise_map_non_exist: description: - Conditional route advertisement. This property requires two @@ -102,169 +95,117 @@ options: non-exist-map name, or simply 'default' e.g. ['my_advertise_map', 'my_non_exist_map']. This command is mutually exclusive with the advertise_map_exist property. - required: false - default: null allowas_in: description: - Activate allowas-in property - required: false - default: null allowas_in_max: description: - Max-occurrences value for allowas_in. Valid values are an integer value or 'default'. This is mutually exclusive with allowas_in. - required: false - default: null as_override: description: - Activate the as-override feature. - required: false - choices: ['true', 'false'] - default: null + type: bool default_originate: description: - Activate the default-originate feature. - required: false - choices: ['true', 'false'] - default: null + type: bool default_originate_route_map: description: - Route-map for the default_originate property. Valid values are a string defining a route-map name, or 'default'. This is mutually exclusive with default_originate. - required: false - default: null disable_peer_as_check: description: - Disable checking of peer AS-number while advertising - required: false - choices: ['true', 'false'] + type: bool version_added: 2.5 filter_list_in: description: - Valid values are a string defining a filter-list name, or 'default'. - required: false - default: null filter_list_out: description: - Valid values are a string defining a filter-list name, or 'default'. - required: false - default: null max_prefix_limit: description: - maximum-prefix limit value. Valid values are an integer value or 'default'. - required: false - default: null max_prefix_interval: description: - Optional restart interval. Valid values are an integer. Requires max_prefix_limit. May not be combined with max_prefix_warning. - required: false - default: null max_prefix_threshold: description: - Optional threshold percentage at which to generate a warning. Valid values are an integer value. Requires max_prefix_limit. - required: false - default: null max_prefix_warning: description: - Optional warning-only keyword. Requires max_prefix_limit. May not be combined with max_prefix_interval. - required: false - choices: ['true','false'] - default: null + type: bool next_hop_self: description: - Activate the next-hop-self feature. - required: false - choices: ['true','false'] - default: null + type: bool next_hop_third_party: description: - Activate the next-hop-third-party feature. - required: false - choices: ['true','false'] - default: null + type: bool prefix_list_in: description: - Valid values are a string defining a prefix-list name, or 'default'. - required: false - default: null prefix_list_out: description: - Valid values are a string defining a prefix-list name, or 'default'. - required: false - default: null route_map_in: description: - Valid values are a string defining a route-map name, or 'default'. - required: false - default: null route_map_out: description: - Valid values are a string defining a route-map name, or 'default'. - required: false - default: null route_reflector_client: description: - Router reflector client. - required: false - choices: ['true','false'] - default: null + type: bool send_community: description: - send-community attribute. - required: false choices: ['none', 'both', 'extended', 'standard', 'default'] - default: null soft_reconfiguration_in: description: - Valid values are 'enable' for basic command enablement; 'always' to add the always keyword to the basic command; and 'inherit' to remove the command at this level (the command value is inherited from a higher BGP layer). - required: false choices: ['enable','always','inherit'] - default: null soo: description: - Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'. - required: false - default: null suppress_inactive: description: - suppress-inactive feature. - required: false - choices: ['true','false','default'] - default: null + type: bool unsuppress_map: description: - unsuppress-map. Valid values are a string defining a route-map name or 'default'. - required: false - default: null weight: description: - Weight value. Valid values are an integer value or 'default'. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_command.py b/lib/ansible/modules/network/nxos/nxos_command.py index 2f09716c2c..8d6734e7ff 100644 --- a/lib/ansible/modules/network/nxos/nxos_command.py +++ b/lib/ansible/modules/network/nxos/nxos_command.py @@ -44,8 +44,6 @@ options: the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] version_added: "2.2" match: @@ -56,7 +54,6 @@ options: then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all version_added: "2.2" retries: @@ -65,7 +62,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. - required: false default: 10 interval: description: @@ -73,7 +69,6 @@ options: of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/nxos/nxos_config.py b/lib/ansible/modules/network/nxos/nxos_config.py index e59887747e..98139799ac 100644 --- a/lib/ansible/modules/network/nxos/nxos_config.py +++ b/lib/ansible/modules/network/nxos/nxos_config.py @@ -42,8 +42,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -51,8 +49,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - The I(src) argument provides a path to the configuration file @@ -61,8 +57,6 @@ options: or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) and I(parents) arguments. - required: false - default: null version_added: "2.2" replace_src: description: @@ -73,8 +67,6 @@ options: I(src) arguments. This argument is supported on Nexus 9K device. Use I(nxos_file_copy) module to copy the flat file to remote device and then use the path with this argument. - required: false - default: null version_added: "2.5" before: description: @@ -83,16 +75,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -103,7 +91,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -114,7 +101,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. I(replace config) is supported only on Nexus 9K device. - required: false default: line choices: ['line', 'block', 'config'] force: @@ -126,9 +112,8 @@ options: - Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in a future release. - required: false - default: false type: bool + default: 'no' backup: description: - This argument will cause the module to create a full backup of @@ -136,9 +121,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: false type: bool + default: 'no' version_added: "2.2" running_config: description: @@ -149,8 +133,6 @@ options: every task in a playbook. The I(running_config) argument allows the implementer to pass in the configuration to use as the base config for comparison. - required: false - default: null aliases: ['config'] version_added: "2.4" defaults: @@ -160,9 +142,8 @@ options: the command used to collect the running-config is append with the all keyword. When the value is set to false, the command is issued without the all keyword - required: false - default: false type: bool + default: 'no' version_added: "2.2" save: description: @@ -173,9 +154,8 @@ options: startup config. This option will always cause the module to return changed. - This option is deprecated as of Ansible 2.4, use C(save_when) - required: false - default: false type: bool + default: 'no' version_added: "2.2" save_when: description: @@ -189,7 +169,6 @@ options: the last save to startup-config. If the argument is set to I(never), the running-config will never be copied to the startup-config - required: false default: never choices: ['always', 'never', 'modified'] version_added: "2.4" @@ -205,7 +184,6 @@ options: - When this option is configured as I(running), the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. - required: false default: startup choices: ['startup', 'intended', 'running'] version_added: "2.4" @@ -215,7 +193,6 @@ options: ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. - required: false version_added: "2.4" intended_config: description: @@ -226,7 +203,6 @@ options: of the current device's configuration against. When specifying this argument, the task should also modify the C(diff_against) value and set it to I(intended). - required: false version_added: "2.4" """ diff --git a/lib/ansible/modules/network/nxos/nxos_evpn_vni.py b/lib/ansible/modules/network/nxos/nxos_evpn_vni.py index bb5fa6aa30..e5beea8479 100644 --- a/lib/ansible/modules/network/nxos/nxos_evpn_vni.py +++ b/lib/ansible/modules/network/nxos/nxos_evpn_vni.py @@ -50,35 +50,26 @@ options: description: - The EVPN VXLAN Network Identifier. required: true - default: null route_distinguisher: description: - The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address. required: true - default: null route_target_both: description: - Enables/Disables route-target settings for both import and export target communities using a single property. - required: false - default: null route_target_import: description: - Sets the route-target 'import' extended communities. - required: false - default: null route_target_export: description: - Sets the route-target 'export' extended communities. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_file_copy.py b/lib/ansible/modules/network/nxos/nxos_file_copy.py index 8da6d8455a..435968e46f 100644 --- a/lib/ansible/modules/network/nxos/nxos_file_copy.py +++ b/lib/ansible/modules/network/nxos/nxos_file_copy.py @@ -49,19 +49,14 @@ options: description: - Remote file path of the copy. Remote directories must exist. If omitted, the name of the local file will be used. - required: false - default: null file_system: description: - The remote file system of the device. If omitted, devices that support a I(file_system) parameter will use their default values. - required: false - default: null connect_ssh_port: description: - SSH port to connect to server during transfer of file - required: false default: 22 version_added: "2.5" ''' diff --git a/lib/ansible/modules/network/nxos/nxos_gir.py b/lib/ansible/modules/network/nxos/nxos_gir.py index a7530b6817..3fa4d639c6 100644 --- a/lib/ansible/modules/network/nxos/nxos_gir.py +++ b/lib/ansible/modules/network/nxos/nxos_gir.py @@ -46,9 +46,7 @@ options: protocols in maintenance mode (using the isolate command). When C(system_mode_maintenance=false) it puts all enabled protocols in normal mode (using the no isolate command). - required: false - default: null - choices: ['true','false'] + type: bool system_mode_maintenance_dont_generate_profile: description: - When C(system_mode_maintenance_dont_generate_profile=true) it @@ -61,30 +59,22 @@ options: commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created. - required: false - default: null - choices: ['true','false'] + type: bool system_mode_maintenance_timeout: description: - Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535. - required: false - default: null system_mode_maintenance_shutdown: description: - Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while C(system_mode_maintenance) (which uses the isolate command) is not. - required: false - default: null - choices: ['true','false'] + type: bool system_mode_maintenance_on_reload_reset_reason: description: - Boots the switch into maintenance mode automatically in the event of a specified system crash. - required: false - default: null choices: ['hw_error','svc_failure','kern_failure','wdog_timeout', 'fatal_error','lc_failure','match_any','manual_reload'] state: diff --git a/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py b/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py index edaf00eafa..9e4abee040 100644 --- a/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py +++ b/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py @@ -40,8 +40,6 @@ options: commands: description: - List of commands to be included into the profile. - required: false - default: null mode: description: - Configure the profile as Maintenance or Normal mode. @@ -50,7 +48,6 @@ options: state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_hsrp.py b/lib/ansible/modules/network/nxos/nxos_hsrp.py index 0faba42ffb..364022777e 100644 --- a/lib/ansible/modules/network/nxos/nxos_hsrp.py +++ b/lib/ansible/modules/network/nxos/nxos_hsrp.py @@ -53,14 +53,11 @@ options: version: description: - HSRP version. - required: false default: 2 choices: ['1','2'] priority: description: - HSRP priority. - required: false - default: null preempt: description: - Enable/Disable preempt. @@ -68,23 +65,16 @@ options: vip: description: - HSRP virtual IP address. - required: false - default: null auth_string: description: - Authentication string. - required: false - default: null auth_type: description: - Authentication type. - required: false - default: null choices: ['text','md5'] state: description: - Specify desired state of the resource. - required: false choices: ['present','absent'] default: 'present' ''' diff --git a/lib/ansible/modules/network/nxos/nxos_igmp.py b/lib/ansible/modules/network/nxos/nxos_igmp.py index a1a023c155..89a30f6472 100644 --- a/lib/ansible/modules/network/nxos/nxos_igmp.py +++ b/lib/ansible/modules/network/nxos/nxos_igmp.py @@ -43,26 +43,19 @@ options: description: - Removes routes when the IGMP process is restarted. By default, routes are not flushed. - required: false - default: null - choices: ['true', 'false'] + type: bool enforce_rtr_alert: description: - Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets. - required: false - default: null - choices: ['true', 'false'] + type: bool restart: description: - Restarts the igmp process (using an exec config command). - required: false - default: null - choices: ['true', 'false'] + type: bool state: description: - Manages desired state of the resource. - required: false default: present choices: ['present', 'default'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_igmp_interface.py b/lib/ansible/modules/network/nxos/nxos_igmp_interface.py index 718152609e..300fabe4de 100644 --- a/lib/ansible/modules/network/nxos/nxos_igmp_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_igmp_interface.py @@ -56,77 +56,56 @@ options: version: description: - IGMP version. It can be 2 or 3. - required: false - default: null choices: ['2', '3'] startup_query_interval: description: - Query interval used when the IGMP process starts up. The range is from 1 to 18000. The default is 31. - required: false - default: null startup_query_count: description: - Query count used when the IGMP process starts up. The range is from 1 to 10. The default is 2. - required: false - default: null robustness: description: - Sets the robustness variable. Values can range from 1 to 7. The default is 2. - required: false - default: null querier_timeout: description: - Sets the querier timeout that the software uses when deciding to take over as the querier. Values can range from 1 to 65535 seconds. The default is 255 seconds. - required: false - default: null query_mrt: description: - Sets the response time advertised in IGMP queries. Values can range from 1 to 25 seconds. The default is 10 seconds. - required: false - default: null query_interval: description: - Sets the frequency at which the software sends IGMP host query messages. Values can range from 1 to 18000 seconds. The default is 125 seconds. - required: false - default: null last_member_qrt: description: - Sets the query interval waited after sending membership reports before the software deletes the group state. Values can range from 1 to 25 seconds. The default is 1 second. - required: false - default: null last_member_query_count: description: - Sets the number of times that the software sends an IGMP query in response to a host leave message. Values can range from 1 to 5. The default is 2. - required: false - default: null group_timeout: description: - Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535 seconds. The default is 260 seconds. - required: false - default: null report_llg: description: - Configures report-link-local-groups. Enables sending reports for groups in 224.0.0.0/24. Reports are always sent for nonlink local groups. By default, reports are not sent for link local groups. - required: false - choices: ['true', 'false'] - default: false + type: bool + default: 'no' immediate_leave: description: - Enables the device to remove the group entry from the multicast @@ -135,34 +114,24 @@ options: IGMPv2 group memberships on a given IGMP interface because the device does not send group-specific queries. The default is disabled. - required: false - choices: ['true', 'false'] - default: false + type: bool + default: 'no' oif_routemap: description: - Configure a routemap for static outgoing interface (OIF). - required: false - default: null oif_prefix: description: - Configure a prefix for static outgoing interface (OIF). - required: false - default: null oif_source: description: - Configure a source for static outgoing interface (OIF). - required: false - default: null restart: description: - Restart IGMP. - required: false - choices: ['true', 'false'] - default: null + type: bool state: description: - Manages desired state of the resource. - required: false default: present choices: ['present', 'default'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py b/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py index 6d84d40fb8..49c2963921 100644 --- a/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py +++ b/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py @@ -40,37 +40,26 @@ options: snooping: description: - Enables/disables IGMP snooping on the switch. - required: false - default: null - choices: ['true', 'false'] + type: bool group_timeout: description: - Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, I(never) and I(default). - required: false - default: null link_local_grp_supp: description: - Global link-local groups suppression. - required: false - default: null - choices: ['true', 'false'] + type: bool report_supp: description: - Global IGMPv1/IGMPv2 Report Suppression. - required: false - default: null v3_report_supp: description: - Global IGMPv3 Report Suppression and Proxy Reporting. - required: false - default: null - choices: ['true', 'false'] + type: bool state: description: - Manage the state of the resource. - required: false default: present choices: ['present','default'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_install_os.py b/lib/ansible/modules/network/nxos/nxos_install_os.py index 820b9f2f20..dc0b60bcb9 100644 --- a/lib/ansible/modules/network/nxos/nxos_install_os.py +++ b/lib/ansible/modules/network/nxos/nxos_install_os.py @@ -61,8 +61,6 @@ options: description: - Name of the kickstart image file on flash. (Not required on all Nexus platforms) - required: false - default: null issu: version_added: "2.5" description: @@ -73,7 +71,6 @@ options: - Selecting 'desired' means that upgrades will use ISSU if possible but will fall back to disruptive upgrade if needed. - Selecting 'no' means do not use ISSU. Forced disruptive. - required: false choices: ['required','desired', 'yes', 'no'] default: 'no' ''' diff --git a/lib/ansible/modules/network/nxos/nxos_interface.py b/lib/ansible/modules/network/nxos/nxos_interface.py index d68d3730a4..64b0c801cc 100644 --- a/lib/ansible/modules/network/nxos/nxos_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_interface.py @@ -45,13 +45,10 @@ options: description: - Full name of interface, i.e. Ethernet1/1, port-channel10. required: true - default: null aliases: [interface] interface_type: description: - Interface type to be unconfigured from the device. - required: false - default: null choices: ['loopback', 'portchannel', 'svi', 'nve'] version_added: 2.2 speed: @@ -61,42 +58,32 @@ options: admin_state: description: - Administrative state of the interface. - required: false default: up choices: ['up','down'] description: description: - Interface description. - required: false - default: null mode: description: - Manage Layer 2 or Layer 3 state of the interface. This option is supported for ethernet and portchannel interface. Applicable for ethernet and portchannel interface only. - required: false - default: null choices: ['layer2','layer3'] mtu: description: - MTU for a specific interface. Must be an even number between 576 and 9216. Applicable for ethernet interface only. - required: false version_added: 2.5 ip_forward: description: - Enable/Disable ip forward feature on SVIs. - required: false - default: null choices: ['enable','disable'] version_added: 2.2 fabric_forwarding_anycast_gateway: description: - Associate SVI with anycast gateway under VLAN configuration mode. Applicable for SVI interface only. - required: false - default: null - choices: ['true','false'] + type: bool version_added: 2.2 duplex: description: @@ -134,7 +121,6 @@ options: state: description: - Specify desired state of the resource. - required: true default: present choices: ['present','absent','default'] delay: diff --git a/lib/ansible/modules/network/nxos/nxos_interface_ospf.py b/lib/ansible/modules/network/nxos/nxos_interface_ospf.py index 6061c6f0d3..9ee212fa07 100644 --- a/lib/ansible/modules/network/nxos/nxos_interface_ospf.py +++ b/lib/ansible/modules/network/nxos/nxos_interface_ospf.py @@ -55,67 +55,47 @@ options: cost: description: - The cost associated with this cisco_interface_ospf instance. - required: false - default: null hello_interval: description: - Time between sending successive hello packets. Valid values are an integer or the keyword 'default'. - required: false - default: null dead_interval: description: - Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer or the keyword 'default'. - required: false - default: null passive_interface: description: - Setting to true will prevent this interface from receiving - HELLO packets. Valid values are 'true' and 'false'. - required: false - choices: ['true','false'] - default: null + HELLO packets. + type: bool message_digest: description: - Enables or disables the usage of message digest authentication. - Valid values are 'true' and 'false'. - required: false - choices: ['true','false'] - default: null + type: bool message_digest_key_id: description: - Md5 authentication key-id associated with the ospf instance. If this is present, message_digest_encryption_type, message_digest_algorithm_type and message_digest_password are mandatory. Valid value is an integer and 'default'. - required: false - default: null message_digest_algorithm_type: description: - Algorithm used for authentication among neighboring routers within an area. Valid values are 'md5' and 'default'. - required: false choices: ['md5', 'default'] - default: null message_digest_encryption_type: description: - Specifies the scheme used for encrypting message_digest_password. Valid values are '3des' or 'cisco_type_7' encryption or 'default'. - required: false choices: ['cisco_type_7','3des', 'default'] - default: null message_digest_password: description: - Specifies the message_digest password. Valid value is a string. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_linkagg.py b/lib/ansible/modules/network/nxos/nxos_linkagg.py index af2e21818c..2437ebdc3d 100644 --- a/lib/ansible/modules/network/nxos/nxos_linkagg.py +++ b/lib/ansible/modules/network/nxos/nxos_linkagg.py @@ -39,39 +39,33 @@ options: mode: description: - Mode for the link aggregation group. - required: false - default: on - choices: ['active','passive','on'] + choices: [ active, 'on', passive ] + default: 'on' min_links: description: - Minimum number of ports required up before bringing up the link aggregation group. - required: false - default: null members: description: - List of interfaces that will be managed in the link aggregation group. - required: false - default: null force: description: - When true it forces link aggregation group members to match what is declared in the members param. This can be used to remove members. - required: false - choices: [True, False] - default: False + type: bool + default: 'no' aggregate: description: List of link aggregation definitions. state: description: - State of the link aggregation group. - required: false default: present choices: ['present','absent'] purge: description: - Purge links not defined in the I(aggregate) parameter. - default: no + type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/nxos/nxos_ntp.py b/lib/ansible/modules/network/nxos/nxos_ntp.py index 119c48e539..581fa666be 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp.py @@ -25,47 +25,32 @@ options: server: description: - Network address of NTP server. - required: false - default: null peer: description: - Network address of NTP peer. - required: false - default: null key_id: description: - Authentication key identifier to use with given NTP server or peer. - required: false - default: null prefer: description: - Makes given NTP server or peer the preferred NTP server or peer for the device. - required: false - default: null choices: ['enabled', 'disabled'] vrf_name: description: - Makes the device communicate with the given NTP server or peer over a specific VRF. - required: false - default: null source_addr: description: - Local source address from which NTP messages are sent. - required: false - default: null source_int: description: - Local source interface from which NTP messages are sent. Must be fully qualified interface name. - required: false - default: null state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ntp_auth.py b/lib/ansible/modules/network/nxos/nxos_ntp_auth.py index 23b55ee2c4..d2e6509351 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp_auth.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp_auth.py @@ -47,32 +47,26 @@ options: description: - MD5 String. required: true - default: null auth_type: description: - Whether the given md5string is in cleartext or has been encrypted. If in cleartext, the device will encrypt it before storing it. - required: false default: text choices: ['text', 'encrypt'] trusted_key: description: - Whether the given key is required to be supplied by a time source for the device to synchronize to the time source. - required: false - default: false - choices: ['true', 'false'] + choices: [ 'false', 'true' ] + default: 'false' authentication: description: - Turns NTP authentication on or off. - required: false - default: null choices: ['on', 'off'] state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ntp_options.py b/lib/ansible/modules/network/nxos/nxos_ntp_options.py index afa535f07d..c153c988f7 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp_options.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp_options.py @@ -44,25 +44,18 @@ options: master: description: - Sets whether the device is an authoritative NTP server. - required: false - default: null - choices: ['true','false'] + type: bool stratum: description: - If C(master=true), an optional stratum can be supplied (1-15). The device default is 8. - required: false - default: null logging: description: - Sets whether NTP logging is enabled on the device. - required: false - default: null - choices: ['true','false'] + type: bool state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ospf_vrf.py b/lib/ansible/modules/network/nxos/nxos_ospf_vrf.py index c2b037bdcc..8e74de67e7 100644 --- a/lib/ansible/modules/network/nxos/nxos_ospf_vrf.py +++ b/lib/ansible/modules/network/nxos/nxos_ospf_vrf.py @@ -38,88 +38,63 @@ options: description: - Name of the resource instance. Valid value is a string. The name 'default' is a valid VRF representing the global OSPF. - required: false default: default ospf: description: - Name of the OSPF instance. required: true - default: null router_id: description: - Router Identifier (ID) of the OSPF router VRF instance. - required: false - default: null default_metric: description: - Specify the default Metric value. Valid values are an integer or the keyword 'default'. - required: false - default: null log_adjacency: description: - Controls the level of log messages generated whenever a neighbor changes state. Valid values are 'log', 'detail', and 'default'. - required: false choices: ['log','detail','default'] - default: null timer_throttle_lsa_start: description: - Specify the start interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'. - required: false - default: null timer_throttle_lsa_hold: description: - Specify the hold interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'. - required: false - default: null timer_throttle_lsa_max: description: - Specify the max interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'. - required: false - default: null timer_throttle_spf_start: description: - Specify initial Shortest Path First (SPF) schedule delay. Valid values are an integer, in milliseconds, or the keyword 'default'. - required: false - default: null timer_throttle_spf_hold: description: - Specify minimum hold time between Shortest Path First (SPF) calculations. Valid values are an integer, in milliseconds, or the keyword 'default'. - required: false - default: null timer_throttle_spf_max: description: - Specify the maximum wait time between Shortest Path First (SPF) calculations. Valid values are an integer, in milliseconds, or the keyword 'default'. - required: false - default: null auto_cost: description: - Specifies the reference bandwidth used to assign OSPF cost. Valid values are an integer, in Mbps, or the keyword 'default'. - required: false - default: null passive_interface: description: - - Setting to true will suppress routing update on interface. - Valid values are 'true' and 'false'. + - Setting to C(yes) will suppress routing update on interface. version_added: "2.4" - required: false - choices: ['true','false'] - default: null + type: bool state: description: - State of ospf vrf configuration. diff --git a/lib/ansible/modules/network/nxos/nxos_overlay_global.py b/lib/ansible/modules/network/nxos/nxos_overlay_global.py index abd77a5cba..1a4520cf2f 100644 --- a/lib/ansible/modules/network/nxos/nxos_overlay_global.py +++ b/lib/ansible/modules/network/nxos/nxos_overlay_global.py @@ -39,7 +39,6 @@ options: description: - Anycast gateway mac of the switch. required: true - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_pim_interface.py b/lib/ansible/modules/network/nxos/nxos_pim_interface.py index 690373c820..aa6e80a782 100644 --- a/lib/ansible/modules/network/nxos/nxos_pim_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_pim_interface.py @@ -51,66 +51,47 @@ options: sparse: description: - Enable/disable sparse-mode on the interface. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' dr_prio: description: - Configures priority for PIM DR election on interface. hello_auth_key: description: - Authentication for hellos on this interface. - required: false - default: null hello_interval: description: - Hello interval in milliseconds for this interface. - required: false - default: null - choices: ['true', 'false'] + type: bool jp_policy_out: description: - Policy for join-prune messages (outbound). - required: true - default: null jp_policy_in: description: - Policy for join-prune messages (inbound). - required: false - default: null jp_type_out: description: - Type of policy mapped to C(jp_policy_out). - required: false - default: null choices: ['prefix', 'routemap'] jp_type_in: description: - Type of policy mapped to C(jp_policy_in). - required: false - default: null choices: ['prefix', 'routemap'] border: description: - Configures interface to be a boundary of a PIM domain. - required: false - default: false - choices: ['true', 'false'] + type: bool + default: 'no' neighbor_policy: description: - Configures a neighbor policy for filtering adjacencies. - required: false - default: null neighbor_type: description: - Type of policy mapped to neighbor_policy. - required: false - default: null choices: ['prefix', 'routemap'] state: description: - Manages desired state of the resource. - required: false default: present choices: ['present', 'default'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_pim_rp_address.py b/lib/ansible/modules/network/nxos/nxos_pim_rp_address.py index 0ebaecaf17..cd6a69fbaa 100644 --- a/lib/ansible/modules/network/nxos/nxos_pim_rp_address.py +++ b/lib/ansible/modules/network/nxos/nxos_pim_rp_address.py @@ -44,26 +44,18 @@ options: group_list: description: - Group range for static RP. Valid values are multicast addresses. - required: false - default: null prefix_list: description: - Prefix list policy for static RP. Valid values are prefix-list policy names. - required: false - default: null route_map: description: - Route map policy for static RP. Valid values are route-map policy names. - required: false - default: null bidir: description: - Group range is treated in PIM bidirectional mode. - required: false - choices: ['true','false'] - default: null + type: bool state: description: - Specify desired state of the resource. diff --git a/lib/ansible/modules/network/nxos/nxos_ping.py b/lib/ansible/modules/network/nxos/nxos_ping.py index e5afc07f27..ce63103b30 100644 --- a/lib/ansible/modules/network/nxos/nxos_ping.py +++ b/lib/ansible/modules/network/nxos/nxos_ping.py @@ -43,18 +43,13 @@ options: count: description: - Number of packets to send. - required: false default: 2 source: description: - Source IP Address. - required: false - default: null vrf: description: - Outgoing VRF. - required: false - default: null state: description: - Determines if the expected result is success or fail. diff --git a/lib/ansible/modules/network/nxos/nxos_rollback.py b/lib/ansible/modules/network/nxos/nxos_rollback.py index 8dffca82f0..76a5d260ff 100644 --- a/lib/ansible/modules/network/nxos/nxos_rollback.py +++ b/lib/ansible/modules/network/nxos/nxos_rollback.py @@ -42,14 +42,10 @@ options: description: - Name of checkpoint file to create. Mutually exclusive with rollback_to. - required: false - default: null rollback_to: description: - Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_smu.py b/lib/ansible/modules/network/nxos/nxos_smu.py index aeb1bc9281..148fd14354 100644 --- a/lib/ansible/modules/network/nxos/nxos_smu.py +++ b/lib/ansible/modules/network/nxos/nxos_smu.py @@ -45,8 +45,6 @@ options: - The remote file system of the device. If omitted, devices that support a file_system parameter will use their default values. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snapshot.py b/lib/ansible/modules/network/nxos/nxos_snapshot.py index 93a172af17..7f32e3cf61 100644 --- a/lib/ansible/modules/network/nxos/nxos_snapshot.py +++ b/lib/ansible/modules/network/nxos/nxos_snapshot.py @@ -45,82 +45,58 @@ options: description: - Define what snapshot action the module would perform. required: true - choices: ['create','add','compare','delete'] + choices: [ add, compare, create, delete, delete_all ] snapshot_name: description: - Snapshot name, to be used when C(action=create) or C(action=delete). - required: false - default: null description: description: - Snapshot description to be used when C(action=create). - required: false - default: null snapshot1: description: - First snapshot to be used when C(action=compare). - required: false - default: null snapshot2: description: - Second snapshot to be used when C(action=compare). - required: false - default: null comparison_results_file: description: - Name of the file where snapshots comparison will be stored when C(action=compare). - required: false - default: null compare_option: description: - Snapshot options to be used when C(action=compare). - required: false - default: null choices: ['summary','ipv4routes','ipv6routes'] section: description: - Used to name the show command output, to be used when C(action=add). - required: false - default: null show_command: description: - Specify a new show command, to be used when C(action=add). - required: false - default: null row_id: description: - Specifies the tag of each row entry of the show command's XML output, to be used when C(action=add). - required: false - default: null element_key1: description: - Specify the tags used to distinguish among row entries, to be used when C(action=add). - required: false - default: null element_key2: description: - Specify the tags used to distinguish among row entries, to be used when C(action=add). - required: false - default: null save_snapshot_locally: description: - Specify to locally store a new created snapshot, to be used when C(action=create). - required: false - default: false - choices: ['true','false'] + type: bool + default: 'no' path: description: - Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when C(action=create) and C(save_snapshot_locally=true) or C(action=compare). - required: false default: './' ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_community.py b/lib/ansible/modules/network/nxos/nxos_snmp_community.py index afaba96a54..8c76803df4 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_community.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_community.py @@ -42,23 +42,17 @@ options: access: description: - Access type for community. - required: false - default: null choices: ['ro','rw'] group: description: - Group to which the community belongs. - required: false - default: null acl: description: - ACL name to filter snmp requests. - required: false default: 1 state: description: - Manage the state of the resource. - required: true default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_host.py b/lib/ansible/modules/network/nxos/nxos_snmp_host.py index df2f4bf40f..a87b52bb42 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_host.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_host.py @@ -43,7 +43,6 @@ options: version: description: - SNMP version. - required: false default: v2c choices: ['v2c', 'v3'] v3: @@ -53,38 +52,26 @@ options: community: description: - Community string or v3 username. - required: false - default: null udp: description: - UDP port number (0-65535). - required: false - default: null snmp_type: description: - type of message to send to host. - required: false default: trap choices: ['trap', 'inform'] vrf: description: - VRF to use to source traffic to source. - required: false - default: null vrf_filter: description: - Name of VRF to filter. - required: false - default: null src_intf: description: - Source interface. - required: false - default: null state: description: - Manage the state of the resource. - required: true default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_user.py b/lib/ansible/modules/network/nxos/nxos_snmp_user.py index 2978a6767b..d8f51335fc 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_user.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_user.py @@ -46,29 +46,20 @@ options: authentication: description: - Authentication parameters for the user. - required: false - default: null choices: ['md5', 'sha'] pwd: description: - Authentication password when using md5 or sha. - required: false - default: null privacy: description: - Privacy password for the user. - required: false - default: null encrypt: description: - Enables AES-128 bit encryption when using privacy password. - required: false - default: null - choices: ['true','false'] + type: bool state: description: - Manage the state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_static_route.py b/lib/ansible/modules/network/nxos/nxos_static_route.py index 8a563dbc84..f98781a569 100644 --- a/lib/ansible/modules/network/nxos/nxos_static_route.py +++ b/lib/ansible/modules/network/nxos/nxos_static_route.py @@ -49,23 +49,16 @@ options: vrf: description: - VRF for static route. - required: false default: default tag: description: - Route tag value (numeric). - required: false - default: null route_name: description: - Name of the route. Used with the name parameter on the CLI. - required: false - default: null pref: description: - Preference or administrative difference of route (range 1-255). - required: false - default: null aliases: - admin_distance aggregate: diff --git a/lib/ansible/modules/network/nxos/nxos_udld.py b/lib/ansible/modules/network/nxos/nxos_udld.py index 4486a5b70e..1adb3f0b43 100644 --- a/lib/ansible/modules/network/nxos/nxos_udld.py +++ b/lib/ansible/modules/network/nxos/nxos_udld.py @@ -23,7 +23,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' --- - module: nxos_udld extends_documentation_fragment: nxos version_added: "2.2" @@ -39,26 +38,20 @@ options: aggressive: description: - Toggles aggressive mode. - required: false - default: null choices: ['enabled','disabled'] msg_time: description: - Message time in seconds for UDLD packets or keyword 'default'. - required: false - default: null reset: description: - Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent' when this is present. - required: false - default: null - choices: ['true'] + type: bool + default: 'no' state: description: - Manage the state of the resource. When set to 'absent', aggressive and msg_time are set to their default values. - required: false default: present choices: ['present','absent'] diff --git a/lib/ansible/modules/network/nxos/nxos_user.py b/lib/ansible/modules/network/nxos/nxos_user.py index 392397d447..0c40f1f375 100644 --- a/lib/ansible/modules/network/nxos/nxos_user.py +++ b/lib/ansible/modules/network/nxos/nxos_user.py @@ -43,15 +43,11 @@ options: exclusive with the C(name) argument. aliases: ['users', 'collection'] version_added: "2.4" - required: false - default: null name: description: - The username to be configured on the remote Cisco Nexus device. This argument accepts a string value and is mutually exclusive with the C(aggregate) argument. - required: false - default: null configured_password: description: - The password to be configured on the network device. The @@ -66,7 +62,6 @@ options: set to C(always), the password will always be updated in the device and when set to C(on_create) the password will be updated only if the username is created. - required: false default: always choices: ['on_create', 'always'] role: @@ -75,23 +70,19 @@ options: device running configuration. The argument accepts a string value defining the role name. This argument does not check if the role has been configured on the device. - required: false - default: null aliases: ['roles'] sshkey: description: - The C(sshkey) argument defines the SSH public key to configure for the username. This argument accepts a valid SSH key value. - required: false - default: null purge: description: - The C(purge) argument instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user which cannot be deleted per nxos constraints. - required: false - default: false + type: bool + default: 'no' state: description: - The C(state) argument configures the state of the username definition @@ -99,7 +90,6 @@ options: to I(present), the username(s) should be configured in the device active configuration and when set to I(absent) the username(s) should not be in the device active configuration - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/nxos/nxos_vlan.py b/lib/ansible/modules/network/nxos/nxos_vlan.py index 9ce967065b..41aed15638 100644 --- a/lib/ansible/modules/network/nxos/nxos_vlan.py +++ b/lib/ansible/modules/network/nxos/nxos_vlan.py @@ -33,18 +33,12 @@ options: vlan_id: description: - Single VLAN ID. - required: false - default: null vlan_range: description: - Range of VLANs such as 2-10 or 2,5,10-15, etc. - required: false - default: null name: description: - Name of VLAN. - required: false - default: null interfaces: description: - List of interfaces that should be associated to the VLAN. @@ -59,35 +53,29 @@ options: description: - Manage the vlan operational state of the VLAN This is being deprecated in favor of state. - required: false default: active choices: ['active','suspend'] admin_state: description: - Manage the VLAN administrative state of the VLAN equivalent to shut/no shut in VLAN config mode. - required: false default: up choices: ['up','down'] mapped_vni: description: - The Virtual Network Identifier (VNI) ID that is mapped to the VLAN. Valid values are integer and keyword 'default'. Range 4096-16773119. - required: false - default: null version_added: "2.2" state: description: - Manage the state of the resource. Active and Suspend will assume the vlan is present. - required: false default: present choices: ['present','absent', 'active', 'suspend'] mode: description: - Set VLAN mode to classical ethernet or fabricpath. This is a valid option for Nexus 5000 and 7000 series. - required: false default: ce choices: ['ce','fabricpath'] version_added: "2.4" @@ -97,7 +85,8 @@ options: purge: description: - Purge VLANs not defined in the I(aggregate) parameter. - default: no + type: bool + default: 'no' delay: description: - Time in seconds to wait before checking for the operational state on remote diff --git a/lib/ansible/modules/network/nxos/nxos_vpc.py b/lib/ansible/modules/network/nxos/nxos_vpc.py index f12df05eb3..cff0a9a7e5 100644 --- a/lib/ansible/modules/network/nxos/nxos_vpc.py +++ b/lib/ansible/modules/network/nxos/nxos_vpc.py @@ -49,43 +49,31 @@ options: role_priority: description: - Role priority for device. Remember lower is better. - required: false - default: null system_priority: description: - System priority device. Remember they must match between peers. - required: false - default: null pkl_src: description: - Source IP address used for peer keepalive link - required: false - default: null pkl_dest: description: - Destination (remote) IP address used for peer keepalive link - required: false - default: null pkl_vrf: description: - VRF used for peer keepalive link - required: false default: management peer_gw: description: - Enables/Disables peer gateway - required: false - choices: ['true','false'] + type: bool auto_recovery: description: - Enables/Disables auto recovery - required: false - choices: ['true','false'] + type: bool delay_restore: description: - manages delay restore command and config value in seconds - required: false - default: null + type: bool state: description: - Manages desired state of the resource diff --git a/lib/ansible/modules/network/nxos/nxos_vpc_interface.py b/lib/ansible/modules/network/nxos/nxos_vpc_interface.py index def6947c33..614f5a3764 100644 --- a/lib/ansible/modules/network/nxos/nxos_vpc_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_vpc_interface.py @@ -47,18 +47,15 @@ options: vpc: description: - VPC group/id that will be configured on associated portchannel. - required: false - default: null peer_link: description: - Set to true/false for peer link config on associated portchannel. - required: false - default: null state: description: - Manages desired state of the resource. required: true choices: ['present','absent'] + default: present ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vrf.py b/lib/ansible/modules/network/nxos/nxos_vrf.py index a484f3baf6..3c3aad2fcd 100644 --- a/lib/ansible/modules/network/nxos/nxos_vrf.py +++ b/lib/ansible/modules/network/nxos/nxos_vrf.py @@ -53,23 +53,18 @@ options: admin_state: description: - Administrative state of the VRF. - required: false default: up choices: ['up','down'] vni: description: - Specify virtual network identifier. Valid values are Integer or keyword 'default'. - required: false - default: null version_added: "2.2" rd: description: - VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'. - required: false - default: null version_added: "2.2" interfaces: description: @@ -88,19 +83,17 @@ options: purge: description: - Purge VRFs not defined in the I(aggregate) parameter. - default: no + type: bool + default: 'no' version_added: 2.5 state: description: - Manages desired state of the resource. - required: false default: present choices: ['present','absent'] description: description: - Description of the VRF or keyword 'default'. - required: false - default: null delay: description: - Time in seconds to wait before checking for the operational state on remote diff --git a/lib/ansible/modules/network/nxos/nxos_vrf_af.py b/lib/ansible/modules/network/nxos/nxos_vrf_af.py index 1a653e0ae6..0466b482bd 100644 --- a/lib/ansible/modules/network/nxos/nxos_vrf_af.py +++ b/lib/ansible/modules/network/nxos/nxos_vrf_af.py @@ -42,26 +42,21 @@ options: - Address-Family Identifier (AFI). required: true choices: ['ipv4', 'ipv6'] - default: null safi: description: - Sub Address-Family Identifier (SAFI). - Deprecated in 2.4 required: true choices: ['unicast', 'multicast'] - default: null route_target_both_auto_evpn: description: - Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities. - required: false - choices: ['true', 'false'] - default: null + type: bool state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vrrp.py b/lib/ansible/modules/network/nxos/nxos_vrrp.py index 733c1dd492..cc5f954d9f 100644 --- a/lib/ansible/modules/network/nxos/nxos_vrrp.py +++ b/lib/ansible/modules/network/nxos/nxos_vrrp.py @@ -58,33 +58,26 @@ options: priority: description: - VRRP priority or 'default' keyword - required: false default: 100 preempt: description: - Enable/Disable preempt. - choices: ['True', 'False'] - default: True + type: bool + default: 'yes' vip: description: - VRRP virtual IP address or 'default' keyword - required: false - default: null authentication: description: - Clear text authentication string or 'default' keyword - required: false - default: null admin_state: description: - Used to enable or disable the VRRP process. - required: false choices: ['shutdown', 'no shutdown', 'default'] default: shutdown state: description: - Specify desired state of the resource. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_password.py b/lib/ansible/modules/network/nxos/nxos_vtp_password.py index f9a919f016..d7540e0272 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_password.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_password.py @@ -47,12 +47,9 @@ options: vtp_password: description: - VTP password - required: false - default: null state: description: - Manage the state of the resource - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py b/lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py index 65f98b7f2a..a86becf69e 100644 --- a/lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py +++ b/lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py @@ -45,37 +45,26 @@ options: description: description: - Description of the NVE interface. - required: false - default: null host_reachability: description: - Specify mechanism for host reachability advertisement. - required: false - choices: ['true', 'false'] - default: null + type: bool shutdown: description: - Administratively shutdown the NVE interface. - required: false - choices: ['true','false'] - default: true + type: bool source_interface: description: - Specify the loopback interface whose IP address should be used for the NVE interface. - required: false - default: null source_interface_hold_down_time: description: - Suppresses advertisement of the NVE loopback address until the overlay has converged. - required: false - default: null state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py b/lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py index 99475158b4..01fddf069d 100644 --- a/lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py +++ b/lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py @@ -49,39 +49,28 @@ options: that are associated with a VRF and used for routing. The VRF and VNI specified with this command must match the configuration of the VNI under the VRF. - required: false - choices: ['true','false'] - default: null + type: bool ingress_replication: description: - Specifies mechanism for host reachability advertisement. - required: false choices: ['bgp','static', 'default'] - default: null multicast_group: description: - The multicast group (range) of the VNI. Valid values are string and keyword 'default'. - required: false - default: null peer_list: description: - Set the ingress-replication static peer list. Valid values are an array, a space-separated string of ip addresses, or the keyword 'default'. - required: false - default: null suppress_arp: description: - Suppress arp under layer 2 VNI. - required: false - choices: ['true','false'] - default: null + type: bool state: description: - Determines whether the config should be present or not on the device. - required: false default: present choices: ['present','absent'] ''' diff --git a/lib/ansible/modules/network/ordnance/ordnance_config.py b/lib/ansible/modules/network/ordnance/ordnance_config.py index 6ea10719a4..00fec3e2b6 100644 --- a/lib/ansible/modules/network/ordnance/ordnance_config.py +++ b/lib/ansible/modules/network/ordnance/ordnance_config.py @@ -31,8 +31,6 @@ options: in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. - required: false - default: null aliases: ['commands'] parents: description: @@ -40,8 +38,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -49,8 +45,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null before: description: - The ordered set of commands to push on to the command stack if @@ -58,16 +52,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -78,7 +68,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -89,7 +78,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] multiline_delimiter: @@ -98,7 +86,6 @@ options: element to the Ordnance router. It specifies the character to use as the delimiting character. This only applies to the configuration action - required: false default: "@" backup: description: @@ -107,34 +94,29 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' config: description: - The C(config) argument allows the playbook designer to supply the base configuration to be used to validate configuration changes necessary. If this argument is provided, the module will not download the running-config from the remote node. - required: false - default: null defaults: description: - This argument specifies whether or not to collect all defaults when getting the remote device running config. When enabled, the module will get the current config by issuing the command C(show running-config all). - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' save: description: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/ovs/openvswitch_bridge.py b/lib/ansible/modules/network/ovs/openvswitch_bridge.py index 2f437d1ec7..b66941c370 100644 --- a/lib/ansible/modules/network/ovs/openvswitch_bridge.py +++ b/lib/ansible/modules/network/ovs/openvswitch_bridge.py @@ -30,46 +30,34 @@ options: - Name of bridge or fake bridge to manage parent: version_added: "2.3" - required: false - default: None description: - Bridge parent of the fake bridge to manage vlan: version_added: "2.3" - required: false - default: None description: - The VLAN id of the fake bridge to manage (must be between 0 and 4095). This parameter is required if I(parent) parameter is set. state: - required: false default: "present" choices: [ present, absent ] description: - Whether the bridge should exist timeout: - required: false default: 5 description: - How long to wait for ovs-vswitchd to respond external_ids: version_added: 2.0 - required: false - default: None description: - A dictionary of external-ids. Omitting this parameter is a No-op. To clear all external-ids pass an empty value. fail_mode: version_added: 2.0 - default: None - required: false choices : [secure, standalone] description: - Set bridge fail-mode. The default value (None) is a No-op. set: version_added: 2.3 - required: false - default: None description: - Run set command after bridge configuration. This parameter is non-idempotent, play will always return I(changed) state if diff --git a/lib/ansible/modules/network/ovs/openvswitch_port.py b/lib/ansible/modules/network/ovs/openvswitch_port.py index ed0673a223..c0e2ad460d 100644 --- a/lib/ansible/modules/network/ovs/openvswitch_port.py +++ b/lib/ansible/modules/network/ovs/openvswitch_port.py @@ -34,31 +34,25 @@ options: - Name of port to manage on the bridge tag: version_added: 2.2 - required: false description: - VLAN tag for this port. Must be a value between 0 and 4095. state: - required: false default: "present" choices: [ present, absent ] description: - Whether the port should exist timeout: - required: false default: 5 description: - How long to wait for ovs-vswitchd to respond external_ids: version_added: 2.0 - required: false default: {} description: - Dictionary of external_ids applied to a port. set: version_added: 2.0 - required: false - default: None description: - Set a single property on a port. ''' diff --git a/lib/ansible/modules/network/panos/_panos_nat_policy.py b/lib/ansible/modules/network/panos/_panos_nat_policy.py index c05869ccec..e26201d10c 100644 --- a/lib/ansible/modules/network/panos/_panos_nat_policy.py +++ b/lib/ansible/modules/network/panos/_panos_nat_policy.py @@ -50,7 +50,6 @@ options: username: description: - username for authentication - required: false default: "admin" rule_name: description: @@ -67,63 +66,48 @@ options: source: description: - list of source addresses - required: false default: ["any"] destination: description: - list of destination addresses - required: false default: ["any"] service: description: - service - required: false default: "any" snat_type: description: - type of source translation - required: false - default: None snat_address: description: - snat translated address - required: false - default: None snat_interface: description: - snat interface - required: false - default: None snat_interface_address: description: - snat interface address - required: false - default: None snat_bidirectional: description: - bidirectional flag - required: false - default: "false" + type: bool + default: 'no' dnat_address: description: - dnat translated address - required: false - default: None dnat_port: description: - dnat translated port - required: false - default: None override: description: - attempt to override rule if one with the same name already exists - required: false - default: "false" + type: bool + default: 'no' commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/_panos_security_policy.py b/lib/ansible/modules/network/panos/_panos_security_policy.py index 82e4951d32..041f4c1657 100644 --- a/lib/ansible/modules/network/panos/_panos_security_policy.py +++ b/lib/ansible/modules/network/panos/_panos_security_policy.py @@ -72,11 +72,9 @@ options: description: description: - Description for the security rule. - default: "None" tag: description: - Administrative tags that can be added to the rule. Note, tags must be already defined. - default: "None" from_zone: description: - List of source zones. @@ -114,7 +112,6 @@ options: log_start: description: - Whether to log at session start. - default: false log_end: description: - Whether to log at session end. @@ -127,40 +124,31 @@ options: description: > Security profile group that is already defined in the system. This property supersedes antivirus, vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties. - default: None antivirus: description: - Name of the already defined antivirus profile. - default: None vulnerability: description: - Name of the already defined vulnerability profile. - default: None spyware: description: - Name of the already defined spyware profile. - default: None url_filtering: description: - Name of the already defined url_filtering profile. - default: None file_blocking: description: - Name of the already defined file_blocking profile. - default: None data_filtering: description: - Name of the already defined data_filtering profile. - default: None wildfire_analysis: description: - Name of the already defined wildfire_analysis profile. - default: None devicegroup: description: > Device groups are used for the Panorama interaction with Firewall(s). The group must exists on Panorama. If device group is not define we assume that we are contacting Firewall. - default: None commit: description: - Commit configuration if changed. diff --git a/lib/ansible/modules/network/panos/panos_admin.py b/lib/ansible/modules/network/panos/panos_admin.py index 436a39cd40..87ab02117c 100644 --- a/lib/ansible/modules/network/panos/panos_admin.py +++ b/lib/ansible/modules/network/panos/panos_admin.py @@ -47,12 +47,10 @@ options: username: description: - username for authentication - required: false default: "admin" admin_username: description: - username for admin user - required: false default: "admin" admin_password: description: @@ -61,13 +59,11 @@ options: role: description: - role for admin user - required: false - default: null commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_cert_gen_ssh.py b/lib/ansible/modules/network/panos/panos_cert_gen_ssh.py index 992317ddc8..31d5730c19 100644 --- a/lib/ansible/modules/network/panos/panos_cert_gen_ssh.py +++ b/lib/ansible/modules/network/panos/panos_cert_gen_ssh.py @@ -37,36 +37,29 @@ options: description: - IP address (or hostname) of PAN-OS device being configured. required: true - default: null key_filename: description: - Location of the filename that is used for the auth. Either I(key_filename) or I(password) is required. required: true - default: null password: description: - Password credentials to use for auth. Either I(key_filename) or I(password) is required. required: true - default: null cert_friendly_name: description: - Human friendly certificate name (not CN but just a friendly name). required: true - default: null cert_cn: description: - Certificate CN (common name) embedded in the certificate signature. required: true - default: null signed_by: description: - Undersigning authority (CA) that MUST already be presents on the device. required: true - default: null rsa_nbits: description: - Number of bits used by the RSA algorithm for the certificate generation. - required: false default: "2048" ''' diff --git a/lib/ansible/modules/network/panos/panos_commit.py b/lib/ansible/modules/network/panos/panos_commit.py index 0f7cd8b916..7239a1fcb0 100644 --- a/lib/ansible/modules/network/panos/panos_commit.py +++ b/lib/ansible/modules/network/panos/panos_commit.py @@ -42,23 +42,19 @@ options: username: description: - username for authentication - required: false default: "admin" interval: description: - interval for checking commit job - required: false default: 0.5 timeout: description: - timeout for commit job - required: false - default: None sync: description: - if commit should be synchronous - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_dag.py b/lib/ansible/modules/network/panos/panos_dag.py index 7748c7ccc2..4c4c5c6808 100644 --- a/lib/ansible/modules/network/panos/panos_dag.py +++ b/lib/ansible/modules/network/panos/panos_dag.py @@ -34,32 +34,27 @@ options: description: - IP address (or hostname) of PAN-OS device required: true - default: null password: description: - password for authentication required: true - default: null username: description: - username for authentication - required: false default: "admin" dag_name: description: - name of the dynamic address group required: true - default: null dag_filter: description: - dynamic filter user by the dynamic address group required: true - default: null commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_import.py b/lib/ansible/modules/network/panos/panos_import.py index 6d1df87b42..64496463ff 100644 --- a/lib/ansible/modules/network/panos/panos_import.py +++ b/lib/ansible/modules/network/panos/panos_import.py @@ -43,23 +43,17 @@ options: username: description: - Username for device authentication. - required: false default: "admin" category: description: - Category of file uploaded. The default is software. - required: false default: software file: description: - Location of the file to import into device. - required: false - default: None url: description: - URL of the file that will be imported to device. - required: false - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_loadcfg.py b/lib/ansible/modules/network/panos/panos_loadcfg.py index bd30e3accb..d8f8cb38a4 100644 --- a/lib/ansible/modules/network/panos/panos_loadcfg.py +++ b/lib/ansible/modules/network/panos/panos_loadcfg.py @@ -41,18 +41,15 @@ options: username: description: - username for authentication - required: false default: "admin" file: description: - configuration file to load - required: false - default: None commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_mgtconfig.py b/lib/ansible/modules/network/panos/panos_mgtconfig.py index 427cb1d48a..4ae8b948a5 100644 --- a/lib/ansible/modules/network/panos/panos_mgtconfig.py +++ b/lib/ansible/modules/network/panos/panos_mgtconfig.py @@ -41,33 +41,24 @@ options: username: description: - username for authentication - required: false default: "admin" dns_server_primary: description: - address of primary DNS server - required: false - default: None dns_server_secondary: description: - address of secondary DNS server - required: false - default: None panorama_primary: description: - address of primary Panorama server - required: false - default: None panorama_secondary: description: - address of secondary Panorama server - required: false - default: None commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_nat_rule.py b/lib/ansible/modules/network/panos/panos_nat_rule.py index c723064d89..bcc5673b8c 100644 --- a/lib/ansible/modules/network/panos/panos_nat_rule.py +++ b/lib/ansible/modules/network/panos/panos_nat_rule.py @@ -56,67 +56,50 @@ options: source_ip: description: - list of source addresses - required: false default: ["any"] destination_ip: description: - list of destination addresses - required: false default: ["any"] service: description: - service - required: false default: "any" snat_type: description: - type of source translation - required: false - default: None snat_address_type: description: - type of source translation. Supported values are I(translated-address)/I(translated-address). - required: false default: 'translated-address' snat_static_address: description: - Source NAT translated address. Used with Static-IP translation. - required: false - default: None snat_dynamic_address: description: - Source NAT translated address. Used with Dynamic-IP and Dynamic-IP-and-Port. - required: false - default: None snat_interface: description: - snat interface - required: false - default: None snat_interface_address: description: - snat interface address - required: false - default: None snat_bidirectional: description: - bidirectional flag - required: false - default: "false" + type: bool + default: 'no' dnat_address: description: - dnat translated address - required: false - default: None dnat_port: description: - dnat translated port - required: false - default: None commit: description: - Commit configuration if changed. - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_object.py b/lib/ansible/modules/network/panos/panos_object.py index 029dabac25..5769b48bc9 100644 --- a/lib/ansible/modules/network/panos/panos_object.py +++ b/lib/ansible/modules/network/panos/panos_object.py @@ -47,7 +47,6 @@ options: username: description: - Username credentials to use for authentication. - required: false default: "admin" password: description: @@ -110,8 +109,6 @@ options: description: > - The name of the Panorama device group. The group must exist on Panorama. If device group is not defined it is assumed that we are contacting a firewall. - required: false - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_pg.py b/lib/ansible/modules/network/panos/panos_pg.py index 8b8f4b0cd5..5607099f79 100644 --- a/lib/ansible/modules/network/panos/panos_pg.py +++ b/lib/ansible/modules/network/panos/panos_pg.py @@ -41,7 +41,6 @@ options: username: description: - username for authentication - required: false default: "admin" pg_name: description: @@ -50,43 +49,29 @@ options: data_filtering: description: - name of the data filtering profile - required: false - default: None file_blocking: description: - name of the file blocking profile - required: false - default: None spyware: description: - name of the spyware profile - required: false - default: None url_filtering: description: - name of the url filtering profile - required: false - default: None virus: description: - name of the anti-virus profile - required: false - default: None vulnerability: description: - name of the vulnerability profile - required: false - default: None wildfire: description: - name of the wildfire analysis profile - required: false - default: None commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_query_rules.py b/lib/ansible/modules/network/panos/panos_query_rules.py index 294bf6b2ce..60ee875518 100644 --- a/lib/ansible/modules/network/panos/panos_query_rules.py +++ b/lib/ansible/modules/network/panos/panos_query_rules.py @@ -49,7 +49,6 @@ options: username: description: - Username credentials to use for authentication. - required: false default: "admin" password: description: @@ -61,53 +60,33 @@ options: application: description: - Name of the application or application group to be queried. - required: false - default: None source_zone: description: - Name of the source security zone to be queried. - required: false - default: None source_ip: description: - The source IP address to be queried. - required: false - default: None source_port: description: - The source port to be queried. - required: false - default: None destination_zone: description: - Name of the destination security zone to be queried. - required: false - default: None destination_ip: description: - The destination IP address to be queried. - required: false - default: None destination_port: description: - The destination port to be queried. - required: false - default: None protocol: description: - The protocol used to be queried. Must be either I(tcp) or I(udp). - required: false - default: None tag_name: description: - Name of the rule tag to be queried. - required: false - default: None devicegroup: description: - The Panorama device group in which to conduct the query. - required: false - default: None ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_sag.py b/lib/ansible/modules/network/panos/panos_sag.py index e5b468d806..12d56d8f58 100755 --- a/lib/ansible/modules/network/panos/panos_sag.py +++ b/lib/ansible/modules/network/panos/panos_sag.py @@ -36,16 +36,13 @@ options: description: - IP address (or hostname) of PAN-OS device required: true - default: null password: description: - password for authentication required: true - default: null username: description: - username for authentication - required: false default: "admin" api_key: description: @@ -54,38 +51,29 @@ options: description: - name of the dynamic address group required: true - default: null static_match_filter: description: - Static filter user by the address group required: true - default: null devicegroup: description: > - The name of the Panorama device group. The group must exist on Panorama. If device group is not defined it is assumed that we are contacting a firewall. - required: false - default: None description: description: - The purpose / objective of the static Address Group - required: false - default: null tags: description: - Tags to be associated with the address group - required: false - default: null commit: description: - commit if changed - required: false - default: true + type: bool + default: 'yes' operation: description: - The operation to perform Supported values are I(add)/I(list)/I(delete). required: true - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/panos/panos_security_rule.py b/lib/ansible/modules/network/panos/panos_security_rule.py index e53a6a5aeb..43242e83ec 100755 --- a/lib/ansible/modules/network/panos/panos_security_rule.py +++ b/lib/ansible/modules/network/panos/panos_security_rule.py @@ -60,11 +60,9 @@ options: description: description: - Description for the security rule. - default: "None" tag_name: description: - Administrative tags that can be added to the rule. Note, tags must be already defined. - default: "None" source_zone: description: - List of source zones. @@ -102,7 +100,6 @@ options: log_start: description: - Whether to log at session start. - default: false log_end: description: - Whether to log at session end. @@ -115,44 +112,36 @@ options: description: > - Security profile group that is already defined in the system. This property supersedes antivirus, vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties. - default: None antivirus: description: - Name of the already defined antivirus profile. - default: None vulnerability: description: - Name of the already defined vulnerability profile. - default: None spyware: description: - Name of the already defined spyware profile. - default: None url_filtering: description: - Name of the already defined url_filtering profile. - default: None file_blocking: description: - Name of the already defined file_blocking profile. - default: None data_filtering: description: - Name of the already defined data_filtering profile. - default: None wildfire_analysis: description: - Name of the already defined wildfire_analysis profile. - default: None devicegroup: description: > - Device groups are used for the Panorama interaction with Firewall(s). The group must exists on Panorama. If device group is not define we assume that we are contacting Firewall. - default: None commit: description: - Commit configuration if changed. - default: true + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/network/radware/vdirect_commit.py b/lib/ansible/modules/network/radware/vdirect_commit.py index 51ba8c049e..3750fff09e 100644 --- a/lib/ansible/modules/network/radware/vdirect_commit.py +++ b/lib/ansible/modules/network/radware/vdirect_commit.py @@ -51,44 +51,35 @@ options: description: - vDirect server username, may be set as C(VDIRECT_USER) environment variable. required: true - default: None vdirect_password: description: - vDirect server password, may be set as C(VDIRECT_PASSWORD) environment variable. required: true - default: None vdirect_secondary_ip: description: - Secondary vDirect server IP address, may be set as C(VDIRECT_SECONDARY_IP) environment variable. - required: false - default: None vdirect_wait: description: - Wait for async operation to complete, may be set as C(VDIRECT_WAIT) environment variable. - required: false type: bool default: 'yes' vdirect_https_port: description: - vDirect server HTTPS port number, may be set as C(VDIRECT_HTTPS_PORT) environment variable. - required: false default: 2189 vdirect_http_port: description: - vDirect server HTTP port number, may be set as C(VDIRECT_HTTP_PORT) environment variable. - required: false default: 2188 vdirect_timeout: description: - Amount of time to wait for async operation completion [seconds], - may be set as C(VDIRECT_TIMEOUT) environment variable. - required: false default: 60 vdirect_use_ssl: description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection, - may be set as C(VDIRECT_HTTPS) or C(VDIRECT_USE_SSL) environment variable. - required: false type: bool default: 'yes' vdirect_validate_certs: @@ -96,7 +87,6 @@ options: - If C(no), SSL certificates will not be validated, - may be set as C(VDIRECT_VALIDATE_CERTS) or C(VDIRECT_VERIFY) environment variable. - This should only set to C(no) used on personally controlled sites using self-signed certificates. - required: false type: bool default: 'yes' devices: @@ -106,19 +96,16 @@ options: apply: description: - If C(no), apply action will not be performed. Relevant for ADC devices only. - required: false type: bool default: 'yes' save: description: - If C(no), save action will not be performed. Relevant for ADC devices only. - required: false type: bool default: 'yes' sync: description: - If C(no), sync action will not be performed. Relevant for ADC devices only. - required: false type: bool default: 'yes' diff --git a/lib/ansible/modules/network/radware/vdirect_file.py b/lib/ansible/modules/network/radware/vdirect_file.py index 04df7f5b8f..3dd5d35830 100644 --- a/lib/ansible/modules/network/radware/vdirect_file.py +++ b/lib/ansible/modules/network/radware/vdirect_file.py @@ -45,44 +45,35 @@ options: description: - vDirect server username, may be set as VDIRECT_USER environment variable. required: true - default: None vdirect_password: description: - vDirect server password, may be set as VDIRECT_PASSWORD environment variable. required: true - default: None vdirect_secondary_ip: description: - Secondary vDirect server IP address, may be set as VDIRECT_SECONDARY_IP environment variable. - required: false - default: None vdirect_wait: description: - Wait for async operation to complete, may be set as VDIRECT_WAIT environment variable. - required: false type: bool default: 'yes' vdirect_https_port: description: - vDirect server HTTPS port number, may be set as VDIRECT_HTTPS_PORT environment variable. - required: false default: 2189 vdirect_http_port: description: - vDirect server HTTP port number, may be set as VDIRECT_HTTP_PORT environment variable. - required: false default: 2188 vdirect_timeout: description: - Amount of time to wait for async operation completion [seconds], - may be set as VDIRECT_TIMEOUT environment variable. - required: false default: 60 vdirect_use_ssl: description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection, - may be set as VDIRECT_HTTPS or VDIRECT_USE_SSL environment variable. - required: false type: bool default: 'yes' vdirect_validate_certs: @@ -90,7 +81,6 @@ options: - If C(no), SSL certificates will not be validated, - may be set as VDIRECT_VALIDATE_CERTS or VDIRECT_VERIFY environment variable. - This should only set to C(no) used on personally controlled sites using self-signed certificates. - required: false type: bool default: 'yes' file_name: diff --git a/lib/ansible/modules/network/radware/vdirect_runnable.py b/lib/ansible/modules/network/radware/vdirect_runnable.py index 14bbab08ea..41b62f400f 100644 --- a/lib/ansible/modules/network/radware/vdirect_runnable.py +++ b/lib/ansible/modules/network/radware/vdirect_runnable.py @@ -45,44 +45,35 @@ options: description: - vDirect server username, may be set as C(VDIRECT_USER) environment variable. required: true - default: None vdirect_password: description: - vDirect server password, may be set as C(VDIRECT_PASSWORD) environment variable. required: true - default: None vdirect_secondary_ip: description: - Secondary vDirect server IP address, may be set as C(VDIRECT_SECONDARY_IP) environment variable. - required: false - default: None vdirect_wait: description: - Wait for async operation to complete, may be set as C(VDIRECT_WAIT) environment variable. - required: false type: bool default: 'yes' vdirect_https_port: description: - vDirect server HTTPS port number, may be set as C(VDIRECT_HTTPS_PORT) environment variable. - required: false default: 2189 vdirect_http_port: description: - vDirect server HTTP port number, may be set as C(VDIRECT_HTTP_PORT) environment variable. - required: false default: 2188 vdirect_timeout: description: - Amount of time to wait for async operation completion [seconds], - may be set as C(VDIRECT_TIMEOUT) environment variable. - required: false default: 60 vdirect_use_ssl: description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection, - may be set as C(VDIRECT_HTTPS) or C(VDIRECT_USE_SSL) environment variable. - required: false type: bool default: 'yes' vdirect_validate_certs: @@ -90,7 +81,6 @@ options: - If C(no), SSL certificates will not be validated, - may be set as C(VDIRECT_VALIDATE_CERTS) or C(VDIRECT_VERIFY) environment variable. - This should only set to C(no) used on personally controlled sites using self-signed certificates. - required: false type: bool default: 'yes' runnable_type: @@ -107,12 +97,10 @@ options: description: - Workflow action name to run. - Required if I(runnable_type=Workflow). - required: false parameters: description: - Action parameters dictionary. In case of ConfigurationTemplate runnable type, - the device connection details should always be passed as a parameter. - required: false requirements: - "vdirect-client >= 4.1.1" diff --git a/lib/ansible/modules/network/sros/sros_command.py b/lib/ansible/modules/network/sros/sros_command.py index 05883d9cd1..a3dd87103b 100644 --- a/lib/ansible/modules/network/sros/sros_command.py +++ b/lib/ansible/modules/network/sros/sros_command.py @@ -41,8 +41,6 @@ options: before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples. - required: false - default: null aliases: ['waitfor'] match: description: @@ -52,7 +50,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -61,7 +58,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditions. - required: false default: 10 interval: description: @@ -69,7 +65,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 """ diff --git a/lib/ansible/modules/network/sros/sros_config.py b/lib/ansible/modules/network/sros/sros_config.py index 6cad4b67eb..b1332cde86 100644 --- a/lib/ansible/modules/network/sros/sros_config.py +++ b/lib/ansible/modules/network/sros/sros_config.py @@ -33,8 +33,6 @@ options: command syntax as some commands are automatically modified by the device config parser. The I(lines) argument only supports current context lines. See EXAMPLES - required: false - default: null aliases: ['commands'] parents: description: @@ -42,8 +40,6 @@ options: the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. - required: false - default: null src: description: - Specifies the source path to the file that contains the configuration @@ -51,8 +47,6 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with I(lines), I(parents). - required: false - default: null version_added: "2.2" before: description: @@ -61,16 +55,12 @@ options: the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system. - required: false - default: null after: description: - The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set. - required: false - default: null match: description: - Instructs the module on the way to perform the matching of @@ -81,7 +71,6 @@ options: must be an equal match. Finally, if match is set to I(none), the module will not attempt to compare the source configuration with the running configuration on the remote device. - required: false default: line choices: ['line', 'strict', 'exact', 'none'] replace: @@ -92,7 +81,6 @@ options: mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. - required: false default: line choices: ['line', 'block'] force: @@ -104,9 +92,7 @@ options: - Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in a future release. - required: false - default: false - choices: [ "true", "false" ] + type: bool version_added: "2.2" backup: description: @@ -115,9 +101,8 @@ options: changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' version_added: "2.2" config: description: @@ -125,8 +110,6 @@ options: the base configuration to be used to validate configuration changes necessary. If this argument is provided, the module will not download the running-config from the remote node. - required: false - default: null version_added: "2.2" defaults: description: @@ -134,9 +117,8 @@ options: when getting the remote device running config. When enabled, the module will get the current config by issuing the command C(show running-config all). - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' aliases: ['detail'] version_added: "2.2" save: @@ -144,9 +126,8 @@ options: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. - required: false - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' version_added: "2.2" """ diff --git a/lib/ansible/modules/network/sros/sros_rollback.py b/lib/ansible/modules/network/sros/sros_rollback.py index 923996dd2a..12298ebe08 100644 --- a/lib/ansible/modules/network/sros/sros_rollback.py +++ b/lib/ansible/modules/network/sros/sros_rollback.py @@ -30,31 +30,23 @@ options: - The I(rollback_location) specifies the location and filename of the rollback checkpoint files. This argument supports any valid local or remote URL as specified in SR OS - required: false - default: null remote_max_checkpoints: description: - The I(remote_max_checkpoints) argument configures the maximum number of rollback files that can be transferred and saved to a remote location. Valid values for this argument are in the range of 1 to 50 - required: false - default: null local_max_checkpoints: description: - The I(local_max_checkpoints) argument configures the maximum number of rollback files that can be saved on the devices local compact flash. Valid values for this argument are in the range of 1 to 50 - required: false - default: null rescue_location: description: - The I(rescue_location) specifies the location of the rescue file. This argument supports any valid local or remote URL as specified in SR OS - required: false - default: null state: description: - The I(state) argument specifies the state of the configuration @@ -63,7 +55,6 @@ options: devices active configuration. When the state value is set to C(false) the configuration values are removed from the devices active configuration. - required: false default: present choices: ['present', 'absent'] """ diff --git a/lib/ansible/modules/network/system/net_banner.py b/lib/ansible/modules/network/system/net_banner.py index f46798cdd3..92ce7576ce 100644 --- a/lib/ansible/modules/network/system/net_banner.py +++ b/lib/ansible/modules/network/system/net_banner.py @@ -33,7 +33,6 @@ options: - The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires I(state=present). - default: null state: description: - Specifies whether or not the configuration is diff --git a/lib/ansible/modules/network/system/net_ping.py b/lib/ansible/modules/network/system/net_ping.py index 67698a248a..fe2eb39dab 100644 --- a/lib/ansible/modules/network/system/net_ping.py +++ b/lib/ansible/modules/network/system/net_ping.py @@ -27,7 +27,6 @@ options: count: description: - Number of packets to send. - required: false default: 5 dest: description: @@ -36,8 +35,6 @@ options: source: description: - The source IP Address. - required: false - default: null state: description: - Determines if the expected result is success or fail. @@ -46,7 +43,6 @@ options: vrf: description: - The VRF to use for forwarding. - required: false default: default notes: - For Windows targets, use the M(win_ping) module instead. diff --git a/lib/ansible/modules/network/vyos/vyos_banner.py b/lib/ansible/modules/network/vyos/vyos_banner.py index 4f8096c9af..19d55fd934 100644 --- a/lib/ansible/modules/network/vyos/vyos_banner.py +++ b/lib/ansible/modules/network/vyos/vyos_banner.py @@ -41,14 +41,12 @@ options: - Specifies which banner that should be configured on the remote device. required: true - default: null choices: ['pre-login', 'post-login'] text: description: - The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires I(state=present). - default: null state: description: - Specifies whether or not the configuration is present in the current diff --git a/lib/ansible/modules/network/vyos/vyos_command.py b/lib/ansible/modules/network/vyos/vyos_command.py index 3aadc295ab..c174598f35 100644 --- a/lib/ansible/modules/network/vyos/vyos_command.py +++ b/lib/ansible/modules/network/vyos/vyos_command.py @@ -54,8 +54,6 @@ options: the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured I(retries), the task fails. See examples. - required: false - default: null aliases: ['waitfor'] match: description: @@ -65,7 +63,6 @@ options: then all conditionals in the wait_for must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. - required: false default: all choices: ['any', 'all'] retries: @@ -74,7 +71,6 @@ options: before it is considered failed. The command is run on the target device every retry and evaluated against the I(wait_for) conditionals. - required: false default: 10 interval: description: @@ -82,7 +78,6 @@ options: of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again. - required: false default: 1 notes: diff --git a/lib/ansible/modules/network/vyos/vyos_config.py b/lib/ansible/modules/network/vyos/vyos_config.py index d533977910..bd78c17ddd 100644 --- a/lib/ansible/modules/network/vyos/vyos_config.py +++ b/lib/ansible/modules/network/vyos/vyos_config.py @@ -42,16 +42,12 @@ options: - The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. - required: false - default: null src: description: - The C(src) argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables. - required: no - default: null match: description: - The C(match) argument controls the method used to match @@ -60,7 +56,6 @@ options: deltas are loaded. If the C(match) argument is set to C(none) the active configuration is ignored and the configuration is always loaded. - required: false default: line choices: ['line', 'none'] backup: @@ -68,16 +63,14 @@ options: - The C(backup) argument will backup the current devices active configuration to the Ansible control host prior to making any changes. The backup file will be located in the backup folder - in the root of the playbook - required: false - default: false - choices: ['yes', 'no'] + in the root of the playbook. + type: bool + default: 'no' comment: description: - Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored. - required: false default: 'configured by vyos_config' config: description: @@ -85,17 +78,14 @@ options: to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device. - required: false - default: null save: description: - The C(save) argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved. - required: false - default: false - choices: ['yes', 'no'] + type: bool + default: 'no' """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/vyos/vyos_system.py b/lib/ansible/modules/network/vyos/vyos_system.py index 77d2670f9a..dd3d0ba263 100644 --- a/lib/ansible/modules/network/vyos/vyos_system.py +++ b/lib/ansible/modules/network/vyos/vyos_system.py @@ -46,8 +46,6 @@ options: description: - A list of name servers to use with the device. Mutually exclusive with I(domain_search) - required: false - default: null aliases: ['name_server'] domain_search: description: diff --git a/lib/ansible/modules/notification/catapult.py b/lib/ansible/modules/notification/catapult.py index 8f511bc9e1..a150e9759f 100644 --- a/lib/ansible/modules/notification/catapult.py +++ b/lib/ansible/modules/notification/catapult.py @@ -27,17 +27,14 @@ options: description: - One of your catapult telephone numbers the message should come from (must be in E.164 format, like C(+19195551212)). required: true - default: null dest: description: - The phone number or numbers the message should be sent to (must be in E.164 format, like C(+19195551212)). required: true - default: null msg: description: - The contents of the text message (must be 2048 characters or less). required: true - default: null media: description: - For MMS messages, a media url to the location of the media to be sent with the message. @@ -45,17 +42,14 @@ options: description: - User Id from Api account page. required: true - default: null api_token: description: - Api Token from Api account page. required: true - default: null api_secret: description: - Api Secret from Api account page. required: true - default: null author: "Jonathan Mainguy (@Jmainguy)" notes: diff --git a/lib/ansible/modules/notification/hipchat.py b/lib/ansible/modules/notification/hipchat.py index f3be40e49d..84090b9dd9 100644 --- a/lib/ansible/modules/notification/hipchat.py +++ b/lib/ansible/modules/notification/hipchat.py @@ -33,49 +33,40 @@ options: description: - Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated. - required: false default: Ansible msg: description: - The message body. required: true - default: null color: description: - Background color for the message. - required: false default: yellow choices: [ "yellow", "red", "green", "purple", "gray", "random" ] msg_format: description: - Message format. - required: false default: text choices: [ "text", "html" ] notify: description: - If true, a notification will be triggered for users in the room. - required: false + type: bool default: 'yes' - choices: [ "yes", "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. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: 1.5.1 api: description: - API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with C(/v2) instead of C(/v1). - required: false default: 'https://api.hipchat.com/v1' version_added: 1.6.0 - -requirements: [ ] author: "WAKAYAMA Shirou (@shirou), BOURDEL Paul (@pb8226)" ''' diff --git a/lib/ansible/modules/notification/irc.py b/lib/ansible/modules/notification/irc.py index 51809d82a0..7786dde375 100644 --- a/lib/ansible/modules/notification/irc.py +++ b/lib/ansible/modules/notification/irc.py @@ -24,34 +24,27 @@ options: server: description: - IRC server name/address - required: false default: localhost port: description: - IRC server port number - required: false default: 6667 nick: description: - Nickname to send the message from. May be shortened, depending on server's NICKLEN setting. - required: false default: ansible msg: description: - The message body. required: true - default: null topic: description: - Set the channel topic - required: false - default: null version_added: "2.0" color: description: - Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none"). Added 11 more colors in version 2.0. - required: false default: "none" choices: [ "none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan", "light_blue", "pink", "gray", "light_gray"] @@ -62,18 +55,14 @@ options: nick_to: description: - A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them. - required: false - default: null version_added: "2.0" key: description: - Channel key - required: false version_added: "1.7" passwd: description: - Server password - required: false timeout: description: - Timeout to use while waiting for successful registration and join @@ -83,19 +72,19 @@ options: use_ssl: description: - Designates whether TLS/SSL should be used when connecting to the IRC server - default: False + type: bool + default: 'no' version_added: "1.8" part: description: - Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages. - default: True + type: bool + default: 'yes' version_added: "2.0" style: description: - Text style for the message. Note italic does not work on some clients - default: None - required: False choices: [ "bold", "underline", "reverse", "italic" ] version_added: "2.0" diff --git a/lib/ansible/modules/notification/jabber.py b/lib/ansible/modules/notification/jabber.py index f992817674..225ebdacc1 100644 --- a/lib/ansible/modules/notification/jabber.py +++ b/lib/ansible/modules/notification/jabber.py @@ -37,20 +37,16 @@ options: description: - The message body. required: true - default: null host: description: - host to connect, overrides user info - required: false port: description: - port to connect to, overrides default - required: false default: 5222 encoding: description: - message encoding - required: false # informational: requirements for nodes requirements: diff --git a/lib/ansible/modules/notification/mqtt.py b/lib/ansible/modules/notification/mqtt.py index 487ecf4f74..772ef37ea6 100644 --- a/lib/ansible/modules/notification/mqtt.py +++ b/lib/ansible/modules/notification/mqtt.py @@ -24,42 +24,34 @@ options: server: description: - MQTT broker address/name - required: false default: localhost port: description: - MQTT broker port number - required: false default: 1883 username: description: - Username to authenticate against the broker. - required: false password: description: - Password for C(username) to authenticate against the broker. - required: false client_id: description: - MQTT client identifier - required: false default: hostname + pid topic: description: - MQTT topic name required: true - default: null payload: description: - Payload. The special string C("None") may be used to send a NULL (i.e. empty) payload which is useful to simply notify with the I(topic) or to clear previously retained messages. required: true - default: null qos: description: - QoS (Quality of Service) - required: false default: 0 choices: [ "0", "1", "2" ] retain: @@ -67,8 +59,8 @@ options: - Setting this flag causes the broker to retain (i.e. keep) the message so that applications that subsequently subscribe to the topic can received the last retained message immediately. - required: false - default: False + type: bool + default: 'no' ca_certs: description: - The path to the Certificate Authority certificate files that are to be @@ -79,24 +71,18 @@ options: but will not attempt any form of authentication. This provides basic network encryption but may not be sufficient depending on how the broker is configured. - required: False - default: None version_added: 2.3 certfile: description: - The path pointing to the PEM encoded client certificate. If this is not None it will be used as client information for TLS based authentication. Support for this feature is broker dependent. - required: False - default: None version_added: 2.3 keyfile: description: - The path pointing to the PEM encoded client private key. If this is not None it will be used as client information for TLS based authentication. Support for this feature is broker dependent. - required: False - default: None version_added: 2.3 diff --git a/lib/ansible/modules/notification/pushbullet.py b/lib/ansible/modules/notification/pushbullet.py index a7d50c7175..e1c40b26c3 100644 --- a/lib/ansible/modules/notification/pushbullet.py +++ b/lib/ansible/modules/notification/pushbullet.py @@ -32,18 +32,13 @@ options: - The channel TAG you wish to broadcast a push notification, as seen on the "My Channels" > "Edit your channel" at Pushbullet page. - required: false - default: null device: description: - The device NAME you wish to send a push notification, as seen on the Pushbullet main page. - required: false - default: null push_type: description: - Thing you wish to push. - required: false default: note choices: [ "note", "link" ] title: @@ -53,7 +48,6 @@ options: body: description: - Body of the notification, e.g. Details of the fault you're alerting. - required: false notes: - Requires pushbullet.py Python package on the remote host. diff --git a/lib/ansible/modules/notification/rocketchat.py b/lib/ansible/modules/notification/rocketchat.py index 420b3258b8..1652027646 100644 --- a/lib/ansible/modules/notification/rocketchat.py +++ b/lib/ansible/modules/notification/rocketchat.py @@ -38,7 +38,6 @@ options: protocol: description: - Specify the protocol used to send notification messages before the webhook url. (i.e. http or https) - required: false default: https choices: - 'http' @@ -46,34 +45,25 @@ options: msg: description: - Message to be sent. - required: false - default: None channel: description: - Channel to send the message to. If absent, the message goes to the channel selected for the I(token) specified during the creation of webhook. - required: false - default: None username: description: - This is the sender of the message. - required: false default: "Ansible" icon_url: description: - URL for the message sender's icon. - required: false default: "https://www.ansible.com/favicon.ico" icon_emoji: description: - Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat. (for example :thumbsup:) (if I(icon_emoji) is set, I(icon_url) will not be used) - required: false - default: None link_names: description: - Automatically create links for channels and usernames in I(msg). - required: false default: 1 choices: - 1 @@ -82,15 +72,11 @@ options: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - required: false + type: bool default: 'yes' - choices: - - 'yes' - - 'no' color: description: - Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message - required: false default: 'normal' choices: - 'normal' @@ -100,8 +86,6 @@ options: attachments: description: - Define a list of attachments. - required: false - default: None """ EXAMPLES = """ diff --git a/lib/ansible/modules/notification/sendgrid.py b/lib/ansible/modules/notification/sendgrid.py index 88e476a365..478d502d4b 100644 --- a/lib/ansible/modules/notification/sendgrid.py +++ b/lib/ansible/modules/notification/sendgrid.py @@ -37,14 +37,10 @@ options: description: - username for logging into the SendGrid account. - Since 2.2 it is only required if api_key is not supplied. - required: false - default: null password: description: - password that corresponds to the username - Since 2.2 it is only required if api_key is not supplied. - required: false - default: null from_address: description: - the address in the "from" field for the email @@ -61,44 +57,32 @@ options: description: - sendgrid API key to use instead of username/password version_added: 2.2 - required: false - default: null cc: description: - a list of email addresses to cc version_added: 2.2 - required: false - default: null bcc: description: - a list of email addresses to bcc version_added: 2.2 - required: false - default: null attachments: description: - a list of relative or explicit paths of files you want to attach (7MB limit as per SendGrid docs) version_added: 2.2 - required: false - default: null from_name: description: - the name you want to appear in the from field, i.e 'John Doe' version_added: 2.2 - required: false - default: null html_body: description: - whether the body is html content that should be rendered version_added: 2.2 - required: false - default: false + type: bool + default: 'no' headers: description: - a dict to pass on as headers version_added: 2.2 - required: false - default: null author: "Matt Makai (@makaimc)" ''' diff --git a/lib/ansible/modules/notification/slack.py b/lib/ansible/modules/notification/slack.py index c9f7fdedbb..10167ff3a7 100644 --- a/lib/ansible/modules/notification/slack.py +++ b/lib/ansible/modules/notification/slack.py @@ -30,8 +30,6 @@ options: - Slack (sub)domain for your environment without protocol. (i.e. C(example.slack.com)) In 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information. - required: false - default: None token: description: - Slack integration token. This authenticates you to the slack service. @@ -54,32 +52,23 @@ options: - Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands should be converted to HTML entities (e.g. & to &) before sending. See Slack's documentation (U(https://api.slack.com/docs/message-formatting)) for more. - required: false - default: None channel: description: - Channel to send the message to. If absent, the message goes to the channel selected for the I(token). - required: false - default: None username: description: - This is the sender of the message. - required: false default: "Ansible" icon_url: description: - Url for the message sender's icon (default C(https://www.ansible.com/favicon.ico)) - required: false icon_emoji: description: - Emoji for the message sender. See Slack documentation for options. (if I(icon_emoji) is set, I(icon_url) will not be used) - required: false - default: None link_names: description: - Automatically create links for channels and usernames in I(msg). - required: false default: 1 choices: - 1 @@ -87,8 +76,6 @@ options: parse: description: - Setting for the message parser at Slack - required: false - default: None choices: - 'full' - 'none' @@ -96,16 +83,12 @@ options: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - required: false + type: bool default: 'yes' - choices: - - 'yes' - - 'no' color: version_added: "2.0" description: - Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message - required: false default: 'normal' choices: - 'normal' @@ -116,8 +99,6 @@ options: description: - Define a list of attachments. This list mirrors the Slack JSON API. - For more information, see also in the (U(https://api.slack.com/docs/attachments)). - required: false - default: None """ EXAMPLES = """ diff --git a/lib/ansible/modules/packaging/language/bower.py b/lib/ansible/modules/packaging/language/bower.py index c5bd296441..5202340330 100644 --- a/lib/ansible/modules/packaging/language/bower.py +++ b/lib/ansible/modules/packaging/language/bower.py @@ -25,19 +25,16 @@ options: name: description: - The name of a bower package to install - required: false offline: description: - Install packages from local cache, if the packages were installed before - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' production: description: - Install with --production flag - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.0" path: description: @@ -46,19 +43,15 @@ options: relative_execpath: description: - Relative path to bower executable from install path - default: null - required: false version_added: "2.1" state: description: - The state of the bower package - required: false default: present choices: [ "present", "absent", "latest" ] version: description: - The version to be installed - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/packaging/language/bundler.py b/lib/ansible/modules/packaging/language/bundler.py index a82394829e..1d3bef1e0c 100644 --- a/lib/ansible/modules/packaging/language/bundler.py +++ b/lib/ansible/modules/packaging/language/bundler.py @@ -24,19 +24,15 @@ options: executable: description: - The path to the bundler executable - required: false - default: null state: description: - The desired state of the Gem bundle. C(latest) updates gems to the most recent, acceptable version - required: false choices: [present, latest] default: present chdir: description: - The directory to execute the bundler commands from. This directoy needs to contain a valid Gemfile or .bundle/ directory - required: false default: temporary working directory exclude_groups: description: @@ -44,46 +40,38 @@ options: applies when state is C(present). Bundler considers this a 'remembered' property for the Gemfile and will automatically exclude groups in future operations even if C(exclude_groups) is not set - required: false - default: null clean: description: - Only applies if state is C(present). If set removes any gems on the target host that are not in the gemfile - required: false - choices: [yes, no] - default: "no" + type: bool + default: 'no' gemfile: description: - Only applies if state is C(present). The path to the gemfile to use to install gems. - required: false default: Gemfile in current directory local: description: - If set only installs gems from the cache on the target host - required: false - choices: [yes, no] - default: "no" + type: bool + default: 'no' deployment_mode: description: - Only applies if state is C(present). If set it will only install gems that are in the default or production groups. Requires a Gemfile.lock file to have been created prior - required: false - choices: [yes, no] - default: "no" + type: bool + default: 'no' user_install: description: - Only applies if state is C(present). Installs gems in the local user's cache or for all users - required: false - choices: [yes, no] - default: "yes" + type: bool + default: 'yes' gem_path: description: - Only applies if state is C(present). Specifies the directory to install the gems into. If C(chdir) is set then this path is relative to C(chdir) - required: false default: RubyGems gem paths binstub_directory: description: @@ -92,15 +80,11 @@ options: within the context of the Gemfile and fail if any required gem dependencies are not installed. If C(chdir) is set then this path is relative to C(chdir) - required: false - default: null extra_args: description: - A space separated string of additional commands that can be applied to the Bundler command. Refer to the Bundler documentation for more information - required: false - default: null author: "Tim Hoiberg (@thoiberg)" ''' diff --git a/lib/ansible/modules/packaging/language/cpanm.py b/lib/ansible/modules/packaging/language/cpanm.py index fcd22b6812..1d43e68457 100644 --- a/lib/ansible/modules/packaging/language/cpanm.py +++ b/lib/ansible/modules/packaging/language/cpanm.py @@ -24,59 +24,53 @@ options: name: description: - The name of the Perl library to install. You may use the "full distribution path", e.g. MIYAGAWA/Plack-0.99_05.tar.gz - required: false - default: null aliases: ["pkg"] from_path: description: - The local directory from where to install - required: false - default: null notest: description: - Do not run unit tests - required: false - default: false + type: bool + default: 'no' locallib: description: - Specify the install base to install modules - required: false - default: false + type: bool + default: 'no' mirror: description: - Specifies the base URL for the CPAN mirror to use - required: false - default: false + type: bool + default: 'no' mirror_only: description: - Use the mirror's index file instead of the CPAN Meta DB - required: false - default: false + type: bool + default: 'no' installdeps: description: - Only install dependencies - required: false - default: false + type: bool + default: 'no' version_added: "2.0" version: description: - minimum version of perl module to consider acceptable - required: false - default: false + type: bool + default: 'no' version_added: "2.1" system_lib: description: - Use this if you want to install modules to the system perl include path. You must be root or have "passwordless" sudo for this to work. - This uses the cpanm commandline option '--sudo', which has nothing to do with ansible privilege escalation. - required: false - default: false + type: bool + default: 'no' version_added: "2.0" aliases: ['use_sudo'] executable: description: - Override the path to the cpanm executable - required: false - default: null version_added: "2.1" notes: - Please note that U(http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm) must be installed on the remote host. diff --git a/lib/ansible/modules/packaging/language/easy_install.py b/lib/ansible/modules/packaging/language/easy_install.py index a1b487f7c4..6f7be920b2 100644 --- a/lib/ansible/modules/packaging/language/easy_install.py +++ b/lib/ansible/modules/packaging/language/easy_install.py @@ -25,14 +25,10 @@ options: description: - A Python library name required: true - default: null - aliases: [] virtualenv: description: - an optional I(virtualenv) directory path to install into. If the I(virtualenv) does not exist, it is created automatically - required: false - default: null virtualenv_site_packages: version_added: "1.1" description: @@ -41,15 +37,13 @@ options: changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' virtualenv_command: version_added: "1.1" description: - The command to create the virtual environment with. For example C(pyvenv), C(virtualenv), C(virtualenv2). - required: false default: virtualenv executable: description: @@ -59,13 +53,10 @@ options: and 3.3 installations in the system and you want to run easy_install for the Python 3.3 installation. version_added: "1.3" - required: false - default: null state: version_added: "2.0" description: - The desired state of the library. C(latest) ensures that the latest version is installed. - required: false choices: [present, latest] default: present notes: diff --git a/lib/ansible/modules/packaging/language/maven_artifact.py b/lib/ansible/modules/packaging/language/maven_artifact.py index c03b3eee6c..d4d184ebff 100644 --- a/lib/ansible/modules/packaging/language/maven_artifact.py +++ b/lib/ansible/modules/packaging/language/maven_artifact.py @@ -39,68 +39,54 @@ options: version: description: - The maven version coordinate - required: false default: latest classifier: description: - The maven classifier coordinate - required: false - default: null extension: description: - The maven type/extension coordinate - required: false default: jar repository_url: description: - The URL of the Maven Repository to download from. - Use s3://... if the repository is hosted on Amazon S3, added in version 2.2. - required: false default: http://repo1.maven.org/maven2 username: description: - The username to authenticate as to the Maven Repository. Use AWS secret key of the repository is hosted on S3 - required: false - default: null aliases: [ "aws_secret_key" ] password: description: - The password to authenticate with to the Maven Repository. Use AWS secret access key of the repository is hosted on S3 - required: false - default: null aliases: [ "aws_secret_access_key" ] dest: description: - The path where the artifact should be written to - If file mode or ownerships are specified and destination path already exists, they affect the downloaded file required: true - default: false state: description: - The desired state of the artifact - required: true default: present choices: [present,absent] timeout: description: - Specifies a timeout in seconds for the connection attempt - required: false default: 10 version_added: "2.3" validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: "1.9.3" keep_name: description: - If C(yes), the downloaded artifact's name is preserved, i.e the version number remains part of it. - This option only has effect when C(dest) is a directory and C(version) is set to C(latest). - required: false + type: bool default: 'no' - choices: ['yes', 'no'] version_added: "2.4" verify_checksum: description: diff --git a/lib/ansible/modules/packaging/language/pear.py b/lib/ansible/modules/packaging/language/pear.py index 0d0f19a8db..d067481187 100644 --- a/lib/ansible/modules/packaging/language/pear.py +++ b/lib/ansible/modules/packaging/language/pear.py @@ -34,14 +34,11 @@ options: state: description: - Desired state of the package. - required: false default: "present" choices: ["present", "absent", "latest"] executable: description: - Path to the pear executable - required: false - default: null version_added: "2.4" ''' diff --git a/lib/ansible/modules/packaging/os/apk.py b/lib/ansible/modules/packaging/os/apk.py index 7d94dc7ff4..4b57e050cc 100644 --- a/lib/ansible/modules/packaging/os/apk.py +++ b/lib/ansible/modules/packaging/os/apk.py @@ -29,21 +29,16 @@ options: description: - During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead of holding them) if the currently installed package is no longer available from any repository. - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.4" name: description: - A package name, like C(foo), or multiple packages, like C(foo, bar). - required: false - default: null repository: description: - A package repository or multiple repositories. Unlike with the underlying apk command, this list will override the system repositories rather than supplement them. - required: false - default: null version_added: "2.4" state: description: @@ -51,21 +46,18 @@ options: - C(present) ensures the package(s) is/are present. - C(absent) ensures the package(s) is/are absent. - C(latest) ensures the package(s) is/are present and the latest version(s). - required: false default: present choices: [ "present", "absent", "latest" ] update_cache: description: - Update repository indexes. Can be run with other steps or on it's own. - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' upgrade: description: - Upgrade all installed packages to their latest version. - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' notes: - '"name" and "upgrade" are mutually exclusive.' - When used with a `loop:` each package will be processed individually, it is much more efficient to pass the list directly to the `name` option. diff --git a/lib/ansible/modules/packaging/os/dnf.py b/lib/ansible/modules/packaging/os/dnf.py index 7674ccb397..d2afbdb7d2 100644 --- a/lib/ansible/modules/packaging/os/dnf.py +++ b/lib/ansible/modules/packaging/os/dnf.py @@ -29,19 +29,14 @@ options: When using state=latest, this can be '*' which means run: dnf -y update. You can also pass a url or a local path to a rpm file." required: true - default: null - aliases: [] list: description: - Various (non-idempotent) commands for usage with C(/usr/bin/ansible) and I(not) playbooks. See examples. - required: false - default: null state: description: - Whether to install (C(present), C(latest)), or remove (C(absent)) a package. - required: false choices: [ "present", "latest", "absent" ] default: "present" @@ -50,40 +45,28 @@ options: - I(Repoid) of repositories to enable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a ",". - required: false - default: null - aliases: [] disablerepo: description: - I(Repoid) of repositories to disable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a ",". - required: false - default: null - aliases: [] conf_file: description: - The remote dnf configuration file to use for the transaction. - required: false - default: null - aliases: [] disable_gpg_check: description: - Whether to disable the GPG checking of signatures of packages being installed. Has an effect only if state is I(present) or I(latest). - required: false - default: "no" - choices: ["yes", "no"] - aliases: [] + type: bool + default: 'no' installroot: description: - Specifies an alternative installroot, relative to which all packages will be installed. - required: false version_added: "2.3" default: "/" @@ -92,8 +75,7 @@ options: - If C(yes), removes all "leaf" packages from the system that were originally installed as dependencies of user-installed packages but which are no longer required by any such package. Should be used alone or when state is I(absent) - required: false - choices: [ "yes", "no" ] + type: bool version_added: "2.4" notes: - When used with a `loop:` each package will be processed individually, it is much more efficient to pass the list directly to the `name` option. diff --git a/lib/ansible/modules/packaging/os/homebrew.py b/lib/ansible/modules/packaging/os/homebrew.py index ba7a039ccd..eec6936862 100644 --- a/lib/ansible/modules/packaging/os/homebrew.py +++ b/lib/ansible/modules/packaging/os/homebrew.py @@ -35,41 +35,33 @@ options: name: description: - list of names of packages to install/remove - required: false - default: None aliases: ['pkg', 'package', 'formula'] path: description: - "A ':' separated list of paths to search for 'brew' executable. Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command, providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system." - required: false default: '/usr/local/bin' state: description: - state of the package choices: [ 'head', 'latest', 'present', 'absent', 'linked', 'unlinked' ] - required: false default: present update_homebrew: description: - update homebrew itself first - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' aliases: ['update-brew'] upgrade_all: description: - upgrade all homebrew packages - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' aliases: ['upgrade'] install_options: description: - options flags to install a package - required: false - default: null aliases: ['options'] version_added: "1.4" notes: diff --git a/lib/ansible/modules/packaging/os/homebrew_cask.py b/lib/ansible/modules/packaging/os/homebrew_cask.py index a7df020ab3..f23877f74b 100644 --- a/lib/ansible/modules/packaging/os/homebrew_cask.py +++ b/lib/ansible/modules/packaging/os/homebrew_cask.py @@ -37,47 +37,42 @@ options: path: description: - "':' separated list of paths to search for 'brew' executable." - required: false default: '/usr/local/bin' state: description: - state of the cask choices: [ 'present', 'absent', 'upgraded' ] - required: false default: present update_homebrew: description: - update homebrew itself first. Note that C(brew cask update) is a synonym for C(brew update). - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' aliases: ['update-brew'] version_added: "2.2" install_options: description: - options flags to install a package - required: false - default: null aliases: ['options'] version_added: "2.2" accept_external_apps: description: - allow external apps - required: false - default: False + type: bool + default: 'no' version_added: "2.5.0" upgrade_all: description: - upgrade all casks (mutually exclusive with `upgrade`) - required: False - default: False + type: bool + default: 'no' version_added: "2.5.0" upgrade: description: - upgrade all casks (mutually exclusive with `upgrade_all`) - required: False - default: False + type: bool + default: 'no' version_added: "2.5.0" ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/packaging/os/layman.py b/lib/ansible/modules/packaging/os/layman.py index fe3e102bab..5466d95717 100644 --- a/lib/ansible/modules/packaging/os/layman.py +++ b/lib/ansible/modules/packaging/os/layman.py @@ -37,11 +37,9 @@ options: - An URL of the alternative overlays list that defines the overlay to install. This list will be fetched and saved under C(${overlay_defs})/${name}.xml), where C(overlay_defs) is readed from the Layman's configuration. - required: false state: description: - Whether to install (C(present)), sync (C(updated)), or uninstall (C(absent)) the overlay. - required: false default: present choices: [present, absent, updated] validate_certs: @@ -49,9 +47,8 @@ options: - If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists. Prior to 1.9.3 the code defaulted to C(no). - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: '1.9.3' ''' diff --git a/lib/ansible/modules/packaging/os/pkg5_publisher.py b/lib/ansible/modules/packaging/os/pkg5_publisher.py index 387303affd..a4c2839fd8 100644 --- a/lib/ansible/modules/packaging/os/pkg5_publisher.py +++ b/lib/ansible/modules/packaging/os/pkg5_publisher.py @@ -33,34 +33,25 @@ options: state: description: - Whether to ensure that a publisher is present or absent. - required: false default: present choices: [ present, absent ] sticky: description: - Packages installed from a sticky repository can only receive updates from that repository. - required: false - default: null - choices: [ true, false ] + type: bool enabled: description: - Is the repository enabled or disabled? - required: false - default: null - choices: [ true, false ] + type: bool origin: description: - A path or URL to the repository. - Multiple values may be provided. - required: false - default: null mirror: description: - A path or URL to the repository mirror. - Multiple values may be provided. - required: false - default: null ''' EXAMPLES = ''' # Fetch packages for the solaris publisher direct from Oracle: diff --git a/lib/ansible/modules/packaging/os/pkgin.py b/lib/ansible/modules/packaging/os/pkgin.py index d7cf546794..7707033d2d 100644 --- a/lib/ansible/modules/packaging/os/pkgin.py +++ b/lib/ansible/modules/packaging/os/pkgin.py @@ -41,48 +41,40 @@ options: description: - Name of package to install/remove; - multiple names may be given, separated by commas - required: false - default: null state: description: - Intended state of the package choices: [ 'present', 'absent' ] - required: false default: present update_cache: description: - Update repository database. Can be run with other steps or on it's own. - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.1" upgrade: description: - Upgrade main packages to their newer versions - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.1" full_upgrade: description: - Upgrade all packages to their newer versions - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.1" clean: description: - Clean packages cache - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.1" force: description: - Force package reinstall - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.1" ''' diff --git a/lib/ansible/modules/packaging/os/portage.py b/lib/ansible/modules/packaging/os/portage.py index bc5e169965..f28d30d72e 100644 --- a/lib/ansible/modules/packaging/os/portage.py +++ b/lib/ansible/modules/packaging/os/portage.py @@ -30,127 +30,108 @@ options: package: description: - Package atom or set, e.g. C(sys-apps/foo) or C(>foo-2.13) or C(@world) - required: false - default: null state: description: - State of the package atom - required: false default: "present" choices: [ "present", "installed", "emerged", "absent", "removed", "unmerged", "latest" ] update: description: - Update packages to the best version available (--update) - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' deep: description: - Consider the entire dependency tree of packages (--deep) - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' newuse: description: - Include installed packages where USE flags have changed (--newuse) - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' changed_use: description: - Include installed packages where USE flags have changed, except when - flags that the user has not enabled are added or removed - (--changed-use) - required: false - default: no - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: 1.8 oneshot: description: - Do not add the packages to the world file (--oneshot) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' noreplace: description: - Do not re-emerge installed packages (--noreplace) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' nodeps: description: - Only merge packages but not their dependencies (--nodeps) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' onlydeps: description: - Only merge packages' dependencies but not the packages (--onlydeps) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' depclean: description: - Remove packages not needed by explicitly merged packages (--depclean) - If no package is specified, clean up the world's dependencies - Otherwise, --depclean serves as a dependency aware version of --unmerge - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' quiet: description: - Run emerge in quiet mode (--quiet) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' verbose: description: - Run emerge in verbose mode (--verbose) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' sync: description: - Sync package repositories first - If yes, perform "emerge --sync" - If web, perform "emerge-webrsync" - required: false - default: null choices: [ "web", "yes", "no" ] getbinpkg: description: - Prefer packages specified at PORTAGE_BINHOST in make.conf - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' usepkgonly: description: - Merge only binaries (no compiling). This sets getbinpkg=yes. - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' keepgoing: description: - Continue as much as possible after an error. - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: 2.3 jobs: @@ -158,8 +139,6 @@ options: - Specifies the number of packages to build simultaneously. - "Since version 2.6: Value of 0 or False resets any previously added" - --jobs setting values - required: false - default: None version_added: 2.3 loadavg: @@ -168,17 +147,14 @@ options: - other builds running and the load average is at least LOAD - "Since version 2.6: Value of 0 or False resets any previously added" - --load-average setting values - required: false - default: None version_added: 2.3 quietbuild: description: - Redirect all build output to logs alone, and do not display it - on stdout (--quiet-build) - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: 2.6 quietfail: @@ -186,9 +162,8 @@ options: - Suppresses display of the build log on stdout (--quiet-fail) - Only the die message and the path of the build log will be - displayed on stdout. - required: false - default: False - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: 2.6 requirements: [ gentoolkit ] @@ -196,7 +171,6 @@ author: - "William L Thomson Jr (@wltjr)" - "Yap Sok Ann (@sayap)" - "Andrew Udvare" -notes: [] ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/packaging/os/pulp_repo.py b/lib/ansible/modules/packaging/os/pulp_repo.py index 18317e8480..8b6a676a35 100644 --- a/lib/ansible/modules/packaging/os/pulp_repo.py +++ b/lib/ansible/modules/packaging/os/pulp_repo.py @@ -26,13 +26,11 @@ options: add_export_distributor: description: - Whether or not to add the export distributor to new C(rpm) repositories. - required: false - default: false + type: bool + default: 'no' feed: description: - Upstream feed URL to receive updates from. - required: false - default: null force_basic_auth: description: - httplib2, the library used by the M(uri) module only sends @@ -40,15 +38,12 @@ options: request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the sending of the Basic authentication header upon initial request. - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' importer_ssl_ca_cert: description: - CA certificate string used to validate the feed source SSL certificate. This can be the file content or the path to the file. - required: false - default: null importer_ssl_client_cert: description: - Certificate used as the client certificate when synchronizing the @@ -57,15 +52,11 @@ options: certificate. The specified file may be the certificate itself or a single file containing both the certificate and private key. This can be the file content or the path to the file. - required: false - default: null importer_ssl_client_key: description: - Private key to the certificate specified in I(importer_ssl_client_cert), assuming it is not included in the certificate file itself. This can be the file content or the path to the file. - required: false - default: null name: description: - Name of the repo to add or remove. This correlates to repo-id in Pulp. @@ -74,18 +65,13 @@ options: description: - Proxy url setting for the pulp repository importer. This is in the format scheme://host. - required: false - default: null proxy_port: description: - Proxy port setting for the pulp repository importer. - required: false - default: null publish_distributor: description: - Distributor to use when state is C(publish). The default is to publish all distributors. - required: false pulp_host: description: - URL of the pulp server to connect to. @@ -94,7 +80,6 @@ options: description: - Relative URL for the local repository. required: true - default: null repo_type: description: - Repo plugin type to use (i.e. C(rpm), C(docker)). @@ -102,19 +87,18 @@ options: serve_http: description: - Make the repo available over HTTP. - required: false - default: false + type: bool + default: 'no' serve_https: description: - Make the repo available over HTTPS. - required: false - default: true + type: bool + default: 'yes' state: description: - The repo state. A state of C(sync) will queue a sync of the repo. This is asynchronous but not delayed like a scheduled sync. A state of C(publish) will use the repository's distributor to publish the content. - required: false default: present choices: [ "present", "absent", "sync", "publish" ] url_password: @@ -122,24 +106,20 @@ options: - The password for use in HTTP basic authentication to the pulp API. If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used. - required: false url_username: description: - The username for use in HTTP basic authentication to the pulp API. - required: false 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. - required: false + type: bool default: 'yes' - choices: [ "yes", "no" ] wait_for_completion: description: - Wait for asynchronous tasks to complete before returning. - required: false + type: bool default: 'no' - choices: [ "yes", "no" ] notes: - This module can currently only create distributors and importers on rpm repositories. Contributions to support other repo types are welcome. diff --git a/lib/ansible/modules/packaging/os/redhat_subscription.py b/lib/ansible/modules/packaging/os/redhat_subscription.py index 5b7376631b..c9c979fc11 100644 --- a/lib/ansible/modules/packaging/os/redhat_subscription.py +++ b/lib/ansible/modules/packaging/os/redhat_subscription.py @@ -33,83 +33,63 @@ options: state: description: - whether to register and subscribe (C(present)), or unregister (C(absent)) a system - required: false choices: [ "present", "absent" ] default: "present" username: description: - access.redhat.com or Sat6 username - required: False - default: null password: description: - access.redhat.com or Sat6 password - required: False - default: null server_hostname: description: - Specify an alternative Red Hat Subscription Management or Sat6 server - required: False server_insecure: description: - Enable or disable https server certificate verification when connecting to C(server_hostname) - required: False rhsm_baseurl: description: - Specify CDN baseurl - required: False server_proxy_hostname: description: - Specify a HTTP proxy hostname - required: False version_added: "2.4" server_proxy_port: description: - Specify a HTTP proxy port - required: False version_added: "2.4" server_proxy_user: description: - Specify a user for HTTP proxy with basic authentication - required: False version_added: "2.4" server_proxy_password: description: - Specify a password for HTTP proxy with basic authentication - required: False version_added: "2.4" auto_attach: description: - Upon successful registration, auto-consume available subscriptions - Added in favor of depracated autosubscribe in 2.5. - required: False - default: False type: bool + default: 'no' version_added: "2.5" aliases: [autosubscribe] activationkey: description: - supply an activation key for use with registration - required: False - default: null org_id: description: - Organization ID to use in conjunction with activationkey - required: False - default: null version_added: "2.0" environment: description: - Register with a specific environment in the destination org. Used with Red Hat Satellite 6.x or Katello - required: False - default: null version_added: "2.2" pool: description: - | Specify a subscription pool name to consume. Regular expressions accepted. Use I(pool_ids) instead if possible, as it is much faster. Mutually exclusive with I(pool_ids). - required: False default: '^$' pool_ids: description: @@ -124,14 +104,10 @@ options: consumer_type: description: - The type of unit to register, defaults to system - required: False - default: null version_added: "2.1" consumer_name: description: - Name of the system to register, defaults to the hostname - required: False - default: null version_added: "2.1" consumer_id: description: @@ -140,14 +116,12 @@ options: for this system. If the system's identity certificate is lost or corrupted, this option allows it to resume using its previous identity and subscriptions. The default is to not specify a consumer ID so a new ID is created. - required: False - default: null version_added: "2.1" force_register: description: - Register the system even if it is already registered - required: False - default: False + type: bool + default: 'no' version_added: "2.2" ''' diff --git a/lib/ansible/modules/packaging/os/rhn_register.py b/lib/ansible/modules/packaging/os/rhn_register.py index 5f185a5a41..44267c39b9 100644 --- a/lib/ansible/modules/packaging/os/rhn_register.py +++ b/lib/ansible/modules/packaging/os/rhn_register.py @@ -30,62 +30,47 @@ options: state: description: - whether to register (C(present)), or unregister (C(absent)) a system - required: false choices: [ "present", "absent" ] default: "present" username: description: - Red Hat Network username - required: False - default: null password: description: - Red Hat Network password - required: False - default: null server_url: description: - Specify an alternative Red Hat Network server URL - required: False default: Current value of I(serverURL) from C(/etc/sysconfig/rhn/up2date) is the default activationkey: description: - supply an activation key for use with registration - required: False - default: null profilename: description: - supply an profilename for use with registration - required: False - default: null version_added: "2.0" sslcacert: description: - supply a custom ssl CA certificate file for use with registration - required: False - default: None version_added: "2.1" systemorgid: description: - supply an organizational id for use with registration - required: False - default: None version_added: "2.1" channels: description: - Optionally specify a list of comma-separated channels to subscribe to upon successful registration. - required: false default: [] enable_eus: description: - - If true, extended update support will be requested. - required: false - default: false + - If C(no), extended update support will be requested. + type: bool + default: 'no' nopackages: description: - - If true, the registered node will not upload its installed packages information to Satellite server - required: false - default: false + - If C(yes), the registered node will not upload its installed packages information to Satellite server + type: bool + default: 'no' version_added: "2.5" ''' diff --git a/lib/ansible/modules/packaging/os/sorcery.py b/lib/ansible/modules/packaging/os/sorcery.py index 26f37348b7..c9de8aaf55 100644 --- a/lib/ansible/modules/packaging/os/sorcery.py +++ b/lib/ansible/modules/packaging/os/sorcery.py @@ -36,9 +36,7 @@ options: - multiple names can be given, separated by commas - special value '*' in conjunction with states C(latest) or C(rebuild) will update or rebuild the whole system respectively - required: false aliases: ["spell"] - default: null state: description: @@ -47,7 +45,6 @@ options: - state C(latest) always triggers C(update_cache=yes) - state C(rebuild) implies cast of all specified spells, not only those existed before - required: false choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"] default: "present" @@ -60,31 +57,25 @@ options: contains more than one spell - providers must be supplied in the form recognized by Sorcery, e.g. 'openssl(SSL)' - required: false - default: null update: description: - Whether or not to update sorcery scripts at the very first stage - required: false - choices: ["yes", "no"] - default: "no" + type: bool + default: 'no' update_cache: description: - Whether or not to update grimoire collection before casting spells - required: false + type: bool + default: 'no' aliases: ["update_codex"] - choices: ["yes", "no"] - default: "no" cache_valid_time: description: - Time in seconds to invalidate grimoire collection on update - especially useful for SCM and rsync grimoires - makes sense only in pair with C(update_cache) - required: false - default: null ''' diff --git a/lib/ansible/modules/packaging/os/swdepot.py b/lib/ansible/modules/packaging/os/swdepot.py index 9783790d03..a200a3df51 100644 --- a/lib/ansible/modules/packaging/os/swdepot.py +++ b/lib/ansible/modules/packaging/os/swdepot.py @@ -30,25 +30,16 @@ options: description: - package name. required: true - default: null - choices: [] - aliases: [] version_added: 1.4 state: description: - whether to install (C(present), C(latest)), or remove (C(absent)) a package. required: true - default: null choices: [ 'present', 'latest', 'absent'] - aliases: [] version_added: 1.4 depot: description: - The source repository from which install or upgrade a package. - required: false - default: null - choices: [] - aliases: [] version_added: 1.4 ''' diff --git a/lib/ansible/modules/packaging/os/swupd.py b/lib/ansible/modules/packaging/os/swupd.py index 2ccec1b5f0..e5fdafa6d9 100644 --- a/lib/ansible/modules/packaging/os/swupd.py +++ b/lib/ansible/modules/packaging/os/swupd.py @@ -27,55 +27,38 @@ options: description: - URL pointing to the contents of available bundles. If not specified, the contents are retrieved from clearlinux.org. - required: false - default: null format: description: - The format suffix for version file downloads. For example [1,2,3,staging,etc]. If not specified, the default format is used. - required: false - default: null manifest: description: - The manifest contains information about the bundles at certaion version of the OS. Specify a Manifest version to verify against that version or leave unspecified to verify against the current version. - required: false - default: null aliases: [release, version] name: description: - Name of the (I)bundle to install or remove. - required: false - default: null aliases: [bundle] state: description: - Indicates the desired (I)bundle state. C(present) ensures the bundle is installed while C(absent) ensures the (I)bundle is not installed. - required: false default: present choices: [present, absent] update: description: - Updates the OS to the latest version. - required: false - default: no url: description: - Overrides both I(contenturl) and I(versionurl). - required: false - default: null verify: description: - Verify content for OS version. - required: false - default: null versionurl: description: - URL for version string download. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/packaging/os/xbps.py b/lib/ansible/modules/packaging/os/xbps.py index b96579dbcd..272ad9cc4b 100644 --- a/lib/ansible/modules/packaging/os/xbps.py +++ b/lib/ansible/modules/packaging/os/xbps.py @@ -28,12 +28,9 @@ options: name: description: - Name of the package to install, upgrade, or remove. - required: false - default: null state: description: - Desired state of the package. - required: false default: "present" choices: ["present", "absent", "latest"] recurse: @@ -41,22 +38,19 @@ options: - When removing a package, also remove its dependencies, provided that they are not required by other packages and were not explicitly installed by a user. - required: false - default: no - choices: ["yes", "no"] + type: bool + default: 'no' update_cache: description: - Whether or not to refresh the master package lists. This can be run as part of a package installation or as a separate step. - required: false - default: yes - choices: ["yes", "no"] + type: bool + default: 'yes' upgrade: description: - Whether or not to upgrade whole system - required: false - default: no - choices: ["yes", "no"] + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/packaging/os/yum_repository.py b/lib/ansible/modules/packaging/os/yum_repository.py index 1b1bef96ed..6497771ca7 100644 --- a/lib/ansible/modules/packaging/os/yum_repository.py +++ b/lib/ansible/modules/packaging/os/yum_repository.py @@ -26,15 +26,12 @@ description: options: async: - required: false - choices: ['yes', 'no'] - default: 'yes' description: - If set to C(yes) Yum will download packages and metadata from this repo in parallel, if possible. + type: bool + default: 'yes' bandwidth: - required: false - default: 0 description: - Maximum available network bandwidth in bytes/second. Used with the I(throttle) option. @@ -42,9 +39,8 @@ options: throttling will be disabled. If I(throttle) is expressed as a data rate (bytes/sec) then this option is ignored. Default is C(0) (no bandwidth throttling). + default: 0 baseurl: - required: false - default: null description: - URL to the directory where the yum repository's 'repodata' directory lives. @@ -52,56 +48,46 @@ options: - This, the I(metalink) or I(mirrorlist) parameters are required if I(state) is set to C(present). cost: - required: false - default: 1000 description: - Relative cost of accessing this repository. Useful for weighing one repo's packages as greater/less than any other. + default: 1000 deltarpm_metadata_percentage: - required: false - default: 100 description: - When the relative size of deltarpm metadata vs pkgs is larger than this, deltarpm metadata is not downloaded from the repo. Note that you can give values over C(100), so C(200) means that the metadata is required to be half the size of the packages. Use C(0) to turn off this check, and always download metadata. + default: 100 deltarpm_percentage: - required: false - default: 75 description: - When the relative size of delta vs pkg is larger than this, delta is not used. Use C(0) to turn off delta rpm processing. Local repositories (with file:// I(baseurl)) have delta rpms turned off by default. + default: 75 description: - required: false - default: null description: - A human readable string describing the repository. - This parameter is only required if I(state) is set to C(present). enabled: - required: false - choices: ['yes', 'no'] - default: 'yes' description: - This tells yum whether or not use this repository. - enablegroups: - required: false - choices: ['yes', 'no'] + type: bool default: 'yes' + enablegroups: description: - Determines whether yum will allow the use of package groups for this repository. + type: bool + default: 'yes' exclude: - required: false - default: null description: - List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (eg. C(*) and C(?)) are allowed. - The list can also be a regular YAML array. failovermethod: - required: false choices: [roundrobin, priority] default: roundrobin description: @@ -111,33 +97,22 @@ options: - C(priority) starts from the first I(baseurl) listed and reads through them sequentially. file: - required: false - default: null description: - File name without the C(.repo) extension to save the repo in. Defaults to the value of I(name). gpgcakey: - required: false - default: null description: - A URL pointing to the ASCII-armored CA key file for the repository. gpgcheck: - required: false - choices: ['yes', 'no'] - default: null description: - Tells yum whether or not it should perform a GPG signature check on packages. + type: bool gpgkey: - required: false - default: null description: - A URL pointing to the ASCII-armored GPG key file for the repository. - It can also be a list of multiple URLs. http_caching: - required: false - choices: [all, packages, none] - default: all description: - Determines how upstream HTTP caches are instructed to handle any HTTP downloads that Yum does. @@ -145,17 +120,15 @@ options: - C(packages) means that only RPM package downloads should be cached (but not repository metadata downloads). - C(none) means that no HTTP downloads should be cached. + choices: [all, packages, none] + default: all include: - required: false - default: null description: - Include external configuration file. Both, local path and URL is supported. Configuration file will be inserted at the position of the I(include=) line. Included files may contain further include lines. Yum will abort with an error if an inclusion loop is detected. includepkgs: - required: false - default: null description: - List of packages you want to only use from a repository. This should be a space separated list. Shell globs using wildcards (eg. C(*) and C(?)) @@ -163,38 +136,31 @@ options: here. - The list can also be a regular YAML array. ip_resolve: - required: false - choices: [4, 6, IPv4, IPv6, whatever] - default: whatever description: - Determines how yum resolves host names. - C(4) or C(IPv4) - resolve to IPv4 addresses only. - C(6) or C(IPv6) - resolve to IPv6 addresses only. + choices: [4, 6, IPv4, IPv6, whatever] + default: whatever keepalive: - required: false - choices: ['yes', 'no'] - default: 'no' description: - This tells yum whether or not HTTP/1.1 keepalive should be used with this repository. This can improve transfer speeds by using one connection when downloading multiple files from a repository. + type: bool + default: 'no' keepcache: - required: false - choices: ['0', '1'] - default: '1' description: - Either C(1) or C(0). Determines whether or not yum keeps the cache of headers and packages after successful installation. + choices: ['0', '1'] + default: '1' metadata_expire: - required: false - default: 21600 description: - Time (in seconds) after which the metadata will expire. - Default value is 6 hours. + default: 21600 metadata_expire_filter: - required: false - choices: [never, 'read-only:past', 'read-only:present', 'read-only:future'] - default: 'read-only:present' description: - Filter the I(metadata_expire) time, allowing a trade of speed for accuracy if a command doesn't require it. Each yum command can specify @@ -212,9 +178,9 @@ options: other commands which will require the latest metadata. Eg. I(yum check-update). - Note that this option does not override "yum clean expire-cache". + choices: [never, 'read-only:past', 'read-only:present', 'read-only:future'] + default: 'read-only:present' metalink: - required: false - default: null description: - Specifies a URL to a metalink file for the repomd.xml, a list of mirrors for the entire repository are generated by converting the @@ -222,96 +188,75 @@ options: - This, the I(baseurl) or I(mirrorlist) parameters are required if I(state) is set to C(present). mirrorlist: - required: false - default: null description: - Specifies a URL to a file containing a list of baseurls. - This, the I(baseurl) or I(metalink) parameters are required if I(state) is set to C(present). mirrorlist_expire: - required: false - default: 21600 description: - Time (in seconds) after which the mirrorlist locally cached will expire. - Default value is 6 hours. + default: 21600 name: - required: true description: - Unique repository ID. - This parameter is only required if I(state) is set to C(present) or C(absent). + required: true password: - required: false - default: null description: - Password to use with the username for basic authentication. priority: - required: false - default: 99 description: - Enforce ordered protection of repositories. The value is an integer from 1 to 99. - This option only works if the YUM Priorities plugin is installed. + default: 99 protect: - required: false - choices: ['yes', 'no'] - default: 'no' description: - Protect packages from updates from other repositories. + type: bool + default: 'no' proxy: - required: false - default: null description: - URL to the proxy server that yum should use. Set to C(_none_) to disable the global proxy setting. proxy_password: - required: false - default: null description: - Username to use for proxy. proxy_username: - required: false - default: null description: - Password for this proxy. repo_gpgcheck: - required: false - choices: ['yes', 'no'] - default: 'no' description: - This tells yum whether or not it should perform a GPG signature check on the repodata from this repository. + type: bool + default: 'no' reposdir: - required: false - default: /etc/yum.repos.d description: - Directory where the C(.repo) files will be stored. + default: /etc/yum.repos.d retries: - required: false - default: 10 description: - Set the number of times any attempt to retrieve a file should retry before returning an error. Setting this to C(0) makes yum try forever. + default: 10 s3_enabled: - required: false - choices: ['yes', 'no'] - default: 'no' description: - Enables support for S3 repositories. - This option only works if the YUM S3 plugin is installed. - skip_if_unavailable: - required: false - choices: ['yes', 'no'] + type: bool default: 'no' + skip_if_unavailable: description: - If set to C(yes) yum will continue running if this repository cannot be contacted for any reason. This should be set carefully as all repos are consulted for any given command. - ssl_check_cert_permissions: - required: false - choices: ['yes', 'no'] + type: bool default: 'no' + ssl_check_cert_permissions: description: - Whether yum should check the permissions on the paths for the certificates on the repository (both remote and local). @@ -319,58 +264,46 @@ options: I(skip_if_unavailable) to be C(yes). This is most useful for non-root processes which use yum on repos that have client cert files which are readable only by root. + type: bool + default: 'no' sslcacert: - required: false - default: null description: - Path to the directory containing the databases of the certificate authorities yum should use to verify SSL certificates. sslclientcert: - required: false - default: null description: - Path to the SSL client certificate yum should use to connect to repos/remote sites. sslclientkey: - required: false - default: null description: - Path to the SSL client key yum should use to connect to repos/remote sites. sslverify: - required: false - choices: ['yes', 'no'] - default: 'yes' description: - Defines whether yum should verify SSL certificates/hosts at all. + type: bool + default: 'yes' state: - required: false - choices: [absent, present] - default: present description: - State of the repo file. + choices: [absent, present] + default: present throttle: - required: false - default: null description: - Enable bandwidth throttling for downloads. - This option can be expressed as a absolute data rate in bytes/sec. An SI prefix (k, M or G) may be appended to the bandwidth value. timeout: - required: false - default: 30 description: - Number of seconds to wait for a connection before timing out. + default: 30 ui_repoid_vars: - required: false - default: releasever basearch description: - When a repository id is displayed, append these yum variables to the string if they are used in the I(baseurl)/etc. Variables are appended in the order listed (and found). + default: releasever basearch username: - required: false - default: null description: - Username to use for basic authentication to a repo or really any url. diff --git a/lib/ansible/modules/packaging/os/zypper_repository.py b/lib/ansible/modules/packaging/os/zypper_repository.py index 9826ace8f0..da33c206db 100644 --- a/lib/ansible/modules/packaging/os/zypper_repository.py +++ b/lib/ansible/modules/packaging/os/zypper_repository.py @@ -25,24 +25,17 @@ description: - Add or remove Zypper repositories on SUSE and openSUSE options: name: - required: false - default: none description: - A name for the repository. Not required when adding repofiles. repo: - required: false - default: none description: - URI of the repository or .repo file. Required when state=present. state: - required: false - choices: [ "absent", "present" ] - default: "present" description: - A source string state. + choices: [ "absent", "present" ] + default: "present" description: - required: false - default: none description: - A description of the repository disable_gpg_check: @@ -51,30 +44,26 @@ options: all packages. Has an effect only if state is I(present). - Needs zypper version >= 1.6.2. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' autorefresh: description: - Enable autorefresh of the repository. - required: false - default: "yes" - choices: [ "yes", "no" ] + type: bool + default: 'yes' aliases: [ "refresh" ] priority: description: - Set priority of repository. Packages will always be installed from the repository with the smallest priority number. - Needs zypper version >= 1.12.25. - required: false version_added: "2.1" overwrite_multiple: description: - Overwrite multiple repository entries, if repositories with both name and URL already exist. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' version_added: "2.1" auto_import_keys: description: @@ -82,24 +71,21 @@ options: - Has an effect only if state is I(present). Has no effect on existing (unchanged) repositories or in combination with I(absent). - Implies runrefresh. - Only works with C(.repo) files if `name` is given explicitly. - required: false - default: "no" - choices: ["yes", "no"] + type: bool + default: 'no' version_added: "2.2" runrefresh: description: - Refresh the package list of the given repository. - Can be used with repo=* to refresh all repositories. - required: false - default: "no" - choices: ["yes", "no"] + type: bool + default: 'no' version_added: "2.2" enabled: description: - Set repository to enabled (or disabled). - required: false - default: "yes" - choices: ["yes", "no"] + type: bool + default: 'yes' version_added: "2.2" diff --git a/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py b/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py index 14a70cdd22..9b3a6c0dd8 100644 --- a/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py +++ b/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py @@ -28,7 +28,6 @@ options: port: description: - Remote RMCP port. - required: false default: 623 user: description: @@ -38,7 +37,6 @@ options: description: - Password to connect to the BMC. required: true - default: null bootdev: description: - Set boot device to use on next reboot @@ -62,17 +60,15 @@ options: description: - If set, ask that system firmware uses this device beyond next boot. Be aware many systems do not honor this. - required: false type: bool - default: false + default: 'no' uefiboot: description: - If set, request UEFI boot explicitly. Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option. In practice, this flag not being set does not preclude UEFI boot on any system I've encountered. - required: false type: bool - default: false + default: 'no' requirements: - "python >= 2.6" - pyghmi diff --git a/lib/ansible/modules/remote_management/ipmi/ipmi_power.py b/lib/ansible/modules/remote_management/ipmi/ipmi_power.py index 43510c5d64..1d65cd62d9 100644 --- a/lib/ansible/modules/remote_management/ipmi/ipmi_power.py +++ b/lib/ansible/modules/remote_management/ipmi/ipmi_power.py @@ -28,7 +28,6 @@ options: port: description: - Remote RMCP port. - required: false default: 623 user: description: @@ -38,7 +37,6 @@ options: description: - Password to connect to the BMC. required: true - default: null state: description: - Whether to ensure that the machine in desired state. @@ -52,7 +50,6 @@ options: timeout: description: - Maximum number of seconds before interrupt request. - required: false default: 300 requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/remote_management/manageiq/manageiq_policies.py b/lib/ansible/modules/remote_management/manageiq/manageiq_policies.py index 84442f2a5a..60dd59a99d 100644 --- a/lib/ansible/modules/remote_management/manageiq/manageiq_policies.py +++ b/lib/ansible/modules/remote_management/manageiq/manageiq_policies.py @@ -32,15 +32,12 @@ options: - absent - policy_profiles should not exist, - present - policy_profiles should exist, - list - list current policy_profiles and policies. - required: False choices: ['absent', 'present', 'list'] default: 'present' policy_profiles: description: - list of dictionaries, each includes the policy_profile 'name' key. - required if state is present or absent. - required: false - default: null resource_type: description: - the type of the resource to which the profile should be [un]assigned @@ -48,12 +45,10 @@ options: choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', 'service template', 'template', 'tenant', 'user'] - default: null resource_name: description: - the name of the resource to which the profile should be [un]assigned required: true - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/remote_management/manageiq/manageiq_provider.py b/lib/ansible/modules/remote_management/manageiq/manageiq_provider.py index 5905c58326..c021b60d87 100644 --- a/lib/ansible/modules/remote_management/manageiq/manageiq_provider.py +++ b/lib/ansible/modules/remote_management/manageiq/manageiq_provider.py @@ -28,7 +28,6 @@ options: state: description: - absent - provider should not exist, present - provider should be present. - required: False choices: ['absent', 'present'] default: 'present' name: @@ -40,169 +39,111 @@ options: choices: ['Openshift', 'Amazon', 'oVirt', 'VMware', 'Azure', 'Director', 'OpenStack', 'GCE'] zone: description: The ManageIQ zone name that will manage the provider. - required: false default: 'default' provider_region: description: The provider region name to connect to (e.g. AWS region for Amazon). - required: false - default: null host_default_vnc_port_start: - required: false - default: null description: The first port in the host VNC range. defaults to None. version_added: "2.5" host_default_vnc_port_end: - required: false - default: null description: The last port in the host VNC range. defaults to None. version_added: "2.5" subscription: - required: false - default: null description: Microsoft Azure subscription ID. defaults to None. version_added: "2.5" project: - required: false - default: null description: Google Compute Engine Project ID. defaults to None. version_added: "2.5" azure_tenant_id: - required: false - default: null description: Tenant ID. defaults to None. version_added: "2.5" aliases: [ keystone_v3_domain_id ] tenant_mapping_enabled: - required: false - default: false + type: bool + default: 'no' description: Whether to enable mapping of existing tenants. defaults to False. version_added: "2.5" api_version: - required: false - default: null description: The OpenStack Keystone API version. defaults to None. choices: ['v2', 'v3'] version_added: "2.5" provider: - required: false description: Default endpoint connection information, required if state is true. - default: null suboptions: hostname: description: The provider's api hostname. required: true port: description: The provider's api port. - required: false userid: - required: false - default: null description: Provider's api endpoint authentication userid. defaults to None. password: - required: false - default: null description: Provider's api endpoint authentication password. defaults to None. auth_key: - required: false - default: null description: Provider's api endpoint authentication bearer token. defaults to None. verify_ssl: - required: false - default: true description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. + type: bool + default: 'yes' security_protocol: - required: false - default: None - choices: ['ssl-with-validation','ssl-with-validation-custom-ca','ssl-without-validation','non-ssl'] description: How SSL certificates should be used for HTTPS requests. defaults to None. + choices: ['ssl-with-validation','ssl-with-validation-custom-ca','ssl-without-validation','non-ssl'] certificate_authority: - required: false - default: null description: The CA bundle string with custom certificates. defaults to None. metrics: - required: false description: Metrics endpoint connection information. - default: null suboptions: hostname: description: The provider's api hostname. required: true port: description: The provider's api port. - required: false userid: - required: false - default: null description: Provider's api endpoint authentication userid. defaults to None. password: - required: false - default: null description: Provider's api endpoint authentication password. defaults to None. auth_key: - required: false - default: null description: Provider's api endpoint authentication bearer token. defaults to None. verify_ssl: - required: false - default: true description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. + type: bool + default: 'yes' security_protocol: - required: false - default: None choices: ['ssl-with-validation','ssl-with-validation-custom-ca','ssl-without-validation','non-ssl'] description: How SSL certificates should be used for HTTPS requests. defaults to None. certificate_authority: - required: false - default: null description: The CA bundle string with custom certificates. defaults to None. path: - required: false - default: ovirt_engine_history description: Database name for oVirt metrics. Defaults to ovirt_engine_history. + default: ovirt_engine_history alerts: - required: false description: Alerts endpoint connection information. - default: null suboptions: hostname: description: The provider's api hostname. required: true port: description: The provider's api port. - required: false userid: - required: false - default: null description: Provider's api endpoint authentication userid. defaults to None. password: - required: false - default: null description: Provider's api endpoint authentication password. defaults to None. auth_key: - required: false - default: null description: Provider's api endpoint authentication bearer token. defaults to None. verify_ssl: - required: false - default: true description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True. + default: true security_protocol: - required: false - default: None choices: ['ssl-with-validation','ssl-with-validation-custom-ca','ssl-without-validation'] description: How SSL certificates should be used for HTTPS requests. defaults to None. certificate_authority: - required: false - default: null description: The CA bundle string with custom certificates. defaults to None. ssh_keypair: - required: false description: SSH key pair used for SSH connections to all hosts in this provider. - default: null version_added: "2.5" suboptions: hostname: @@ -210,10 +151,8 @@ options: required: true userid: description: SSH username. - required: false auth_key: description: SSH private key. - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/remote_management/manageiq/manageiq_tags.py b/lib/ansible/modules/remote_management/manageiq/manageiq_tags.py index 184b8b0a48..40ca2f5c95 100644 --- a/lib/ansible/modules/remote_management/manageiq/manageiq_tags.py +++ b/lib/ansible/modules/remote_management/manageiq/manageiq_tags.py @@ -32,15 +32,12 @@ options: - absent - tags should not exist, - present - tags should exist, - list - list current tags. - required: False choices: ['absent', 'present', 'list'] default: 'present' tags: description: - tags - list of dictionaries, each includes 'name' and 'category' keys. - required if state is present or absent. - required: false - default: null resource_type: description: - the relevant resource type in manageiq @@ -48,12 +45,10 @@ options: choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', 'service template', 'template', 'tenant', 'user'] - default: null resource_name: description: - the relevant resource name in manageiq required: true - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/remote_management/manageiq/manageiq_user.py b/lib/ansible/modules/remote_management/manageiq/manageiq_user.py index 29d1c497ee..b94906cd87 100755 --- a/lib/ansible/modules/remote_management/manageiq/manageiq_user.py +++ b/lib/ansible/modules/remote_management/manageiq/manageiq_user.py @@ -41,7 +41,6 @@ options: state: description: - absent - user should not exist, present - user should be. - required: False choices: ['absent', 'present'] default: 'present' userid: @@ -51,25 +50,16 @@ options: name: description: - The users' full name. - required: false - default: null password: description: - The users' password. - required: false - default: null group: description: - The name of the group to which the user belongs. - required: false - default: null email: description: - The users' E-mail address. - required: false - default: null update_password: - required: false default: always choices: ['always', 'on_create'] description: diff --git a/lib/ansible/modules/remote_management/ucs/ucs_vlans.py b/lib/ansible/modules/remote_management/ucs/ucs_vlans.py index 465ebb85d9..5fed57c345 100644 --- a/lib/ansible/modules/remote_management/ucs/ucs_vlans.py +++ b/lib/ansible/modules/remote_management/ucs/ucs_vlans.py @@ -69,7 +69,7 @@ options: native: description: - Designates the VLAN as a native VLAN. - choices: ['no', 'yes'] + choices: ['yes', 'no'] default: 'no' requirements: - ucsmsdk diff --git a/lib/ansible/modules/source_control/git.py b/lib/ansible/modules/source_control/git.py index 039744227a..d703451410 100644 --- a/lib/ansible/modules/source_control/git.py +++ b/lib/ansible/modules/source_control/git.py @@ -25,60 +25,48 @@ description: - Manage I(git) checkouts of repositories to deploy files or software. options: repo: - required: true - aliases: [ name ] description: - git, SSH, or HTTP(S) protocol address of the git repository. - dest: required: true + aliases: [ name ] + dest: description: - The path of where the repository should be checked out. This parameter is required, unless C(clone) is set to C(no). + required: true version: - required: false - default: "HEAD" description: - What version of the repository to check out. This can be the the literal string C(HEAD), a branch name, a tag name. It can also be a I(SHA-1) hash, in which case C(refspec) needs to be specified if the given revision is not already available. + default: "HEAD" accept_hostkey: - required: false - default: "no" - choices: [ "yes", "no" ] - version_added: "1.5" description: - if C(yes), ensure that "-o StrictHostKeyChecking=no" is present as an ssh options. - ssh_opts: - required: false - default: None + type: bool + default: 'no' version_added: "1.5" + ssh_opts: description: - Creates a wrapper script and exports the path as GIT_SSH which git then automatically uses to override ssh arguments. An example value could be "-o StrictHostKeyChecking=no" - key_file: - required: false - default: None version_added: "1.5" + key_file: description: - Specify an optional private key file to use for the checkout. + version_added: "1.5" reference: - required: false - default: null - version_added: "1.4" description: - Reference repository (see "git clone --reference ...") + version_added: "1.4" remote: - required: false - default: "origin" description: - Name of the remote. + default: "origin" refspec: - required: false - default: null - version_added: "1.9" description: - Add an additional refspec to be fetched. If version is set to a I(SHA-1) not reachable from any branch @@ -86,103 +74,90 @@ options: the I(SHA-1). Uses the same syntax as the 'git fetch' command. An example value could be "refs/meta/config". + version_added: "1.9" force: - required: false - default: "no" - choices: [ "yes", "no" ] - version_added: "0.7" description: - If C(yes), any modified files in the working repository will be discarded. Prior to 0.7, this was always 'yes' and could not be disabled. Prior to 1.9, the default was `yes` + type: bool + default: 'no' + version_added: "0.7" depth: - required: false - default: null - version_added: "1.2" description: - Create a shallow clone with a history truncated to the specified number or revisions. The minimum possible value is C(1), otherwise ignored. Needs I(git>=1.9.1) to work correctly. + version_added: "1.2" clone: - required: false - default: "yes" - choices: [ "yes", "no" ] - version_added: "1.9" description: - If C(no), do not clone the repository if it does not exist locally + type: bool + default: 'yes' + version_added: "1.9" update: - required: false - default: "yes" - choices: [ "yes", "no" ] - version_added: "1.2" description: - If C(no), do not retrieve new revisions from the origin repository - Operations like archive will work on the existing (old) repository and might not respond to changes to the options version or remote. + type: bool + default: 'yes' + version_added: "1.2" executable: - required: false - default: null - version_added: "1.4" description: - Path to git executable to use. If not supplied, the normal mechanism for resolving binary paths will be used. - bare: - required: false - default: "no" - choices: [ "yes", "no" ] version_added: "1.4" + bare: description: - if C(yes), repository will be created as a bare repo, otherwise it will be a standard repo with a workspace. + type: bool + default: 'no' + version_added: "1.4" umask: - required: false - default: null - version_added: "2.2" description: - The umask to set before doing any checkouts, or any other repository maintenance. + version_added: "2.2" recursive: - required: false - default: "yes" - choices: [ "yes", "no" ] - version_added: "1.6" description: - if C(no), repository will be cloned without the --recursive option, skipping sub-modules. + type: bool + default: 'yes' + version_added: "1.6" track_submodules: - required: false - default: "no" - choices: ["yes", "no"] - version_added: "1.8" description: - if C(yes), submodules will track the latest commit on their master branch (or other branch specified in .gitmodules). If C(no), submodules will be kept at the revision specified by the main project. This is equivalent to specifying the --remote flag to git submodule update. + type: bool + default: 'no' + version_added: "1.8" verify_commit: - required: false - default: "no" - choices: ["yes", "no"] - version_added: "2.0" description: - if C(yes), when cloning or checking out a C(version) verify the signature of a GPG signed commit. This requires C(git) version>=2.1.0 to be installed. The commit MUST be signed and the public key MUST be present in the GPG keyring. + type: bool + default: 'no' + version_added: "2.0" archive: - required: false - version_added: "2.4" description: - Specify archive file path with extension. If specified, creates an archive file of the specified format containing the tree structure for the source tree. Allowed archive formats ["zip", "tar.gz", "tar", "tgz"] + version_added: "2.4" requirements: - git>=1.7.1 (the command line tool) diff --git a/lib/ansible/modules/source_control/git_config.py b/lib/ansible/modules/source_control/git_config.py index ed6295c68b..7df6b6ed68 100644 --- a/lib/ansible/modules/source_control/git_config.py +++ b/lib/ansible/modules/source_control/git_config.py @@ -34,36 +34,27 @@ options: list_all: description: - List all settings (optionally limited to a given I(scope)) - required: false - choices: [ "yes", "no" ] - default: no + type: bool + default: 'no' name: description: - The name of the setting. If no value is supplied, the value will be read from the config if it has been set. - required: false - default: null repo: description: - Path to a git repository for reading and writing values from a specific repo. - required: false - default: null scope: description: - Specify which scope to read/set values from. This is required when setting config values. If this is set to local, you must also specify the repo parameter. It defaults to system only when not using I(list_all)=yes. - required: false choices: [ "local", "global", "system" ] - default: null value: description: - When specifying the name of a single setting, supply a value to set that setting to the given value. - required: false - default: null ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/source_control/github_deploy_key.py b/lib/ansible/modules/source_control/github_deploy_key.py index cf650c7098..26a648ab16 100644 --- a/lib/ansible/modules/source_control/github_deploy_key.py +++ b/lib/ansible/modules/source_control/github_deploy_key.py @@ -25,63 +25,48 @@ options: description: - The name of the individual account or organization that owns the GitHub repository. required: true - default: null aliases: [ 'account', 'organization' ] repo: description: - The name of the GitHub repository. required: true - default: null aliases: [ 'repository' ] name: description: - The name for the deploy key. required: true - default: null aliases: [ 'title', 'label' ] key: description: - The SSH public key to add to the repository as a deploy key. required: true - default: null read_only: description: - If C(true), the deploy key will only be able to read repository contents. Otherwise, the deploy key will be able to read and write. - required: false type: bool - default: yes + default: 'yes' state: description: - The state of the deploy key. - required: false default: "present" choices: [ "present", "absent" ] force: description: - If C(true), forcefully adds the deploy key by deleting any existing deploy key with the same public key or title. - required: false - default: no type: bool + default: 'no' username: description: - The username to authenticate with. - required: false - default: null password: description: - The password to authenticate with. A personal access token can be used here in place of a password. - required: false - default: null token: description: - The OAuth2 token or personal access token to authenticate with. Mutually exclusive with I(password). - required: false - default: null otp: description: - The 6 digit One Time Password for 2-Factor Authentication. Required together with I(username) and I(password). - required: false - default: null aliases: ['2fa_token'] requirements: - python-requests diff --git a/lib/ansible/modules/source_control/github_issue.py b/lib/ansible/modules/source_control/github_issue.py index 5f64c27b02..9848ca86ee 100644 --- a/lib/ansible/modules/source_control/github_issue.py +++ b/lib/ansible/modules/source_control/github_issue.py @@ -22,22 +22,18 @@ options: description: - Name of repository from which issue needs to be retrieved. required: true - default: none organization: description: - Name of the GitHub organization in which the repository is hosted. required: true - default: none issue: description: - Issue number for which information is required. - default: none required: true action: description: - Get various details about issue depending upon action specified. default: 'get_status' - required: false choices: - ['get_status'] diff --git a/lib/ansible/modules/source_control/github_key.py b/lib/ansible/modules/source_control/github_key.py index 79758fd7db..5336d7f667 100644 --- a/lib/ansible/modules/source_control/github_key.py +++ b/lib/ansible/modules/source_control/github_key.py @@ -30,21 +30,17 @@ options: pubkey: description: - SSH public key value. Required when C(state=present). - required: false - default: none state: description: - Whether to remove a key, ensure that it exists, or update its value. choices: ['present', 'absent'] default: 'present' - required: false force: description: - The default is C(yes), which will replace the existing remote key if it's different than C(pubkey). If C(no), the key will only be set if no key with the given C(name) exists. - required: false - choices: ['yes', 'no'] + type: bool default: 'yes' author: Robert Estelle (@erydo) diff --git a/lib/ansible/modules/source_control/github_release.py b/lib/ansible/modules/source_control/github_release.py index f8d9f6631b..6487f97c1a 100644 --- a/lib/ansible/modules/source_control/github_release.py +++ b/lib/ansible/modules/source_control/github_release.py @@ -24,62 +24,51 @@ options: token: description: - GitHub Personal Access Token for authenticating - default: null user: - required: true description: - The GitHub account that owns the repository - default: null + required: true password: description: - The GitHub account password for the user - default: null version_added: "2.4" repo: - required: true description: - Repository name - default: null - action: required: true + action: description: - Action to perform + required: true choices: [ 'latest_release', 'create_release' ] tag: - required: false description: - Tag name when creating a release. Required when using action is set to C(create_release). version_added: 2.4 target: - required: false description: - Target of release when creating a release version_added: 2.4 name: - required: false description: - Name of release when creating a release version_added: 2.4 body: - required: false description: - Description of the release when creating a release version_added: 2.4 draft: - required: false description: - Sets if the release is a draft or not. (boolean) - default: false + type: 'bool' + default: 'no' version_added: 2.4 - choices: ['True', 'False'] prerelease: - required: false description: - Sets if the release is a prerelease or not. (boolean) - default: false + type: bool + default: 'no' version_added: 2.4 - choices: ['True', 'False'] - author: - "Adrian Moisey (@adrianmoisey)" diff --git a/lib/ansible/modules/source_control/gitlab_group.py b/lib/ansible/modules/source_control/gitlab_group.py index c59fdc7f18..f63961804b 100644 --- a/lib/ansible/modules/source_control/gitlab_group.py +++ b/lib/ansible/modules/source_control/gitlab_group.py @@ -30,25 +30,18 @@ options: validate_certs: description: - When using https if SSL certificate needs to be verified. - required: false default: true aliases: - verify_ssl login_user: description: - Gitlab user name. - required: false - default: null login_password: description: - Gitlab password for login_user - required: false - default: null login_token: description: - Gitlab token for logging in. - required: false - default: null name: description: - Name of the group you want to create. @@ -57,13 +50,10 @@ options: description: - The path of the group you want to create, this will be server_url/group_path - If not supplied, the group_name will be used. - required: false - default: null state: description: - create or delete group. - Possible values are present and absent. - required: false default: "present" choices: ["present", "absent"] ''' diff --git a/lib/ansible/modules/source_control/gitlab_project.py b/lib/ansible/modules/source_control/gitlab_project.py index c50e4400d5..0cb91ae466 100644 --- a/lib/ansible/modules/source_control/gitlab_project.py +++ b/lib/ansible/modules/source_control/gitlab_project.py @@ -31,32 +31,24 @@ options: validate_certs: description: - When using https if SSL certificate needs to be verified. - required: false - default: true + type: bool + default: 'yes' aliases: - verify_ssl login_user: description: - Gitlab user name. - required: false - default: null login_password: description: - Gitlab password for login_user - required: false - default: null login_token: description: - Gitlab token for logging in. - required: false - default: null group: description: - The name of the group of which this projects belongs to. - When not provided, project will belong to user which is configured in 'login_user' or 'login_token' - When provided with username, project will be created for this user. 'login_user' or 'login_token' needs admin rights. - required: false - default: null name: description: - The name of the project @@ -65,63 +57,57 @@ options: description: - The path of the project you want to create, this will be server_url//path - If not supplied, name will be used. - required: false - default: null description: description: - An description for the project. - required: false - default: null issues_enabled: description: - Whether you want to create issues or not. - Possible values are true and false. - required: false - default: true + type: bool + default: 'yes' merge_requests_enabled: description: - If merge requests can be made or not. - Possible values are true and false. - required: false - default: true + type: bool + default: 'yes' wiki_enabled: description: - If an wiki for this project should be available or not. - Possible values are true and false. - required: false - default: true + type: bool + default: 'yes' snippets_enabled: description: - If creating snippets should be available or not. - Possible values are true and false. - required: false - default: true + type: bool + default: 'yes' public: description: - If the project is public available or not. - Setting this to true is same as setting visibility_level to 20. - Possible values are true and false. - required: false - default: false + type: bool + default: 'no' visibility_level: description: - Private. visibility_level is 0. Project access must be granted explicitly for each user. - Internal. visibility_level is 10. The project can be cloned by any logged in user. - Public. visibility_level is 20. The project can be cloned without any authentication. - Possible values are 0, 10 and 20. - required: false default: 0 import_url: description: - Git repository which will be imported into gitlab. - Gitlab server needs read access to this git repository. - required: false - default: false + type: bool + default: 'no' state: description: - create or delete project. - Possible values are present and absent. - required: false default: "present" choices: ["present", "absent"] ''' diff --git a/lib/ansible/modules/source_control/gitlab_user.py b/lib/ansible/modules/source_control/gitlab_user.py index 52c18f94e2..e28a0547f9 100644 --- a/lib/ansible/modules/source_control/gitlab_user.py +++ b/lib/ansible/modules/source_control/gitlab_user.py @@ -32,25 +32,19 @@ options: validate_certs: description: - When using https if SSL certificate needs to be verified. - required: false - default: true + type: bool + default: 'yes' aliases: - verify_ssl login_user: description: - Gitlab user name. - required: false - default: null login_password: description: - Gitlab password for login_user - required: false - default: null login_token: description: - Gitlab token for logging in. - required: false - default: null name: description: - Name of the user you want to create @@ -71,18 +65,12 @@ options: sshkey_name: description: - The name of the sshkey - required: false - default: null sshkey_file: description: - The ssh key itself. - required: false - default: null group: description: - Add user as an member to this group. - required: false - default: null access_level: description: - The access level to the group. One of the following can be used. @@ -91,20 +79,17 @@ options: - developer - master - owner - required: false - default: null state: description: - create or delete group. - Possible values are present and absent. - required: false default: present choices: ["present", "absent"] confirm: description: - Require confirmation. - required: false - default: true + type: bool + default: 'yes' version_added: "2.4" ''' diff --git a/lib/ansible/modules/storage/netapp/na_cdot_license.py b/lib/ansible/modules/storage/netapp/na_cdot_license.py index 8676d71087..7f432bdeab 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_license.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_license.py @@ -30,19 +30,18 @@ options: remove_unused: description: - Remove licenses that have no controller affiliation in the cluster. - choices: ['true', 'false'] + type: bool remove_expired: description: - Remove licenses that have expired in the cluster. - choices: ['true', 'false'] + type: bool serial_number: description: - Serial number of the node associated with the license. - This parameter is used primarily when removing license for a specific service. - If this parameter is not provided, the cluster serial number is used by default. - default: None licenses: description: diff --git a/lib/ansible/modules/storage/netapp/na_cdot_user.py b/lib/ansible/modules/storage/netapp/na_cdot_user.py index 61a7ec03b1..d635e54866 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_user.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_user.py @@ -66,7 +66,6 @@ options: - Password for the user account. - It is ignored for creating snmp users, but is required for creating non-snmp users. - For an existing user, this value will be used as the new password. - default: None role_name: description: diff --git a/lib/ansible/modules/storage/netapp/na_cdot_volume.py b/lib/ansible/modules/storage/netapp/na_cdot_volume.py index a58c024efb..c6ce8cf025 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_volume.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_volume.py @@ -41,14 +41,14 @@ options: infinite: description: - Set True if the volume is an Infinite Volume. - choices: ['True', 'False'] - default: 'False' + type: bool + default: 'no' online: description: - Whether the specified volume is online, or not. - choices: ['True', 'False'] - default: 'True' + type: bool + default: 'yes' aggregate_name: description: @@ -68,7 +68,6 @@ options: description: - Name of the vserver to use. required: true - default: None ''' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg.py b/lib/ansible/modules/storage/netapp/netapp_e_amg.py index b6aea1ad73..2441eba5e5 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg.py @@ -34,22 +34,19 @@ options: syncIntervalMinutes: description: - The synchronization interval in minutes - required: no default: 10 manualSync: description: - Setting this to true will cause other synchronization values to be ignored - required: no - default: no + type: bool + default: 'no' recoveryWarnThresholdMinutes: description: - Recovery point warning threshold (minutes). The user will be warned when the age of the last good failures point exceeds this value - required: no default: 20 repoUtilizationWarnThreshold: description: - Recovery point warning threshold - required: no default: 80 interfaceType: description: @@ -57,17 +54,15 @@ options: choices: - iscsi - fibre - required: no - default: null syncWarnThresholdMinutes: description: - The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. - required: no default: 10 state: description: - A C(state) of present will either create or update the async mirror group. - A C(state) of absent will remove the async mirror group. + choices: [ absent, present ] required: yes """ diff --git a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py index d5f90a5a65..0cee0d21b7 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py @@ -20,52 +20,48 @@ description: - Manage the arrays accessible via a NetApp Web Services Proxy for NetApp E-series storage arrays. options: api_username: - required: true description: - The username to authenticate with the SANtricity WebServices Proxy or embedded REST API. - api_password: required: true + api_password: description: - The password to authenticate with the SANtricity WebServices Proxy or embedded REST API. - api_url: required: true + api_url: description: - The url to the SANtricity WebServices Proxy or embedded REST API. + required: true validate_certs: - required: false - default: true description: - Should https certificates be validated? + type: bool + default: 'yes' ssid: - required: true description: - The ID of the array to manage. This value must be unique for each array. - state: required: true + state: description: - Whether the specified array should be configured on the Web Services Proxy or not. + required: true choices: ['present', 'absent'] controller_addresses: - required: true description: - The list addresses for the out-of-band management adapter or the agent host. Mutually exclusive of array_wwn parameter. + required: true array_wwn: - required: false description: - The WWN of the array to manage. Only necessary if in-band managing multiple arrays on the same agent host. Mutually exclusive of controller_addresses parameter. array_password: - required: false description: - The management password of the array to manage, if set. enable_trace: - required: false - default: false description: - Enable trace logging for SYMbol calls to the storage system. + type: bool + default: 'no' meta_tags: - required: false - default: None description: - Optional meta tags to associate to this storage system author: Kevin Hulquest (@hulquest) diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_volume.py index d20c5803b1..8905e15c8c 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume.py @@ -22,27 +22,27 @@ extends_documentation_fragment: - netapp.eseries options: state: - required: true description: - Whether the specified volume should exist or not. + required: true choices: ['present', 'absent'] name: - required: true description: - The name of the volume to manage - storage_pool_name: required: true + storage_pool_name: description: - "Required only when requested state is 'present'. The name of the storage pool the volume should exist on." + required: true size_unit: description: - The unit used to interpret the size parameter choices: ['bytes', 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb'] default: 'gb' size: - required: true description: - "Required only when state = 'present'. The size of the volume in (size_unit)." + required: true segment_size_kb: description: - The segment size of the new volume @@ -50,8 +50,8 @@ options: thin_provision: description: - Whether the volume should be thin provisioned. Thin volumes can only be created on disk pools (raidDiskPool). - default: False - choices: ['yes','no','true','false'] + type: bool + default: 'no' thin_volume_repo_size: description: - Initial size of the thin volume repository volume (in size_unit) @@ -63,12 +63,13 @@ options: ssd_cache_enabled: description: - Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache defined) - default: None (ignores existing SSD cache setting) - choices: ['yes','no','true','false'] + - The default value is to ignore existing SSD cache setting. + type: bool data_assurance_enabled: description: - If data assurance should be enabled for the volume - default: false + type: bool + default: 'no' # TODO: doc thin volume parameters diff --git a/lib/ansible/modules/storage/netapp/sf_account_manager.py b/lib/ansible/modules/storage/netapp/sf_account_manager.py index 467fc79a6c..84e755e522 100644 --- a/lib/ansible/modules/storage/netapp/sf_account_manager.py +++ b/lib/ansible/modules/storage/netapp/sf_account_manager.py @@ -40,15 +40,12 @@ options: new_name: description: - New name for the user account. - required: false - default: None initiator_secret: description: - CHAP secret to use for the initiator. Should be 12-16 characters long and impenetrable. - The CHAP initiator secrets must be unique and cannot be the same as the target CHAP secret. - If not specified, a random secret is created. - required: false target_secret: description: @@ -56,22 +53,17 @@ options: - Should be 12-16 characters long and impenetrable. - The CHAP target secrets must be unique and cannot be the same as the initiator CHAP secret. - If not specified, a random secret is created. - required: false attributes: description: List of Name/Value pairs in JSON object format. - required: false account_id: description: - The ID of the account to manage or update. - required: false - default: None status: description: - Status of the account. - required: false ''' diff --git a/lib/ansible/modules/storage/netapp/sf_check_connections.py b/lib/ansible/modules/storage/netapp/sf_check_connections.py index 3124078593..419327c648 100644 --- a/lib/ansible/modules/storage/netapp/sf_check_connections.py +++ b/lib/ansible/modules/storage/netapp/sf_check_connections.py @@ -30,23 +30,17 @@ options: skip: description: - Skip checking connection to SVIP or MVIP. - required: false choices: ['svip', 'mvip'] - default: None mvip: description: - Optionally, use to test connection of a different MVIP. - This is not needed to test the connection to the target cluster. - required: false - default: None svip: description: - Optionally, use to test connection of a different SVIP. - This is not needed to test the connection to the target cluster. - required: false - default: None ''' diff --git a/lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py b/lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py index ef62ebc6dd..ca9646f724 100644 --- a/lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py +++ b/lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py @@ -40,37 +40,25 @@ options: initiators: description: - List of initiators to include in the volume access group. If unspecified, the access group will start out without configured initiators. - required: false - default: None volumes: description: - List of volumes to initially include in the volume access group. If unspecified, the access group will start without any volumes. - required: false - default: None virtual_network_id: description: - The ID of the SolidFire Virtual Network ID to associate the volume access group with. - required: false - default: None virtual_network_tags: description: - The ID of the VLAN Virtual Network Tag to associate the volume access group with. - required: false - default: None attributes: description: List of Name/Value pairs in JSON object format. - required: false - default: None volume_access_group_id: description: - The ID of the volume access group to modify or delete. - required: false - default: None ''' diff --git a/lib/ansible/modules/storage/netapp/sf_volume_manager.py b/lib/ansible/modules/storage/netapp/sf_volume_manager.py index aeb4dfe7e7..14f4567c12 100644 --- a/lib/ansible/modules/storage/netapp/sf_volume_manager.py +++ b/lib/ansible/modules/storage/netapp/sf_volume_manager.py @@ -46,17 +46,12 @@ options: description: - Should the volume provide 512-byte sector emulation? - Required when C(state=present) - required: false qos: description: Initial quality of service settings for this volume. Configure as dict in playbooks. - required: false - default: None attributes: description: A YAML dictionary of attributes that you would like to apply on this volume. - required: false - default: None volume_id: description: @@ -64,25 +59,19 @@ options: - In order to create multiple volumes with the same name, but different volume_ids, please declare the I(volume_id) parameter with an arbitrary value. However, the specified volume_id will not be assigned to the newly created volume (since it's an auto-generated property). - required: false - default: None size: description: - The size of the volume in (size_unit). - Required when C(state = present). - required: false size_unit: description: - The unit used to interpret the size parameter. - required: false choices: ['bytes', 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb'] default: 'gb' access: - required: false - choices: ['readOnly', 'readWrite', 'locked', 'replicationTarget'] description: - "Access allowed for the volume." - "readOnly: Only read operations are allowed." @@ -90,7 +79,7 @@ options: - "locked: No reads or writes are allowed." - "replicationTarget: Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked." - "If unspecified, the access settings of the clone will be the same as the source." - default: None + choices: ['readOnly', 'readWrite', 'locked', 'replicationTarget'] ''' diff --git a/lib/ansible/modules/storage/zfs/zfs_facts.py b/lib/ansible/modules/storage/zfs/zfs_facts.py index 13a4b55484..c1882bac4a 100644 --- a/lib/ansible/modules/storage/zfs/zfs_facts.py +++ b/lib/ansible/modules/storage/zfs/zfs_facts.py @@ -25,42 +25,35 @@ options: name: description: - ZFS dataset name. - aliases: [ "ds", "dataset" ] required: yes + aliases: [ "ds", "dataset" ] recurse: description: - Specifies if properties for any children should be recursively displayed. type: bool - default: False - required: false + default: 'no' parsable: description: - Specifies if property values should be displayed in machine friendly format. type: bool - default: False - required: false + default: 'no' properties: description: - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zfs(1M) man page. - aliases: [ "props" ] default: all - required: false + aliases: [ "props" ] type: description: - Specifies which datasets types to display. Multiple values have to be provided in comma-separated form. - aliases: [ "props" ] - default: all choices: [ 'all', 'filesystem', 'volume', 'snapshot', 'bookmark' ] - required: false + default: all depth: description: - Specifiies recurion depth. - default: None - required: false ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/system/authorized_key.py b/lib/ansible/modules/system/authorized_key.py index 12971d1110..bded2a5a19 100644 --- a/lib/ansible/modules/system/authorized_key.py +++ b/lib/ansible/modules/system/authorized_key.py @@ -32,7 +32,6 @@ options: path: description: - Alternate path to the authorized_keys file - required: false default: "(homedir)+/.ssh/authorized_keys" version_added: "1.2" manage_dir: @@ -43,21 +42,17 @@ options: set C(manage_dir=no) if you are using an alternate directory for authorized_keys, as set with C(path), since you could lock yourself out of SSH access. See the example below. - required: false - choices: [ "yes", "no" ] - default: "yes" + type: bool + default: 'yes' version_added: "1.2" state: description: - Whether the given key (with the given key_options) should or should not be in the file - required: false choices: [ "present", "absent" ] default: "present" key_options: description: - A string of ssh key options to be prepended to the key in the authorized_keys file - required: false - default: null version_added: "1.4" exclusive: description: @@ -66,26 +61,22 @@ options: - This option is not loop aware, so if you use C(with_) , it will be exclusive per iteration of the loop, if you want multiple keys in the file you need to pass them all to C(key) in a single batch as mentioned above. - required: false - choices: [ "yes", "no" ] - default: "no" + type: bool + default: 'no' version_added: "1.9" validate_certs: description: - This only applies if using a https url as the source of the keys. If set to C(no), the SSL certificates will not be validated. - This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site. - Prior to 2.1 the code worked as if this was set to C(yes). - required: false - default: "yes" - choices: ["yes", "no"] + type: bool + default: 'yes' version_added: "2.1" comment: description: - Change the comment on the public key. Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab. - If no comment is specified, the existing comment will be kept. - required: false - default: None version_added: "2.4" author: "Ansible Core Team" ''' diff --git a/lib/ansible/modules/system/awall.py b/lib/ansible/modules/system/awall.py index b943c64dd4..3108b75f94 100644 --- a/lib/ansible/modules/system/awall.py +++ b/lib/ansible/modules/system/awall.py @@ -26,7 +26,6 @@ options: name: description: - A policy name, like C(foo), or multiple policies, like C(foo, bar). - default: null state: description: - The policy(ies) will be C(enabled) @@ -36,7 +35,8 @@ options: activate: description: - Activate the new firewall rules. Can be run with other steps or on it's own. - default: False + type: bool + default: 'no' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/system/firewalld.py b/lib/ansible/modules/system/firewalld.py index cb5ef01f7c..da92fbe9b0 100644 --- a/lib/ansible/modules/system/firewalld.py +++ b/lib/ansible/modules/system/firewalld.py @@ -24,36 +24,25 @@ options: service: description: - "Name of a service to add/remove to/from firewalld - service must be listed in output of firewall-cmd --get-services." - required: false - default: null port: description: - "Name of a port or port range to add/remove to/from firewalld. Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges." - required: false - default: null rich_rule: description: - "Rich rule to add/remove to/from firewalld." - required: false - default: null source: description: - 'The source/network you would like to add/remove to/from firewalld' - required: false - default: null version_added: "2.0" interface: description: - 'The interface you would like to add/remove to/from a zone in firewalld' - required: false - default: null version_added: "2.1" zone: description: - > The firewalld zone to add/remove to/from (NOTE: default zone can be configured per system but "public" is default from upstream. Available choices can be extended based on per-system configs, listed here are "out of the box" defaults). - required: false default: system-default(public) choices: [ "work", "drop", "internal", "external", "trusted", "home", "dmz", "public", "block" ] permanent: @@ -61,13 +50,11 @@ options: - > Should this configuration be in the running firewalld configuration or persist across reboots. As of Ansible version 2.3, permanent operations can operate on firewalld configs when it's not running (requires firewalld >= 3.0.9). (NOTE: If this is false, immediate is assumed true.) - required: false - default: null immediate: description: - "Should this configuration be applied immediately, if set as permanent" - required: false - default: false + type: bool + default: 'no' version_added: "1.9" state: description: @@ -80,13 +67,10 @@ options: timeout: description: - "The amount of time the rule should be in effect for when non-permanent." - required: false default: 0 masquerade: description: - 'The masquerade setting you would like to enable/disable to/from zones within firewalld' - required: false - default: null version_added: "2.1" notes: - Not tested on any Debian based system. diff --git a/lib/ansible/modules/system/interfaces_file.py b/lib/ansible/modules/system/interfaces_file.py index 897d69dc8a..41cda40c6e 100755 --- a/lib/ansible/modules/system/interfaces_file.py +++ b/lib/ansible/modules/system/interfaces_file.py @@ -26,37 +26,28 @@ options: dest: description: - Path to the interfaces file - required: false default: /etc/network/interfaces iface: description: - Name of the interface, required for value changes or option remove - required: false - default: null option: description: - Name of the option, required for value changes or option remove - required: false - default: null value: description: - If I(option) is not presented for the I(interface) and I(state) is C(present) option will be added. If I(option) already exists and is not C(pre-up), C(up), C(post-up) or C(down), it's value will be updated. C(pre-up), C(up), C(post-up) and C(down) options can't be updated, only adding new options, removing existing ones or cleaning the whole option set are supported - required: false - default: null backup: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' state: description: - If set to C(absent) the option or section will be removed if present instead of created. - required: false default: "present" choices: [ "present", "absent" ] diff --git a/lib/ansible/modules/system/known_hosts.py b/lib/ansible/modules/system/known_hosts.py index 91d9994a47..5721ad3206 100644 --- a/lib/ansible/modules/system/known_hosts.py +++ b/lib/ansible/modules/system/known_hosts.py @@ -28,29 +28,24 @@ options: description: - The host to add or remove (must match a host specified in key). It will be converted to lowercase so that ssh-keygen can find it. required: true - default: null key: description: - The SSH public host key, as a string (required if state=present, optional when state=absent, in which case all keys for the host are removed). The key must be in the right format for ssh (see sshd(8), section "SSH_KNOWN_HOSTS FILE FORMAT") - required: false - default: null path: description: - The known_hosts file to edit - required: no default: "(homedir)+/.ssh/known_hosts" hash_host: description: - Hash the hostname in the known_hosts file - required: no - default: no + type: bool + default: 'no' version_added: "2.3" state: description: - I(present) to add the host key, I(absent) to remove it. choices: [ "present", "absent" ] - required: no default: present requirements: [ ] author: "Matthew Vernon (@mcv21)" diff --git a/lib/ansible/modules/system/make.py b/lib/ansible/modules/system/make.py index 452e82b2fd..c1e6dc2682 100644 --- a/lib/ansible/modules/system/make.py +++ b/lib/ansible/modules/system/make.py @@ -26,13 +26,9 @@ options: target: description: - The target to run - required: false - default: none params: description: - Any extra parameters to pass to make - required: false - default: none chdir: description: - cd into this directory before running make @@ -40,8 +36,6 @@ options: file: description: - Use file as a Makefile - required: false - default: none version_added: 2.5 ''' diff --git a/lib/ansible/modules/system/openwrt_init.py b/lib/ansible/modules/system/openwrt_init.py index 0f31ba1d5b..60652ae4d6 100644 --- a/lib/ansible/modules/system/openwrt_init.py +++ b/lib/ansible/modules/system/openwrt_init.py @@ -21,25 +21,20 @@ description: - Controls OpenWrt services on remote hosts. options: name: - required: true description: - Name of the service. + required: true aliases: ['service'] state: - required: false - default: null - choices: [ 'started', 'stopped', 'restarted', 'reloaded' ] description: - C(started)/C(stopped) are idempotent actions that will not run commands unless necessary. C(restarted) will always bounce the service. C(reloaded) will always reload. + choices: [ 'started', 'stopped', 'restarted', 'reloaded' ] enabled: - required: false - choices: [ "yes", "no" ] - default: null description: - Whether the service should start on boot. B(At least one of state and enabled are required.) + type: bool pattern: - required: false description: - If the service does not respond to the 'running' command, name a substring to look for as would be found in the output of the I(ps) diff --git a/lib/ansible/modules/system/osx_defaults.py b/lib/ansible/modules/system/osx_defaults.py index f5eedd41f4..ebf772a153 100644 --- a/lib/ansible/modules/system/osx_defaults.py +++ b/lib/ansible/modules/system/osx_defaults.py @@ -27,14 +27,11 @@ options: domain: description: - The domain is a domain name of the form com.companyname.appname. - required: false default: NSGlobalDomain host: description: - The host on which the preference should apply. The special value "currentHost" corresponds to the "-currentHost" switch of the defaults commandline tool. - required: false - default: null version_added: "2.1" key: description: @@ -43,24 +40,19 @@ options: type: description: - The type of value to write. - required: false default: string choices: [ "array", "bool", "boolean", "date", "float", "int", "integer", "string" ] array_add: description: - Add new elements to the array for a key which has an array as its value. - required: false - default: false - choices: [ "true", "false" ] + type: bool + default: 'no' value: description: - The value to write. Only required when state = present. - required: false - default: null state: description: - The state of the user defaults - required: false default: present choices: [ "present", "absent" ] notes: diff --git a/lib/ansible/modules/system/puppet.py b/lib/ansible/modules/system/puppet.py index a789737b4d..bba586eb5c 100644 --- a/lib/ansible/modules/system/puppet.py +++ b/lib/ansible/modules/system/puppet.py @@ -25,7 +25,6 @@ options: puppetmaster: description: - The hostname of the puppetmaster to contact. - default: None modulepath: description: - Path to an alternate location for puppet modules. diff --git a/lib/ansible/modules/system/selinux.py b/lib/ansible/modules/system/selinux.py index 1385af0cbd..134ee2d4b9 100644 --- a/lib/ansible/modules/system/selinux.py +++ b/lib/ansible/modules/system/selinux.py @@ -26,18 +26,14 @@ options: policy: description: - "name of the SELinux policy to use (example: C(targeted)) will be required if state is not C(disabled)" - required: false - default: null state: description: - The SELinux mode required: true - default: null choices: [ "enforcing", "permissive", "disabled" ] conf: description: - path to the SELinux configuration file, if non-standard - required: false default: "/etc/selinux/config" aliases: ['configfile', 'file'] notes: diff --git a/lib/ansible/modules/system/selinux_permissive.py b/lib/ansible/modules/system/selinux_permissive.py index b025250b84..69fa5c6ab0 100644 --- a/lib/ansible/modules/system/selinux_permissive.py +++ b/lib/ansible/modules/system/selinux_permissive.py @@ -30,20 +30,17 @@ options: description: - "indicate if the domain should or should not be set as permissive" required: true - choices: [ 'True', 'False' ] + type: bool no_reload: description: - "automatically reload the policy after a change" - "default is set to 'false' as that's what most people would want after changing one domain" - "Note that this doesn't work on older version of the library (example EL 6), the module will silently ignore it in this case" - required: false - default: False - choices: [ 'True', 'False' ] + type: bool + default: 'no' store: description: - "name of the SELinux policy store to use" - required: false - default: null notes: - Requires a version of SELinux recent enough ( ie EL 6 or newer ) requirements: [ policycoreutils-python ] diff --git a/lib/ansible/modules/system/sysctl.py b/lib/ansible/modules/system/sysctl.py index 4f1c212a43..8664dda199 100644 --- a/lib/ansible/modules/system/sysctl.py +++ b/lib/ansible/modules/system/sysctl.py @@ -26,13 +26,10 @@ options: description: - The dot-separated path (aka I(key)) specifying the sysctl variable. required: true - default: null aliases: [ 'key' ] value: description: - Desired value of the sysctl key. - required: false - default: null aliases: [ 'val' ] state: description: @@ -42,29 +39,25 @@ options: ignoreerrors: description: - Use this option to ignore errors about unknown keys. - choices: [ "yes", "no" ] - default: no + type: bool + default: 'no' reload: description: - If C(yes), performs a I(/sbin/sysctl -p) if the C(sysctl_file) is updated. If C(no), does not reload I(sysctl) even if the C(sysctl_file) is updated. - choices: [ "yes", "no" ] - default: "yes" + type: bool + default: 'yes' sysctl_file: description: - Specifies the absolute path to C(sysctl.conf), if not C(/etc/sysctl.conf). - required: false default: /etc/sysctl.conf sysctl_set: description: - Verify token value with the sysctl command and set with -w if necessary - choices: [ "yes", "no" ] - required: false + type: bool + default: 'no' version_added: 1.5 - default: False -notes: [] -requirements: [] author: "David CHANIAL (@davixx) " ''' diff --git a/lib/ansible/modules/utilities/logic/import_role.py b/lib/ansible/modules/utilities/logic/import_role.py index 99df1f5882..2f98ac0614 100644 --- a/lib/ansible/modules/utilities/logic/import_role.py +++ b/lib/ansible/modules/utilities/logic/import_role.py @@ -34,28 +34,25 @@ options: tasks_from: description: - File to load from a role's C(tasks/) directory. - required: False default: main vars_from: description: - File to load from a role's C(vars/) directory. - required: False default: main defaults_from: description: - File to load from a role's C(defaults/) directory. - required: False default: main allow_duplicates: description: - Overrides the role's metadata setting to allow using a role more than once with the same parameters. - required: False - default: True + type: bool + default: 'yes' private: description: - - If C(True) the variables from C(defaults/) and C(vars/) in a role will not be made available to the rest of the + - If C(yes) the variables from C(defaults/) and C(vars/) in a role will not be made available to the rest of the play. - default: None + type: bool notes: - Handlers are made available to the whole play. ''' diff --git a/lib/ansible/modules/utilities/logic/include_role.py b/lib/ansible/modules/utilities/logic/include_role.py index 862d877336..c6e866fe7f 100644 --- a/lib/ansible/modules/utilities/logic/include_role.py +++ b/lib/ansible/modules/utilities/logic/include_role.py @@ -33,28 +33,25 @@ options: tasks_from: description: - File to load from a role's C(tasks/) directory. - required: False default: main vars_from: description: - File to load from a role's C(vars/) directory. - required: False default: main defaults_from: description: - File to load from a role's C(defaults/) directory. - required: False default: main allow_duplicates: description: - Overrides the role's metadata setting to allow using a role more than once with the same parameters. - required: False - default: True + type: bool + default: 'yes' private: description: - - If C(True) the variables from C(defaults/) and C(vars/) in a role will not be made available to the rest of the + - If C(yes) the variables from C(defaults/) and C(vars/) in a role will not be made available to the rest of the play. - default: None + type: bool notes: - Handlers are made available to the whole play. - Before Ansible 2.4, as with C(include), this task could be static or dynamic, If static, it implied that it won't diff --git a/lib/ansible/modules/utilities/logic/include_vars.py b/lib/ansible/modules/utilities/logic/include_vars.py index 921ca1e8e5..457c73ee3b 100644 --- a/lib/ansible/modules/utilities/logic/include_vars.py +++ b/lib/ansible/modules/utilities/logic/include_vars.py @@ -33,12 +33,10 @@ options: description: - The directory name from which the variables should be loaded. - If the path is relative, it will look for the file in vars/ subdirectory of a role or relative to playbook. - default: null name: version_added: "2.2" description: - The name of a variable into which assign the included vars. If omitted (null) they will be made top level vars. - default: null depth: version_added: "2.2" description: @@ -49,18 +47,15 @@ options: version_added: "2.2" description: - Limit the files that are loaded within any directory to this regular expression. - default: null ignore_files: version_added: "2.2" description: - List of file names to ignore. - default: null extensions: version_added: "2.3" description: - List of file extensions to read when using C(dir). default: [yaml, yml, json] - required: False free-form: description: - This module allows you to specify the 'file' option directly without any other options. diff --git a/lib/ansible/modules/utilities/logic/pause.py b/lib/ansible/modules/utilities/logic/pause.py index a8cf2efbcb..4f0c8db663 100644 --- a/lib/ansible/modules/utilities/logic/pause.py +++ b/lib/ansible/modules/utilities/logic/pause.py @@ -28,25 +28,18 @@ options: minutes: description: - A positive number of minutes to pause for. - required: false - default: null seconds: description: - A positive number of seconds to pause for. - required: false - default: null prompt: description: - Optional text to use for the prompt message. - required: false - default: null echo: description: - Contols whether or not keyboard input is shown when typing. - Has no effect if 'seconds' or 'minutes' is set. - required: false + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: 2.5 author: "Tim Bielawa (@tbielawa)" notes: diff --git a/lib/ansible/modules/utilities/logic/set_fact.py b/lib/ansible/modules/utilities/logic/set_fact.py index 2c9f9323fc..78ad6517c5 100644 --- a/lib/ansible/modules/utilities/logic/set_fact.py +++ b/lib/ansible/modules/utilities/logic/set_fact.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright 2013 Dag Wieers +# Copyright: (c) 2013, Dag Wieers (@dagwieers) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function @@ -15,7 +15,8 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' --- -author: "Dag Wieers (@dagwieers)" +author: +- Dag Wieers (@dagwieers) module: set_fact short_description: Set host facts from a task description: @@ -32,13 +33,12 @@ options: in the playbook scope. Or alternatively, accepts complex arguments using the C(args:) statement. required: true - default: null cacheable: description: - This boolean indicates if the facts set will also be added to the fact cache, if fact caching is enabled. - required: false - default: false + type: bool + default: 'no' version_added: "2.4" version_added: "1.2" notes: diff --git a/lib/ansible/modules/utilities/logic/wait_for.py b/lib/ansible/modules/utilities/logic/wait_for.py index fdf9064c2c..3c81fccac4 100644 --- a/lib/ansible/modules/utilities/logic/wait_for.py +++ b/lib/ansible/modules/utilities/logic/wait_for.py @@ -83,8 +83,6 @@ options: - Number of seconds to sleep between checks, before 2.3 this was hardcoded to 1 second. msg: version_added: "2.4" - required: false - default: null description: - This overrides the normal error message from a failure to meet the required conditions. notes: diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py index 37fd10ce97..37380d1330 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py @@ -33,23 +33,15 @@ options: user: description: - User that should own this credential. - required: False - default: null team: description: - Team that should own this credential. - required: False - default: null project: description: - Project that should for this credential. - required: False - default: null organization: description: - Organization that should own the credential. - required: False - default: null kind: description: - Type of credential being added. @@ -58,86 +50,59 @@ options: host: description: - Host for this credential. - required: False - default: null username: description: - Username for this credential. access_key for AWS. - required: False - default: null password: description: - Password for this credential. Use ASK for prompting. secret_key for AWS. api_key for RAX. - required: False - default: null ssh_key_data: description: - Path to SSH private key. - required: False - default: null ssh_key_unlock: description: - Unlock password for ssh_key. Use ASK for prompting. authorize: description: - Should use authorize for net type. - required: False - default: False + type: bool + default: 'no' authorize_password: description: - Password for net credentials that require authorize. - required: False - default: null client: description: - Client or application ID for azure_rm type. - required: False - default: null secret: description: - Secret token for azure_rm type. - required: False - default: null subscription: description: - Subscription ID for azure_rm type. - required: False - default: null tenant: description: - Tenant ID for azure_rm type. - required: False - default: null domain: description: - Domain for openstack type. - required: False - default: null become_method: description: - Become method to Use for privledge escalation. - required: False choices: ["None", "sudo", "su", "pbrun", "pfexec", "pmrun"] - default: "None" become_username: description: - Become username. Use ASK for prompting. - required: False - default: null become_password: description: - Become password. Use ASK for prompting. - required: False - default: null vault_password: description: - Valut password. Use ASK for prompting. state: description: - Desired state of the resource. - required: False - default: "present" choices: ["present", "absent"] + default: "present" extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py index d2183017ab..0afdeeace1 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py @@ -30,8 +30,6 @@ options: description: description: - The description to use for the group. - required: False - default: null inventory: description: - Inventory the group should be made a member of. @@ -39,63 +37,44 @@ options: variables: description: - Variables to use for the group, use C(@) for a file. - required: False - default: null credential: description: - Credential to use for the group. - required: False - default: null source: description: - The source to use for this group. - required: False - default: null, choices: ["manual", "file", "ec2", "rax", "vmware", "gce", "azure", "azure_rm", "openstack", "satellite6" , "cloudforms", "custom"] source_regions: description: - Regions for cloud provider. - required: False - default: null source_vars: description: - Override variables from source with variables from this field. - required: False - default: null instance_filters: description: - Comma-separated list of filter expressions for matching hosts. - required: False - default: null group_by: description: - Limit groups automatically created from inventory source. - required: False - default: null source_script: description: - Inventory script to be used when group type is C(custom). - required: False - default: null overwrite: description: - Delete child groups and hosts not found in source. - required: False - default: False + type: bool + default: 'no' overwrite_vars: description: - Override vars in child groups and hosts with those from external source. - required: False - default: null update_on_launch: description: - Refresh inventory data from its source each time a job is run. - required: False - default: False + type: bool + default: 'no' state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py index 1c625ef3ca..8f028c8755 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py @@ -30,8 +30,6 @@ options: description: description: - The description to use for the host. - required: False - default: null inventory: description: - Inventory the host should be made a member of. @@ -39,17 +37,16 @@ options: enabled: description: - If the host should be enabled. - required: False - default: True + type: bool + default: 'yes' variables: description: - Variables to use for the host. Use C(@) for a file. state: description: - Desired state of the resource. - required: False - default: "present" choices: ["present", "absent"] + default: "present" extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py index fb8bafc3f9..c05d93e665 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py @@ -30,8 +30,6 @@ options: description: description: - The description to use for the inventory. - required: False - default: null organization: description: - Organization the inventory belongs to. @@ -39,12 +37,9 @@ options: variables: description: - Inventory variables. Use C(@) to get from file. - required: False - default: null state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py index af6804bd28..350a7adf8c 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py @@ -30,36 +30,30 @@ options: job_explanation: description: - Job explanation field. - default: null job_type: description: - Job_type to use for the job, only used if prompt for job_type is set. choices: ["run", "check", "scan"] - default: null inventory: description: - Inventory to use for the job, only used if prompt for inventory is set. - default: null credential: description: - Credential to use for job, only used if prompt for credential is set. - default: null extra_vars: description: - Extra_vars to use for the job_template. Prepend C(@) if a file. - default: null limit: description: - Limit to use for the I(job_template). - default: null tags: description: - Specific tags to use for from playbook. - default: null use_job_endpoint: description: - Disable launching jobs from job template. - default: False + type: bool + default: 'no' extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_list.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_list.py index 93737ad189..8f0f373c14 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_list.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_list.py @@ -26,20 +26,18 @@ options: status: description: - Only list jobs with this status. - default: null choices: ['pending', 'waiting', 'running', 'error', 'failed', 'canceled', 'successful'] page: description: - Page number of the results to fetch. - default: null all_pages: description: - Fetch all the pages and return a single result. - default: False + type: bool + default: 'no' query: description: - Query used to further filter the list of jobs. C({"foo":"bar"}) will be passed at C(?foo=bar) - default: null extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py index e8e2a07a4e..703db940d9 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py @@ -30,8 +30,6 @@ options: description: description: - Description to use for the job template. - required: False - default: null job_type: description: - The job_type to use for the job template. @@ -40,8 +38,6 @@ options: inventory: description: - Inventory to use for the job template. - required: False - default: null project: description: - Project to use for the job template. @@ -53,88 +49,67 @@ options: machine_credential: description: - Machine_credential to use for the job template. - required: False - default: null cloud_credential: description: - Cloud_credential to use for the job template. - required: False - default: null network_credential: description: - The network_credential to use for the job template. - required: False - default: null forks: description: - The number of parallel or simultaneous processes to use while executing the playbook. - required: False - default: null limit: description: - A host pattern to further constrain the list of hosts managed or affected by the playbook - required: False - default: null verbosity: description: - Control the output level Ansible produces as the playbook runs. - required: False choices: ["verbose", "debug"] - default: null job_tags: description: - The job_tags to use for the job template. - required: False - default: null skip_tags: description: - The skip_tags to use for the job template. - required: False - default: null host_config_key: description: - Allow provisioning callbacks using this host config key. - required: False - default: null extra_vars_path: description: - Path to the C(extra_vars) YAML file. - required: False - default: null ask_extra_vars: description: - Prompt user for C(extra_vars) on launch. - required: False - default: False + type: bool + default: 'no' ask_tags: description: - Prompt user for job tags on launch. - required: False - default: False + type: bool + default: 'no' ask_job_type: description: - Prompt user for job type on launch. - required: False - default: False + type: bool + default: 'no' ask_inventory: description: - Propmt user for inventory on launch. - required: False - default: False + type: bool + default: 'no' ask_credential: description: - Prompt user for credential on launch. - required: False - default: False + type: bool + default: 'no' become_enabled: description: - Activate privilege escalation. - required: False - default: False + type: bool + default: 'no' state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py index 1747e26b0a..4a455ccb6f 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py @@ -38,7 +38,6 @@ options: timeout: description: - Maximum time in seconds to wait for a job to finish. - default: null extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py index 95f63d1f3c..618b209cf1 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py @@ -27,16 +27,13 @@ options: description: - Name to use for the label. required: True - default: null organization: description: - Organization the label should be applied to. required: True - default: null state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py index fa6daa7833..cf944cf969 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py @@ -30,12 +30,9 @@ options: description: description: - The description to use for the organization. - required: False - default: null state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py index f6726a187b..73f252bfa9 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py @@ -27,62 +27,47 @@ options: description: - Name to use for the project. required: True - default: null description: description: - Description to use for the project. - required: False - default: null scm_type: description: - Type of SCM resource. - required: False - default: "manual" choices: ["manual", "git", "hg", "svn"] + default: "manual" scm_url: description: - URL of SCM resource. - required: False - default: null local_path: description: - The server playbook directory for manual projects. - required: False - default: null scm_branch: description: - The branch to use for the SCM resource. - required: False - default: null scm_credential: description: - Name of the credential to use with this SCM resource. - required: False - default: null scm_clean: description: - Remove local modifications before updating. - required: False - default: False + type: bool + default: 'no' scm_delete_on_update: description: - Remove the repository completely before updating. - required: False - default: False + type: bool + default: 'no' scm_update_on_launch: description: - Before an update to the local repository before launching a job with this project. - required: False - default: False + type: bool + default: 'no' organization: description: - Primary key of organization for project. - required: False - default: null state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py index 9210a9fa9f..46940ab1ec 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py @@ -26,13 +26,9 @@ options: user: description: - User that receives the permissions specified by the role. - required: False - default: null team: description: - Team that receives the permissions specified by the role. - required: False - default: null role: description: - The role type to grant/revoke. @@ -41,37 +37,24 @@ options: target_team: description: - Team that the role acts on. - required: False - default: null inventory: description: - Inventory the role acts on. - required: False - default: null job_template: description: - The job template the role acts on. - required: False - default: null credential: description: - Credential the role acts on. - required: False - default: null organization: description: - Organization the role acts on. - required: False - default: null project: description: - Project the role acts on. - required: False - default: null state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py index 390771f02b..cd0469f773 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py @@ -27,18 +27,15 @@ options: description: - Name to use for the team. required: True - default: null organization: description: - Organization the team should be made a member of. required: True - default: null state: description: - Desired state of the resource. - required: False - default: "present" choices: ["present", "absent"] + default: "present" extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py index 9fb8c639d1..7c66f5a7a5 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py @@ -30,13 +30,9 @@ options: first_name: description: - First name of the user. - required: False - default: null last_name: description: - Last name of the user. - required: False - default: null email: description: - Email address of the user. @@ -44,22 +40,19 @@ options: password: description: - Password of the user. - required: False - default: null superuser: description: - User is a system wide administator. - required: False - default: False + type: bool + default: 'no' auditor: description: - User is a system wide auditor. - required: False - default: False + type: bool + default: 'no' state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower diff --git a/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py b/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py index 04d6a4154c..88acb22b1d 100644 --- a/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py +++ b/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py @@ -27,42 +27,36 @@ description: python module. options: balancer_url_suffix: - default: /balancer-manager/ description: - Suffix of the balancer pool url required to access the balancer pool status page (e.g. balancer_vhost[:port]/balancer_url_suffix). - required: false + default: /balancer-manager/ balancer_vhost: - default: None description: - (ipv4|ipv6|fqdn):port of the Apache httpd 2.4 mod_proxy balancer pool. required: true member_host: - default: None description: - (ipv4|ipv6|fqdn) of the balancer member to get or to set attributes to. Port number is autodetected and should not be specified here. If undefined, apache2_mod_proxy module will return a members list of dictionaries of all the current balancer pool members' attributes. - required: false state: - default: None description: - Desired state of the member host. (absent|disabled),drained,hot_standby,ignore_errors can be simultaneously invoked by separating them with a comma (e.g. state=drained,ignore_errors). - required: false choices: ["present", "absent", "enabled", "disabled", "drained", "hot_standby", "ignore_errors"] tls: - default: false description: - Use https to access balancer management page. - choices: ["true", "false"] + type: bool + default: 'no' validate_certs: - default: true description: - Validate ssl/tls certificates. - choices: ["true", "false"] + type: bool + default: 'yes' ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/web_infrastructure/deploy_helper.py b/lib/ansible/modules/web_infrastructure/deploy_helper.py index 7cddd755fd..38594dde36 100644 --- a/lib/ansible/modules/web_infrastructure/deploy_helper.py +++ b/lib/ansible/modules/web_infrastructure/deploy_helper.py @@ -45,9 +45,6 @@ options: Returned in the C(deploy_helper.project_path) fact. state: - required: False - choices: [ present, finalize, absent, clean, query ] - default: present description: - the state of the project. C(query) will only gather facts, @@ -56,57 +53,52 @@ options: deployed release and optionally clean old releases, C(clean) will remove failed & old releases, C(absent) will remove the project folder (synonymous to the M(file) module with C(state=absent)) + choices: [ present, finalize, absent, clean, query ] + default: present release: - required: False - default: None description: - the release version that is being deployed. Defaults to a timestamp format %Y%m%d%H%M%S (i.e. '20141119223359'). This parameter is optional during C(state=present), but needs to be set explicitly for C(state=finalize). You can use the generated fact C(release={{ deploy_helper.new_release }}). releases_path: - required: False - default: releases description: - the name of the folder that will hold the releases. This can be relative to C(path) or absolute. Returned in the C(deploy_helper.releases_path) fact. + default: releases shared_path: - required: False - default: shared description: - the name of the folder that will hold the shared resources. This can be relative to C(path) or absolute. If this is set to an empty string, no shared folder will be created. Returned in the C(deploy_helper.shared_path) fact. + default: shared current_path: - required: False - default: current description: - the name of the symlink that is created when the deploy is finalized. Used in C(finalize) and C(clean). Returned in the C(deploy_helper.current_path) fact. + default: current unfinished_filename: - required: False - default: DEPLOY_UNFINISHED description: - the name of the file that indicates a deploy has not finished. All folders in the releases_path that contain this file will be deleted on C(state=finalize) with clean=True, or C(state=clean). This file is automatically deleted from the I(new_release_path) during C(state=finalize). + default: DEPLOY_UNFINISHED clean: - required: False - default: True description: - Whether to run the clean procedure in case of C(state=finalize). + type: bool + default: 'yes' keep_releases: - required: False - default: 5 description: - the number of old releases to keep when cleaning. Used in C(finalize) and C(clean). Any unfinished builds will be deleted first, so only correct releases will count. The current version will not count. + default: 5 notes: - Facts are only returned for C(state=query) and C(state=present). If you use both, you should pass any overridden diff --git a/lib/ansible/modules/web_infrastructure/jenkins_plugin.py b/lib/ansible/modules/web_infrastructure/jenkins_plugin.py index 869331b43e..333fad9463 100644 --- a/lib/ansible/modules/web_infrastructure/jenkins_plugin.py +++ b/lib/ansible/modules/web_infrastructure/jenkins_plugin.py @@ -23,45 +23,35 @@ description: options: group: - required: false - default: jenkins description: - Name of the Jenkins group on the OS. + default: jenkins jenkins_home: - required: false - default: /var/lib/jenkins description: - Home directory of the Jenkins user. + default: /var/lib/jenkins mode: - required: false - default: '0664' description: - File mode applied on versioned plugins. name: - required: true description: - Plugin name. owner: - required: false - default: jenkins description: - Name of the Jenkins user on the OS. + default: jenkins state: - required: false - choices: [absent, present, pinned, unpinned, enabled, disabled, latest] - default: present description: - Desired plugin state. - If the C(latest) is set, the check for new version will be performed every time. This is suitable to keep the plugin up-to-date. + choices: [absent, present, pinned, unpinned, enabled, disabled, latest] + default: present timeout: - required: false - default: 30 description: - Server connection timeout in secs. + default: 30 updates_expiration: - required: false - default: 86400 description: - Number of seconds after which a new copy of the I(update-center.json) file is downloaded. This is used to avoid the need to download the @@ -69,21 +59,18 @@ options: - Set it to C(0) if no cache file should be used. In that case, the plugin file will always be downloaded to calculate its checksum when C(latest) is specified. + default: 86400 updates_url: - required: false - default: https://updates.jenkins-ci.org description: - URL of the Update Centre. - Used as the base URL to download the plugins and the I(update-center.json) JSON file. + default: https://updates.jenkins-ci.org url: - required: false - default: http://localhost:8080 description: - URL of the Jenkins server. + default: http://localhost:8080 version: - required: false - default: null description: - Plugin version number. - If this option is specified, all plugin dependencies must be installed @@ -93,12 +80,11 @@ options: - Quote the version to prevent the value to be interpreted as float. For example if C(1.20) would be unquoted, it would become C(1.2). with_dependencies: - required: false - choices: ['yes', 'no'] - default: 'yes' description: - Defines whether to install plugin dependencies. - This option takes effect only if the I(version) is not defined. + type: bool + default: 'yes' notes: - Plugin installation should be run under root or the same user which owns diff --git a/lib/ansible/modules/web_infrastructure/jenkins_script.py b/lib/ansible/modules/web_infrastructure/jenkins_script.py index 7efa492c2f..da0a07ef30 100644 --- a/lib/ansible/modules/web_infrastructure/jenkins_script.py +++ b/lib/ansible/modules/web_infrastructure/jenkins_script.py @@ -30,41 +30,32 @@ options: - The groovy script to be executed. This gets passed as a string Template if args is defined. required: true - default: null url: description: - The jenkins server to execute the script against. The default is a local jenkins instance that is not being proxied through a webserver. - required: false default: http://localhost:8080 validate_certs: description: - If set to C(no), the SSL certificates will not be validated. This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site. - required: false - default: True + type: bool + default: 'yes' user: description: - The username to connect to the jenkins server with. - required: false - default: null password: description: - The password to connect to the jenkins server with. - required: false - default: null timeout: description: - The request timeout in seconds - required: false default: 10 version_added: "2.4" args: description: - A dict of key-value pairs used in formatting the script using string.Template (see https://docs.python.org/2/library/string.html#template-strings). - required: false - default: null notes: - Since the script can do anything this does not report on changes. diff --git a/lib/ansible/modules/web_infrastructure/letsencrypt.py b/lib/ansible/modules/web_infrastructure/letsencrypt.py index ab9b7aa0c0..79b4f0158e 100644 --- a/lib/ansible/modules/web_infrastructure/letsencrypt.py +++ b/lib/ansible/modules/web_infrastructure/letsencrypt.py @@ -104,8 +104,8 @@ options: - "Boolean indicating whether you agree to the terms of service document." - "ACME servers can require this to be true." - This option will only be used when C(acme_version) is not 1. - default: no type: bool + default: 'no' version_added: "2.5" challenge: description: The challenge to be performed. @@ -157,8 +157,8 @@ options: - Whether calls to the ACME directory will validate TLS certificates. - I(Warning:) Should I(only ever) be set to C(false) for testing purposes, for example when testing against a local Pebble server. - default: yes type: bool + default: 'yes' version_added: 2.5 deactivate_authzs: description: @@ -168,8 +168,8 @@ options: for a certain amount of time, and can be used to issue certificates without having to re-authenticate the domain. This can be a security concern. " - default: no type: bool + default: 'no' version_added: 2.6 force: description: @@ -177,8 +177,8 @@ options: existing certificate is still valid. - This is especially helpful when having an updated CSR e.g. with additional domains for which a new certificate is desired. - default: no type: bool + default: 'no' version_added: 2.6 ''' diff --git a/lib/ansible/modules/web_infrastructure/supervisorctl.py b/lib/ansible/modules/web_infrastructure/supervisorctl.py index e58ae06b46..5fbb7f9e1b 100644 --- a/lib/ansible/modules/web_infrastructure/supervisorctl.py +++ b/lib/ansible/modules/web_infrastructure/supervisorctl.py @@ -27,42 +27,30 @@ options: - The name will be taken as group name when it ends with a colon I(:) - Group support is only available in Ansible version 1.6 or later. required: true - default: null config: description: - The supervisor configuration file path - required: false - default: null version_added: "1.3" server_url: description: - URL on which supervisord server is listening - required: false - default: null version_added: "1.3" username: description: - username to use for authentication - required: false - default: null version_added: "1.3" password: description: - password to use for authentication - required: false - default: null version_added: "1.3" state: description: - The desired state of program/group. required: true - default: null choices: [ "present", "started", "stopped", "restarted", "absent" ] supervisorctl_path: description: - path to supervisorctl executable - required: false - default: null version_added: "1.4" notes: - When C(state) = I(present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist. diff --git a/lib/ansible/modules/web_infrastructure/taiga_issue.py b/lib/ansible/modules/web_infrastructure/taiga_issue.py index 18c787ce73..872a0a63d3 100644 --- a/lib/ansible/modules/web_infrastructure/taiga_issue.py +++ b/lib/ansible/modules/web_infrastructure/taiga_issue.py @@ -26,7 +26,6 @@ options: taiga_host: description: - The hostname of the Taiga instance. - required: False default: https://api.taiga.io project: description: @@ -43,42 +42,33 @@ options: priority: description: - The issue priority. Must exist previously. - required: False default: Normal status: description: - The issue status. Must exist previously. - required: False default: New severity: description: - The issue severity. Must exist previously. - required: False default: Normal description: description: - The issue description. - required: False default: "" attachment: description: - Path to a file to be attached to the issue. - required: False - default: None attachment_description: description: - A string describing the file to be attached to the issue. - required: False default: "" tags: description: - A lists of tags to be assigned to the issue. - required: False default: [] state: description: - Whether the issue should be present or not. - required: False choices: ["present", "absent"] default: present author: Alejandro Guirao (@lekum) diff --git a/lib/ansible/plugins/connection/netconf.py b/lib/ansible/plugins/connection/netconf.py index 46b120c434..f116af4f0d 100644 --- a/lib/ansible/plugins/connection/netconf.py +++ b/lib/ansible/plugins/connection/netconf.py @@ -46,7 +46,6 @@ options: - Configures the device platform network operating system. This value is used to load a device specific netconf plugin. If this option is not configured, then the default netconf plugin will be used. - default: null vars: - name: ansible_network_os remote_user: @@ -88,14 +87,14 @@ options: timeout seconds, an error is generated. default: 120 host_key_auto_add: - type: boolean + type: bool description: - By default, Ansible will prompt the user before adding SSH keys to the known hosts file. Enabling this option, unknown host keys will automatically be added to the known hosts file. - Be sure to fully understand the security implications of enabling this option on production systems as it could create a security vulnerability. - default: False + default: 'no' ini: section: paramiko_connection key: host_key_auto_add diff --git a/lib/ansible/plugins/connection/network_cli.py b/lib/ansible/plugins/connection/network_cli.py index b533cc9022..1b3bccc476 100644 --- a/lib/ansible/plugins/connection/network_cli.py +++ b/lib/ansible/plugins/connection/network_cli.py @@ -41,7 +41,6 @@ options: - Configures the device platform network operating system. This value is used to load the correct terminal and cliconf plugins to communicate with the remote device - default: null vars: - name: ansible_network_os remote_user: diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py index 008f2ebfe9..92dad2d743 100644 --- a/lib/ansible/plugins/connection/ssh.py +++ b/lib/ansible/plugins/connection/ssh.py @@ -150,7 +150,6 @@ DOCUMENTATION = ''' - name: ansible_ssh_private_key_file control_path: - default: null description: - This is the location to save ssh's ControlPath sockets, it uses ssh's variable substitution. - Since 2.3, if null, ansible will generate a unique hash. Use `%(directory)s` to indicate where to use the control dir path setting. @@ -170,12 +169,12 @@ DOCUMENTATION = ''' - section: ssh_connection key: control_path_dir sftp_batch_mode: - default: True + default: 'yes' description: 'TODO: write it' env: [{name: ANSIBLE_SFTP_BATCH_MODE}] ini: - {key: sftp_batch_mode, section: ssh_connection} - type: boolean + type: bool scp_if_ssh: default: smart description: @@ -187,12 +186,12 @@ DOCUMENTATION = ''' - {key: scp_if_ssh, section: ssh_connection} use_tty: version_added: '2.5' - default: True + default: 'yes' description: add -tt to ssh commands to force tty allocation env: [{name: ANSIBLE_SSH_USETTY}] ini: - {key: usetty, section: ssh_connection} - type: boolean + type: bool yaml: {key: connection.usetty} ''' diff --git a/lib/ansible/plugins/inventory/openstack.py b/lib/ansible/plugins/inventory/openstack.py index 90747a9529..333b0e9c0e 100644 --- a/lib/ansible/plugins/inventory/openstack.py +++ b/lib/ansible/plugins/inventory/openstack.py @@ -22,8 +22,8 @@ DOCUMENTATION = ''' options: show_all: description: toggles showing all vms vs only those with a working IP - type: boolean - default: False + type: bool + default: 'no' inventory_hostname: description: | What to register as the inventory hostname. @@ -46,16 +46,16 @@ DOCUMENTATION = ''' neutron and can be expensive for people with many hosts. (Note, the default value of this is opposite from the default old openstack.py inventory script's option expand_hostvars) - type: boolean - default: False + type: bool + default: 'no' private: description: | Use the private interface of each server, if it has one, as the host's IP in the inventory. This can be useful if you are running ansible inside a server in the cloud and would rather communicate to your servers over the private network. - type: boolean - default: False + type: bool + default: 'no' only_clouds: description: | List of clouds from clouds.yaml to use, instead of using @@ -70,8 +70,8 @@ DOCUMENTATION = ''' it can from as many clouds as it can contact. (Note, the default value of this is opposite from the old openstack.py inventory script's option fail_on_errors) - type: boolean - default: False + type: bool + default: 'no' clouds_yaml_path: description: | Override path to clouds.yaml file. If this value is given it @@ -80,7 +80,6 @@ DOCUMENTATION = ''' /etc/ansible/openstack.yml to the regular locations documented at https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files type: string - default: None compose: description: Create vars from jinja2 expressions. type: dictionary diff --git a/lib/ansible/plugins/lookup/aws_account_attribute.py b/lib/ansible/plugins/lookup/aws_account_attribute.py index 25a5460488..a3e4fe0779 100644 --- a/lib/ansible/plugins/lookup/aws_account_attribute.py +++ b/lib/ansible/plugins/lookup/aws_account_attribute.py @@ -20,7 +20,6 @@ description: options: attribute: description: The attribute for which to get the value(s). - default: null choices: - supported-platforms - default-vpc diff --git a/lib/ansible/plugins/lookup/aws_service_ip_ranges.py b/lib/ansible/plugins/lookup/aws_service_ip_ranges.py index 1a3341e136..89072f6962 100644 --- a/lib/ansible/plugins/lookup/aws_service_ip_ranges.py +++ b/lib/ansible/plugins/lookup/aws_service_ip_ranges.py @@ -18,10 +18,8 @@ description: options: service: description: 'The service to filter ranges by. Options: EC2, S3, CLOUDFRONT, CODEbUILD, ROUTE53, ROUTE53_HEALTHCHECKS' - default: null region: description: 'The AWS region to narrow the ranges to. Examples: us-east-1, eu-west-2, ap-southeast-1' - default: null """ EXAMPLES = """ diff --git a/lib/ansible/plugins/lookup/nios.py b/lib/ansible/plugins/lookup/nios.py index acaba6e3e6..87751cd7b4 100644 --- a/lib/ansible/plugins/lookup/nios.py +++ b/lib/ansible/plugins/lookup/nios.py @@ -38,16 +38,10 @@ options: required: True return_fields: description: The list of field names to return for the specified object. - required: False - default: null filter: description: a dict object that is used to filter the return objects - required: False - default: null extattrs: description: a dict object that is used to filter on extattrs - required: false - default: null """ EXAMPLES = """ diff --git a/lib/ansible/plugins/lookup/passwordstore.py b/lib/ansible/plugins/lookup/passwordstore.py index be09f66d88..d06f37bef1 100644 --- a/lib/ansible/plugins/lookup/passwordstore.py +++ b/lib/ansible/plugins/lookup/passwordstore.py @@ -23,21 +23,20 @@ DOCUMENTATION = """ default: '~/.password-store' directory: description: directory of the password store - default: null env: - name: PASSWORD_STORE_DIR create: description: flag to create the password - type: boolean - default: False + type: bool + default: 'no' overwrite: description: flag to overwrite the password - type: boolean - default: False + type: bool + default: 'no' returnall: description: flag to return all the contents of the password store - type: boolean - default: False + type: bool + default: 'no' subkey: description: subkey to return default: password diff --git a/lib/ansible/utils/module_docs_fragments/a10.py b/lib/ansible/utils/module_docs_fragments/a10.py index 7e5a8bb40a..e5211dc102 100644 --- a/lib/ansible/utils/module_docs_fragments/a10.py +++ b/lib/ansible/utils/module_docs_fragments/a10.py @@ -28,35 +28,30 @@ options: description: - Hostname or IP of the A10 Networks device. required: true - default: null username: description: - An account with administrator privileges. required: true aliases: ['user', 'admin'] - default: null password: description: - Password for the C(username) account. required: true aliases: ['pass', 'pwd'] - default: null write_config: description: - If C(yes), any changes will cause a write of the running configuration to non-volatile memory. This will save I(all) configuration changes, including those that may have been made manually or through other modules, so care should be taken when specifying C(yes). - required: false version_added: 2.2 - default: "no" - choices: ["yes", "no"] + type: bool + default: 'no' validate_certs: description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates. - required: false version_added: 2.2 + type: bool default: 'yes' - choices: ['yes', 'no'] """ diff --git a/lib/ansible/utils/module_docs_fragments/aci.py b/lib/ansible/utils/module_docs_fragments/aci.py index dc67710c8d..f5b065fad7 100644 --- a/lib/ansible/utils/module_docs_fragments/aci.py +++ b/lib/ansible/utils/module_docs_fragments/aci.py @@ -18,8 +18,9 @@ options: port: description: - Port number to be used for REST connection. + - The default value depends on parameter `use_ssl`. type: int - default: 443 (for https), 80 (for http) + default: 443 (https), 80 (http) username: description: - The username to use for authentication. @@ -41,7 +42,6 @@ options: description: - The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. - It defaults to the C(private_key) basename, without extension. - default: private_key basename aliases: [ cert_name ] output_level: description: diff --git a/lib/ansible/utils/module_docs_fragments/aireos.py b/lib/ansible/utils/module_docs_fragments/aireos.py index abc2cc7662..6f623a3a0c 100644 --- a/lib/ansible/utils/module_docs_fragments/aireos.py +++ b/lib/ansible/utils/module_docs_fragments/aireos.py @@ -25,7 +25,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -50,7 +49,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/aruba.py b/lib/ansible/utils/module_docs_fragments/aruba.py index abc2cc7662..6f623a3a0c 100644 --- a/lib/ansible/utils/module_docs_fragments/aruba.py +++ b/lib/ansible/utils/module_docs_fragments/aruba.py @@ -25,7 +25,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -50,7 +49,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/asa.py b/lib/ansible/utils/module_docs_fragments/asa.py index 68f4b1a49c..183ba3b693 100644 --- a/lib/ansible/utils/module_docs_fragments/asa.py +++ b/lib/ansible/utils/module_docs_fragments/asa.py @@ -34,13 +34,12 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' context: description: - Specifies which context to target if you are running in the ASA in multiple context mode. Defaults to the current context you login to. - default: null provider: description: - B(Deprecated) @@ -48,7 +47,6 @@ options: - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -72,7 +70,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to @@ -87,15 +84,14 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none timeout: description: - Specifies idle timeout in seconds for the connection, in seconds. Useful diff --git a/lib/ansible/utils/module_docs_fragments/auth_basic.py b/lib/ansible/utils/module_docs_fragments/auth_basic.py index c46790b63e..22620a9a20 100644 --- a/lib/ansible/utils/module_docs_fragments/auth_basic.py +++ b/lib/ansible/utils/module_docs_fragments/auth_basic.py @@ -20,23 +20,17 @@ class ModuleDocFragment(object): DOCUMENTATION = """ options: api_url: - required: false - default: null description: - The resolvable endpoint for the API api_username: - required: false - default: null description: - The username to use for authentication against the API api_password: - required: false - default: null description: - The password to use for authentication against the API validate_certs: - required: false - default: yes description: - Whether or not to validate SSL certs when supplying a https endpoint. + type: bool + default: 'yes' """ diff --git a/lib/ansible/utils/module_docs_fragments/aws.py b/lib/ansible/utils/module_docs_fragments/aws.py index 0139ea462e..f75b65b60e 100644 --- a/lib/ansible/utils/module_docs_fragments/aws.py +++ b/lib/ansible/utils/module_docs_fragments/aws.py @@ -26,42 +26,28 @@ options: - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. - required: false - default: null - aliases: [] aws_secret_key: description: - AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. - required: false - default: null aliases: [ 'ec2_secret_key', 'secret_key' ] aws_access_key: description: - AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. - required: false - default: null aliases: [ 'ec2_access_key', 'access_key' ] security_token: description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - required: false - default: null aliases: [ 'access_token' ] version_added: "1.6" validate_certs: description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" type: bool - aliases: [] + default: 'yes' version_added: "1.5" profile: description: - Uses a boto profile. Only works with boto >= 2.24.0. - required: false - default: null - aliases: [] version_added: "1.6" requirements: - "python >= 2.6" diff --git a/lib/ansible/utils/module_docs_fragments/azure.py b/lib/ansible/utils/module_docs_fragments/azure.py index 4659cec95c..046fe0e5b8 100644 --- a/lib/ansible/utils/module_docs_fragments/azure.py +++ b/lib/ansible/utils/module_docs_fragments/azure.py @@ -28,39 +28,25 @@ options: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. - required: false - default: null password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. - required: false - default: null profile: description: - Security profile found in ~/.azure/credentials file. - required: false - default: null subscription_id: description: - Your Azure subscription Id. - required: false - default: null client_id: description: - Azure client ID. Use when authenticating with a Service Principal. - required: false - default: null secret: description: - Azure client secret. Use when authenticating with a Service Principal. - required: false - default: null tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. - required: false - default: null cloud_environment: description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), @@ -74,7 +60,6 @@ options: when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. choices: [validate, ignore] - default: null version_added: 2.5 auth_source: description: diff --git a/lib/ansible/utils/module_docs_fragments/azure_tags.py b/lib/ansible/utils/module_docs_fragments/azure_tags.py index b36c319ec6..ff8579fde4 100644 --- a/lib/ansible/utils/module_docs_fragments/azure_tags.py +++ b/lib/ansible/utils/module_docs_fragments/azure_tags.py @@ -28,12 +28,10 @@ options: - > Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. - required: false - default: null append_tags: description: - Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. - default: True - required: false + type: bool + default: 'yes' ''' diff --git a/lib/ansible/utils/module_docs_fragments/ce.py b/lib/ansible/utils/module_docs_fragments/ce.py index 9f071e17e3..7a5f006ae8 100644 --- a/lib/ansible/utils/module_docs_fragments/ce.py +++ b/lib/ansible/utils/module_docs_fragments/ce.py @@ -24,7 +24,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -38,7 +37,6 @@ options: device. This value applies to either I(cli) or I(netconf). The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, netconf=22). - required: false default: 0 (use common port) username: description: @@ -46,22 +44,18 @@ options: the remote device. This value is used to authenticate the CLI login. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - required: false password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for cli transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - required: false - default: null ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - required: false transport: description: - Configures the transport connection to use when connecting to the diff --git a/lib/ansible/utils/module_docs_fragments/cnos.py b/lib/ansible/utils/module_docs_fragments/cnos.py index 681b0fea96..f200f58d02 100644 --- a/lib/ansible/utils/module_docs_fragments/cnos.py +++ b/lib/ansible/utils/module_docs_fragments/cnos.py @@ -29,7 +29,6 @@ options: Usually the location is the results folder, but you can choose another location based on your write permission. required: true - default: Null version_added: 2.3 host: description: @@ -40,7 +39,6 @@ options: an abstraction of the group of network elements that need to be configured. required: true - default: Null version_added: 2.3 username: description: @@ -51,7 +49,6 @@ options: variable. This parameter is optional. If it is not specified, no default value will be used. required: true - default: Null version_added: 2.3 password: description: @@ -62,7 +59,6 @@ options: variable. This parameter is optional. If it is not specified, no default value will be used. required: true - default: Null version_added: 2.3 enablePassword: description: @@ -72,8 +68,6 @@ options: should come from the inventory file, you can also specify it as a variable. This parameter is optional. If it is not specified, no default value will be used. - required: false - default: Null version_added: 2.3 deviceType: description: @@ -81,7 +75,6 @@ options: The choices NE1072T,NE1032,NE1032T,NE10032, NE2572 are added since version 2.4 required: Yes - default: null choices: [g8272_cnos,g8296_cnos,g8332_cnos,NE1072T,NE1032, NE1032T,NE10032,NE2572] version_added: 2.3 diff --git a/lib/ansible/utils/module_docs_fragments/dellos10.py b/lib/ansible/utils/module_docs_fragments/dellos10.py index 9e117eb0b5..4aacf1f0c7 100644 --- a/lib/ansible/utils/module_docs_fragments/dellos10.py +++ b/lib/ansible/utils/module_docs_fragments/dellos10.py @@ -27,7 +27,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -50,7 +49,6 @@ options: - Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null ssh_keyfile: description: - Path to an ssh key used to authenticate the SSH session to the remote diff --git a/lib/ansible/utils/module_docs_fragments/dellos6.py b/lib/ansible/utils/module_docs_fragments/dellos6.py index 9e117eb0b5..4aacf1f0c7 100644 --- a/lib/ansible/utils/module_docs_fragments/dellos6.py +++ b/lib/ansible/utils/module_docs_fragments/dellos6.py @@ -27,7 +27,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -50,7 +49,6 @@ options: - Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null ssh_keyfile: description: - Path to an ssh key used to authenticate the SSH session to the remote diff --git a/lib/ansible/utils/module_docs_fragments/dellos9.py b/lib/ansible/utils/module_docs_fragments/dellos9.py index 9e117eb0b5..4aacf1f0c7 100644 --- a/lib/ansible/utils/module_docs_fragments/dellos9.py +++ b/lib/ansible/utils/module_docs_fragments/dellos9.py @@ -27,7 +27,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -50,7 +49,6 @@ options: - Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null ssh_keyfile: description: - Path to an ssh key used to authenticate the SSH session to the remote diff --git a/lib/ansible/utils/module_docs_fragments/docker.py b/lib/ansible/utils/module_docs_fragments/docker.py index 4a93ca990a..a1649ed75c 100644 --- a/lib/ansible/utils/module_docs_fragments/docker.py +++ b/lib/ansible/utils/module_docs_fragments/docker.py @@ -26,7 +26,6 @@ options: - "The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection, the module will automatically replace 'tcp' in the connection URL with 'https'." - required: false default: "unix://var/run/docker.sock" aliases: - docker_url @@ -34,55 +33,43 @@ options: description: - When verifying the authenticity of the Docker Host server, provide the expected name of the server. default: localhost - required: false api_version: description: - The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by docker-py. - required: false default: default provided by docker-py aliases: - docker_api_version timeout: description: - The maximum amount of time in seconds to wait on a response from the API. - required: false default: 60 cacert_path: description: - Use a CA certificate when performing server verification by providing the path to a CA certificate file. - required: false - default: null aliases: - tls_ca_cert cert_path: description: - Path to the client's TLS certificate file. - required: false - default: null aliases: - tls_client_cert key_path: description: - Path to the client's TLS key file. - required: false - default: null aliases: - tls_client_key ssl_version: description: - Provide a valid SSL version number. Default value determined by docker-py, currently 1.0. - required: false default: "1.0" tls: description: - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. - default: false tls_verify: description: - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. - default: false notes: - Connect to the Docker daemon by providing parameters with each task or by defining environment variables. diff --git a/lib/ansible/utils/module_docs_fragments/enos.py b/lib/ansible/utils/module_docs_fragments/enos.py index ccc59cfad2..128608f28e 100644 --- a/lib/ansible/utils/module_docs_fragments/enos.py +++ b/lib/ansible/utils/module_docs_fragments/enos.py @@ -23,19 +23,17 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -59,7 +57,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device @@ -80,13 +77,12 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none ''' diff --git a/lib/ansible/utils/module_docs_fragments/eos.py b/lib/ansible/utils/module_docs_fragments/eos.py index e1a338d9d7..0252d1dcd8 100644 --- a/lib/ansible/utils/module_docs_fragments/eos.py +++ b/lib/ansible/utils/module_docs_fragments/eos.py @@ -34,8 +34,8 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - B(Deprecated) @@ -47,7 +47,6 @@ options: on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none provider: description: - B(Deprecated) @@ -56,7 +55,6 @@ options: - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -84,7 +82,6 @@ options: the remote device. This is a common argument used for either I(cli) or I(eapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device @@ -104,15 +101,14 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none transport: description: - Configures the transport connection to use when connecting to the @@ -127,19 +123,19 @@ options: - Configures the I(transport) to use SSL if set to true only when the C(transport=eapi). If the transport argument is not eapi, this value is ignored. - default: yes - choices: ['yes', 'no'] + type: bool + default: 'yes' 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. If the transport argument is not eapi, this value is ignored. - choices: ['yes', 'no'] + type: bool use_proxy: description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: "2.5" notes: diff --git a/lib/ansible/utils/module_docs_fragments/f5.py b/lib/ansible/utils/module_docs_fragments/f5.py index f9a352f1c1..00725a407b 100644 --- a/lib/ansible/utils/module_docs_fragments/f5.py +++ b/lib/ansible/utils/module_docs_fragments/f5.py @@ -50,13 +50,12 @@ options: on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. - default: yes type: bool + default: 'yes' version_added: 2.0 provider: description: - A dict object containing connection details. - default: null version_added: 2.5 suboptions: password: @@ -88,8 +87,8 @@ options: on personally controlled sites using self-signed certificates. You can omit this option if the environment variable C(F5_VALIDATE_CERTS) is set. - default: yes type: bool + default: 'yes' timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/files.py b/lib/ansible/utils/module_docs_fragments/files.py index 9594520b91..8f263f73d4 100644 --- a/lib/ansible/utils/module_docs_fragments/files.py +++ b/lib/ansible/utils/module_docs_fragments/files.py @@ -22,46 +22,33 @@ class ModuleDocFragment(object): DOCUMENTATION = """ options: mode: - required: false - default: null description: - Mode the file or directory should be. For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers (like C(0644) or C(01777)). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)). owner: - required: false - default: null description: - Name of the user that should own the file/directory, as would be fed to I(chown). group: - required: false - default: null description: - Name of the group that should own the file/directory, as would be fed to I(chown). seuser: - required: false - default: null description: - User part of SELinux file context. Will default to system policy, if applicable. If set to C(_default), it will use the C(user) portion of the policy if available. serole: - required: false - default: null description: - Role part of SELinux file context, C(_default) feature works as for I(seuser). setype: - required: false - default: null description: - Type part of SELinux file context, C(_default) feature works as for I(seuser). selevel: - required: false - default: "s0" description: - Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the C(range). C(_default) feature works as for I(seuser). + default: "s0" unsafe_writes: description: - Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, @@ -70,15 +57,12 @@ options: - This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption. type: bool - required: false - default: false + default: 'no' version_added: "2.2" attributes: description: - Attributes the file or directory should have. To get supported flags look at the man page for I(chattr) on the target system. This string should contain the attributes in the same order as the one displayed by I(lsattr). - required: false - default: None aliases: ['attr'] version_added: "2.3" """ diff --git a/lib/ansible/utils/module_docs_fragments/gcp.py b/lib/ansible/utils/module_docs_fragments/gcp.py index 9cc6e73f67..ff5841f8b9 100644 --- a/lib/ansible/utils/module_docs_fragments/gcp.py +++ b/lib/ansible/utils/module_docs_fragments/gcp.py @@ -15,7 +15,6 @@ options: project: description: - The Google Cloud Platform project to use. - default: null auth_kind: description: - The type of credential used. diff --git a/lib/ansible/utils/module_docs_fragments/influxdb.py b/lib/ansible/utils/module_docs_fragments/influxdb.py index b2f1dece14..ac4c2ed781 100644 --- a/lib/ansible/utils/module_docs_fragments/influxdb.py +++ b/lib/ansible/utils/module_docs_fragments/influxdb.py @@ -37,12 +37,10 @@ options: ssl: description: - Use https instead of http to connect to InfluxDB server. - default: False version_added: "2.5" timeout: description: - Number of seconds Requests will wait for client to establish a connection. - default: None version_added: "2.5" retries: description: @@ -53,7 +51,6 @@ options: use_udp: description: - Use UDP to connect to InfluxDB server. - default: False version_added: "2.5" udp_port: description: @@ -63,6 +60,5 @@ options: proxies: description: - HTTP(S) proxy to use for Requests to connect to InfluxDB server. - default: None version_added: "2.5" ''' diff --git a/lib/ansible/utils/module_docs_fragments/ios.py b/lib/ansible/utils/module_docs_fragments/ios.py index 225e0ccd03..b53aa31655 100644 --- a/lib/ansible/utils/module_docs_fragments/ios.py +++ b/lib/ansible/utils/module_docs_fragments/ios.py @@ -33,8 +33,8 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - B(Deprecated) @@ -45,7 +45,6 @@ options: on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none provider: description: - B(Deprecated) @@ -53,7 +52,6 @@ options: - For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -77,7 +75,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device @@ -98,15 +95,14 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none notes: - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. diff --git a/lib/ansible/utils/module_docs_fragments/iosxr.py b/lib/ansible/utils/module_docs_fragments/iosxr.py index ce1ff18164..c54046b2af 100644 --- a/lib/ansible/utils/module_docs_fragments/iosxr.py +++ b/lib/ansible/utils/module_docs_fragments/iosxr.py @@ -29,7 +29,6 @@ options: - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -53,7 +52,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/ironware.py b/lib/ansible/utils/module_docs_fragments/ironware.py index 54a11b6485..7b65f13f51 100644 --- a/lib/ansible/utils/module_docs_fragments/ironware.py +++ b/lib/ansible/utils/module_docs_fragments/ironware.py @@ -29,12 +29,11 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -58,7 +57,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to @@ -73,15 +71,14 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none timeout: description: - Specifies idle timeout in seconds for the connection, in seconds. Useful diff --git a/lib/ansible/utils/module_docs_fragments/junos.py b/lib/ansible/utils/module_docs_fragments/junos.py index 03e22ac6a6..d8596862b5 100644 --- a/lib/ansible/utils/module_docs_fragments/junos.py +++ b/lib/ansible/utils/module_docs_fragments/junos.py @@ -29,7 +29,6 @@ options: - For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -56,7 +55,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/manageiq.py b/lib/ansible/utils/module_docs_fragments/manageiq.py index 2f9d86bb52..397b65df48 100644 --- a/lib/ansible/utils/module_docs_fragments/manageiq.py +++ b/lib/ansible/utils/module_docs_fragments/manageiq.py @@ -17,25 +17,19 @@ options: description: - ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it. username: - required: false description: - ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no token is passed in. password: - required: false description: - ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no token is passed in. token: - required: false description: - ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username or password is passed in. verify_ssl: - required: false - default: true description: - Whether SSL certificates should be verified for HTTPS requests. defaults to True. + default: true ca_bundle_path: - required: false - default: null description: - The path to a CA bundle file or directory with certificates. defaults to None. diff --git a/lib/ansible/utils/module_docs_fragments/mysql.py b/lib/ansible/utils/module_docs_fragments/mysql.py index 0163706a12..91454bd6a6 100644 --- a/lib/ansible/utils/module_docs_fragments/mysql.py +++ b/lib/ansible/utils/module_docs_fragments/mysql.py @@ -25,55 +25,39 @@ options: login_user: description: - The username used to authenticate with. - required: false - default: null login_password: description: - The password used to authenticate with. - required: false - default: null login_host: description: - Host running the database. - required: false default: localhost login_port: description: - Port of the MySQL server. Requires I(login_host) be defined as other then localhost if login_port is used. - required: false default: 3306 login_unix_socket: description: - The path to a Unix domain socket for local connections. - required: false - default: null connect_timeout: description: - The connection timeout when connecting to the MySQL server. - required: false default: 30 version_added: "2.1" config_file: description: - Specify a config file from which user and password are to be read. - required: false default: '~/.my.cnf' version_added: "2.0" ssl_ca: - required: false - default: null version_added: "2.0" description: - The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server. ssl_cert: - required: false - default: null version_added: "2.0" description: - The path to a client public key certificate. ssl_key: - required: false - default: null version_added: "2.0" description: - The path to the client private key. diff --git a/lib/ansible/utils/module_docs_fragments/nios.py b/lib/ansible/utils/module_docs_fragments/nios.py index 3b37b7fe57..e2fb133e2a 100644 --- a/lib/ansible/utils/module_docs_fragments/nios.py +++ b/lib/ansible/utils/module_docs_fragments/nios.py @@ -25,7 +25,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -46,20 +45,18 @@ options: the remote instance of NIOS. - Value can also be specified using C(INFOBLOX_PASSWORD) environment variable. - default: null ssl_verify: description: - Boolean value to enable or disable verifying SSL certificates - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable. - required: false - default: false + type: bool + default: 'no' http_request_timeout: description: - The amount of time before to wait before receiving a response - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment variable. - required: false default: 10 max_retries: description: @@ -67,14 +64,12 @@ options: is declared usable - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable. - required: false default: 3 wapi_version: description: - Specifies the version of WAPI to use - Value can also be specified using C(INFOBLOX_WAP_VERSION) environment variable. - required: false default: 1.4 max_results: description: @@ -83,7 +78,6 @@ options: number of returned objects would exceed the setting. - Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment variable. - required: false default: 1000 notes: - "This module must be run locally, which can be achieved by specifying C(connection: local)." diff --git a/lib/ansible/utils/module_docs_fragments/nxos.py b/lib/ansible/utils/module_docs_fragments/nxos.py index 44804c5505..dba3561872 100644 --- a/lib/ansible/utils/module_docs_fragments/nxos.py +++ b/lib/ansible/utils/module_docs_fragments/nxos.py @@ -30,7 +30,6 @@ options: - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -44,7 +43,6 @@ options: device. This value applies to either I(cli) or I(nxapi). The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). - required: false default: 0 (use common port) username: description: @@ -53,22 +51,18 @@ options: either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - required: false password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(nxapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - required: false - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). - require: false default: 10 version_added: 2.3 ssh_keyfile: @@ -77,7 +71,6 @@ options: the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - required: false transport: description: - Configures the transport connection to use when connecting to the @@ -89,21 +82,19 @@ options: description: - Configures the I(transport) to use SSL if set to true only when the C(transport=nxapi), otherwise this value is ignored. - required: false - default: no - choices: ['yes', 'no'] + 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. If the transport argument is not nxapi, this value is ignored. - choices: ['yes', 'no'] - default: null + type: bool use_proxy: description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. + type: bool default: 'yes' - choices: ['yes', 'no'] version_added: "2.5" notes: diff --git a/lib/ansible/utils/module_docs_fragments/onyx.py b/lib/ansible/utils/module_docs_fragments/onyx.py index dc7f7bf20a..0cc80cee97 100644 --- a/lib/ansible/utils/module_docs_fragments/onyx.py +++ b/lib/ansible/utils/module_docs_fragments/onyx.py @@ -23,7 +23,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -47,7 +46,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device @@ -68,13 +66,12 @@ options: attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. - default: no - choices: ['yes', 'no'] + type: bool + default: 'no' auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - default: none """ diff --git a/lib/ansible/utils/module_docs_fragments/openswitch.py b/lib/ansible/utils/module_docs_fragments/openswitch.py index bbc912f900..b0dfaec342 100644 --- a/lib/ansible/utils/module_docs_fragments/openswitch.py +++ b/lib/ansible/utils/module_docs_fragments/openswitch.py @@ -36,7 +36,6 @@ options: value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport. - required: false default: 0 (use common port) username: description: @@ -46,7 +45,6 @@ options: transport is used. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - required: false password: description: - Specifies the password to use to authenticate the connection to @@ -54,14 +52,11 @@ options: or I(rest) transports. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - required: false - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. - require: false default: 10 ssh_keyfile: description: @@ -69,7 +64,6 @@ options: the remote device. This argument is only used for the I(cli) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - required: false transport: description: - Configures the transport connection to use when connecting to the @@ -83,16 +77,12 @@ options: - Configures the I(transport) to use SSL if set to true only when the I(transport) argument is configured as rest. If the transport argument is not I(rest), this value is ignored. - required: false - default: yes - choices: ['yes', 'no'] + type: bool + default: 'yes' provider: description: - Convenience method that allows all I(openswitch) arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. - required: false - default: null - """ diff --git a/lib/ansible/utils/module_docs_fragments/postgres.py b/lib/ansible/utils/module_docs_fragments/postgres.py index fee32607b5..5068ea064f 100644 --- a/lib/ansible/utils/module_docs_fragments/postgres.py +++ b/lib/ansible/utils/module_docs_fragments/postgres.py @@ -21,34 +21,25 @@ options: login_user: description: - The username used to authenticate with - required: false default: postgres login_password: description: - The password used to authenticate with - required: false - default: null login_host: description: - Host running the database - required: false - default: null login_unix_socket: description: - Path to a Unix domain socket for local connections - required: false - default: null port: description: - Database port to connect to. - required: false default: 5432 ssl_mode: description: - Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. - See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes. - Default of C(prefer) matches libpq default. - required: false default: prefer choices: [disable, allow, prefer, require, verify-ca, verify-full] version_added: '2.3' @@ -56,8 +47,6 @@ options: description: - Specifies the name of a file containing SSL certificate authority (CA) certificate(s). - If the file exists, the server's certificate will be verified to be signed by one of these authorities. - required: false - default: null version_added: '2.3' notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(postgres) account on the host. diff --git a/lib/ansible/utils/module_docs_fragments/proxysql.py b/lib/ansible/utils/module_docs_fragments/proxysql.py index 033cc1ec7c..e2f9df6aef 100644 --- a/lib/ansible/utils/module_docs_fragments/proxysql.py +++ b/lib/ansible/utils/module_docs_fragments/proxysql.py @@ -10,11 +10,9 @@ options: login_user: description: - The username used to authenticate to ProxySQL admin interface. - default: None login_password: description: - The password used to authenticate to ProxySQL admin interface. - default: None login_host: description: - The host used to connect to ProxySQL admin interface. @@ -39,10 +37,10 @@ options: description: - Save config to sqlite db on disk to persist the configuration. type: bool - default: True + default: 'yes' load_to_runtime: description: - Dynamically load config to runtime memory. type: bool - default: True + default: 'yes' ''' diff --git a/lib/ansible/utils/module_docs_fragments/rackspace.py b/lib/ansible/utils/module_docs_fragments/rackspace.py index d461f0c1a6..1a86e6a51c 100644 --- a/lib/ansible/utils/module_docs_fragments/rackspace.py +++ b/lib/ansible/utils/module_docs_fragments/rackspace.py @@ -30,7 +30,6 @@ options: description: - File to find the Rackspace credentials in. Ignored if I(api_key) and I(username) are provided. - default: null aliases: - creds_file env: @@ -79,7 +78,6 @@ options: description: - File to find the Rackspace credentials in. Ignored if I(api_key) and I(username) are provided. - default: null aliases: - creds_file env: diff --git a/lib/ansible/utils/module_docs_fragments/sros.py b/lib/ansible/utils/module_docs_fragments/sros.py index 318bfddf8a..667e9800eb 100644 --- a/lib/ansible/utils/module_docs_fragments/sros.py +++ b/lib/ansible/utils/module_docs_fragments/sros.py @@ -25,7 +25,6 @@ options: provider: description: - A dict object containing connection details. - default: null suboptions: host: description: @@ -50,7 +49,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/tower.py b/lib/ansible/utils/module_docs_fragments/tower.py index 86700c168d..8e51af57c3 100644 --- a/lib/ansible/utils/module_docs_fragments/tower.py +++ b/lib/ansible/utils/module_docs_fragments/tower.py @@ -25,29 +25,21 @@ options: tower_host: description: - URL to your Tower instance. - required: False - default: null tower_username: description: - Username for your Tower instance. - required: False - default: null tower_password: description: - Password for your Tower instance. - required: False - default: null tower_verify_ssl: description: - Dis/allow insecure connections to Tower. If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - required: False - default: True + type: bool + default: 'yes' tower_config_file: description: - Path to the Tower config file. See notes. - required: False - default: null requirements: diff --git a/lib/ansible/utils/module_docs_fragments/validate.py b/lib/ansible/utils/module_docs_fragments/validate.py index decefe113e..f253c67d19 100644 --- a/lib/ansible/utils/module_docs_fragments/validate.py +++ b/lib/ansible/utils/module_docs_fragments/validate.py @@ -22,10 +22,8 @@ class ModuleDocFragment(object): DOCUMENTATION = ''' options: validate: - required: false description: - The validation command to run before copying into place. The path to the file to validate is passed in via '%s' which must be present as in the example below. The command is passed securely so shell features like expansion and pipes won't work. - default: None ''' diff --git a/lib/ansible/utils/module_docs_fragments/vca.py b/lib/ansible/utils/module_docs_fragments/vca.py index 3500822d24..359f0b80de 100644 --- a/lib/ansible/utils/module_docs_fragments/vca.py +++ b/lib/ansible/utils/module_docs_fragments/vca.py @@ -23,60 +23,44 @@ options: username: description: - The vca username or email address, if not set the environment variable C(VCA_USER) is checked for the username. - required: false - default: None aliases: ['user'] password: description: - The vca password, if not set the environment variable C(VCA_PASS) is checked for the password. - required: false - default: None aliases: ['pass', 'passwd'] org: description: - The org to login to for creating vapp. This option is required when the C(service_type) is I(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" ] state: description: - If the object should be added or removed. - required: false default: present choices: [ "present", "absent" ] verify_certs: description: - If the certificates of the authentication is to be verified. type: bool - default: True + default: 'yes' vdc_name: description: - The name of the vdc where the gateway is located. - required: false - default: None gateway_name: description: - The name of the gateway of the vdc where the rule should be added. - required: false default: gateway """ diff --git a/lib/ansible/utils/module_docs_fragments/vyos.py b/lib/ansible/utils/module_docs_fragments/vyos.py index dd8dadd94e..661c76ebe8 100644 --- a/lib/ansible/utils/module_docs_fragments/vyos.py +++ b/lib/ansible/utils/module_docs_fragments/vyos.py @@ -29,7 +29,6 @@ options: - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - HORIZONTALLINE - A dict object containing connection details. - default: null suboptions: host: description: @@ -54,7 +53,6 @@ options: the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - default: null timeout: description: - Specifies the timeout in seconds for communicating with the network device diff --git a/lib/ansible/utils/module_docs_fragments/zabbix.py b/lib/ansible/utils/module_docs_fragments/zabbix.py index 16176aab7d..f6030bf0e5 100644 --- a/lib/ansible/utils/module_docs_fragments/zabbix.py +++ b/lib/ansible/utils/module_docs_fragments/zabbix.py @@ -38,24 +38,19 @@ options: http_login_user: description: - Basic Auth login - required: false - default: None version_added: "2.1" http_login_password: description: - Basic Auth password - required: false - default: None version_added: "2.1" timeout: description: - The timeout of API request (seconds). default: 10 validate_certs: - required: false description: - If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - default: true - choices: ['true', 'false'] + type: bool + default: 'yes' version_added: "2.5" ''' diff --git a/test/sanity/validate-modules/ignore.txt b/test/sanity/validate-modules/ignore.txt index 441c9d1fdd..579f0bd280 100644 --- a/test/sanity/validate-modules/ignore.txt +++ b/test/sanity/validate-modules/ignore.txt @@ -1,7 +1,5 @@ lib/ansible/modules/cloud/amazon/_ec2_ami_find.py E322 lib/ansible/modules/cloud/amazon/_ec2_ami_find.py E323 -lib/ansible/modules/cloud/amazon/_ec2_ami_find.py E325 -lib/ansible/modules/cloud/amazon/_ec2_ami_find.py E326 lib/ansible/modules/cloud/amazon/aws_acm_facts.py E322 lib/ansible/modules/cloud/amazon/aws_acm_facts.py E323 lib/ansible/modules/cloud/amazon/aws_api_gateway.py E322 @@ -29,7 +27,6 @@ lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py E324 lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py E325 lib/ansible/modules/cloud/amazon/cloudformation.py E324 lib/ansible/modules/cloud/amazon/cloudformation.py E325 -lib/ansible/modules/cloud/amazon/cloudformation.py E326 lib/ansible/modules/cloud/amazon/cloudformation_facts.py E325 lib/ansible/modules/cloud/amazon/cloudfront_distribution.py E324 lib/ansible/modules/cloud/amazon/cloudfront_distribution.py E325 @@ -52,7 +49,6 @@ lib/ansible/modules/cloud/amazon/ec2_ami.py E325 lib/ansible/modules/cloud/amazon/ec2_ami.py E326 lib/ansible/modules/cloud/amazon/ec2_ami_copy.py E324 lib/ansible/modules/cloud/amazon/ec2_ami_copy.py E325 -lib/ansible/modules/cloud/amazon/ec2_ami_copy.py E326 lib/ansible/modules/cloud/amazon/ec2_ami_facts.py E324 lib/ansible/modules/cloud/amazon/ec2_ami_facts.py E325 lib/ansible/modules/cloud/amazon/ec2_ami_facts.py E326 @@ -63,14 +59,11 @@ lib/ansible/modules/cloud/amazon/ec2_customer_gateway_facts.py E324 lib/ansible/modules/cloud/amazon/ec2_eip.py E322 lib/ansible/modules/cloud/amazon/ec2_eip.py E324 lib/ansible/modules/cloud/amazon/ec2_eip.py E325 -lib/ansible/modules/cloud/amazon/ec2_elb.py E324 -lib/ansible/modules/cloud/amazon/ec2_elb.py E325 lib/ansible/modules/cloud/amazon/ec2_elb.py E326 lib/ansible/modules/cloud/amazon/ec2_elb_facts.py E323 lib/ansible/modules/cloud/amazon/ec2_elb_facts.py E324 lib/ansible/modules/cloud/amazon/ec2_elb_lb.py E324 lib/ansible/modules/cloud/amazon/ec2_elb_lb.py E325 -lib/ansible/modules/cloud/amazon/ec2_elb_lb.py E326 lib/ansible/modules/cloud/amazon/ec2_eni.py E324 lib/ansible/modules/cloud/amazon/ec2_eni.py E325 lib/ansible/modules/cloud/amazon/ec2_group.py E322 @@ -90,13 +83,9 @@ lib/ansible/modules/cloud/amazon/ec2_snapshot.py E324 lib/ansible/modules/cloud/amazon/ec2_snapshot.py E325 lib/ansible/modules/cloud/amazon/ec2_snapshot.py E326 lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py E324 -lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py E325 -lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py E326 lib/ansible/modules/cloud/amazon/ec2_vol.py E322 lib/ansible/modules/cloud/amazon/ec2_vol.py E325 lib/ansible/modules/cloud/amazon/ec2_vol.py E326 -lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py E324 -lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py E325 lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py E322 lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py E324 lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option_facts.py E325 @@ -117,7 +106,6 @@ lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py E324 lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py E325 lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py E317 lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py E324 -lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py E325 lib/ansible/modules/cloud/amazon/ec2_vpc_subnet_facts.py E324 lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py E322 lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py E323 @@ -127,8 +115,6 @@ lib/ansible/modules/cloud/amazon/ec2_vpc_vgw_facts.py E324 lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py E324 lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py E325 lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py E326 -lib/ansible/modules/cloud/amazon/ec2_win_password.py E325 -lib/ansible/modules/cloud/amazon/ec2_win_password.py E326 lib/ansible/modules/cloud/amazon/ecs_cluster.py E324 lib/ansible/modules/cloud/amazon/ecs_ecr.py E325 lib/ansible/modules/cloud/amazon/ecs_service.py E324 @@ -137,11 +123,8 @@ lib/ansible/modules/cloud/amazon/ecs_service_facts.py E326 lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py E324 lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py E325 lib/ansible/modules/cloud/amazon/efs.py E324 -lib/ansible/modules/cloud/amazon/efs.py E325 -lib/ansible/modules/cloud/amazon/efs.py E326 lib/ansible/modules/cloud/amazon/efs_facts.py E324 lib/ansible/modules/cloud/amazon/elasticache.py E324 -lib/ansible/modules/cloud/amazon/elasticache.py E325 lib/ansible/modules/cloud/amazon/elasticache.py E326 lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py E324 lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py E326 @@ -150,12 +133,8 @@ lib/ansible/modules/cloud/amazon/elb_application_lb.py E324 lib/ansible/modules/cloud/amazon/elb_application_lb.py E325 lib/ansible/modules/cloud/amazon/elb_application_lb.py E326 lib/ansible/modules/cloud/amazon/elb_classic_lb.py E324 -lib/ansible/modules/cloud/amazon/elb_classic_lb.py E325 -lib/ansible/modules/cloud/amazon/elb_classic_lb.py E326 lib/ansible/modules/cloud/amazon/elb_classic_lb_facts.py E323 lib/ansible/modules/cloud/amazon/elb_classic_lb_facts.py E324 -lib/ansible/modules/cloud/amazon/elb_instance.py E324 -lib/ansible/modules/cloud/amazon/elb_instance.py E325 lib/ansible/modules/cloud/amazon/elb_instance.py E326 lib/ansible/modules/cloud/amazon/elb_target.py E324 lib/ansible/modules/cloud/amazon/elb_target.py E325 @@ -164,7 +143,6 @@ lib/ansible/modules/cloud/amazon/elb_target_group.py E322 lib/ansible/modules/cloud/amazon/elb_target_group.py E324 lib/ansible/modules/cloud/amazon/elb_target_group.py E325 lib/ansible/modules/cloud/amazon/elb_target_group.py E326 -lib/ansible/modules/cloud/amazon/execute_lambda.py E325 lib/ansible/modules/cloud/amazon/iam.py E317 lib/ansible/modules/cloud/amazon/iam.py E324 lib/ansible/modules/cloud/amazon/iam.py E326 @@ -180,7 +158,6 @@ lib/ansible/modules/cloud/amazon/iam_policy.py E325 lib/ansible/modules/cloud/amazon/iam_user.py E324 lib/ansible/modules/cloud/amazon/iam_user.py E325 lib/ansible/modules/cloud/amazon/kinesis_stream.py E317 -lib/ansible/modules/cloud/amazon/kinesis_stream.py E324 lib/ansible/modules/cloud/amazon/kinesis_stream.py E325 lib/ansible/modules/cloud/amazon/kinesis_stream.py E326 lib/ansible/modules/cloud/amazon/lambda.py E323 @@ -189,11 +166,7 @@ lib/ansible/modules/cloud/amazon/lambda_alias.py E317 lib/ansible/modules/cloud/amazon/lambda_alias.py E324 lib/ansible/modules/cloud/amazon/lambda_event.py E317 lib/ansible/modules/cloud/amazon/lambda_event.py E324 -lib/ansible/modules/cloud/amazon/lightsail.py E325 -lib/ansible/modules/cloud/amazon/lightsail.py E326 lib/ansible/modules/cloud/amazon/rds.py E322 -lib/ansible/modules/cloud/amazon/rds.py E325 -lib/ansible/modules/cloud/amazon/rds.py E326 lib/ansible/modules/cloud/amazon/rds_param_group.py E324 lib/ansible/modules/cloud/amazon/rds_param_group.py E325 lib/ansible/modules/cloud/amazon/rds_param_group.py E326 @@ -207,7 +180,6 @@ lib/ansible/modules/cloud/amazon/route53.py E326 lib/ansible/modules/cloud/amazon/route53_health_check.py E324 lib/ansible/modules/cloud/amazon/s3_bucket.py E324 lib/ansible/modules/cloud/amazon/s3_bucket.py E325 -lib/ansible/modules/cloud/amazon/s3_bucket.py E326 lib/ansible/modules/cloud/amazon/s3_lifecycle.py E322 lib/ansible/modules/cloud/amazon/s3_lifecycle.py E324 lib/ansible/modules/cloud/amazon/s3_lifecycle.py E325 @@ -215,25 +187,21 @@ lib/ansible/modules/cloud/amazon/s3_sync.py E322 lib/ansible/modules/cloud/amazon/s3_sync.py E324 lib/ansible/modules/cloud/amazon/s3_sync.py E325 lib/ansible/modules/cloud/amazon/s3_sync.py E326 -lib/ansible/modules/cloud/amazon/sns.py E324 lib/ansible/modules/cloud/amazon/sns_topic.py E325 lib/ansible/modules/cloud/amazon/sts_assume_role.py E317 lib/ansible/modules/cloud/atomic/atomic_container.py E317 lib/ansible/modules/cloud/atomic/atomic_container.py E324 lib/ansible/modules/cloud/atomic/atomic_container.py E326 lib/ansible/modules/cloud/azure/_azure.py E324 -lib/ansible/modules/cloud/azure/_azure.py E325 lib/ansible/modules/cloud/azure/_azure.py E326 lib/ansible/modules/cloud/azure/azure_rm_acs.py E325 lib/ansible/modules/cloud/azure/azure_rm_acs.py E326 -lib/ansible/modules/cloud/azure/azure_rm_availabilityset.py E325 lib/ansible/modules/cloud/azure/azure_rm_availabilityset.py E326 lib/ansible/modules/cloud/azure/azure_rm_availabilityset_facts.py E322 lib/ansible/modules/cloud/azure/azure_rm_availabilityset_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py E324 lib/ansible/modules/cloud/azure/azure_rm_containerinstance.py E326 lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py E324 -lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py E325 lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py E326 lib/ansible/modules/cloud/azure/azure_rm_deployment.py E322 lib/ansible/modules/cloud/azure/azure_rm_deployment.py E324 @@ -247,9 +215,7 @@ lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset_facts.py E322 lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset_facts.py E324 lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset_facts.py E325 lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset_facts.py E326 -lib/ansible/modules/cloud/azure/azure_rm_dnszone.py E325 lib/ansible/modules/cloud/azure/azure_rm_dnszone.py E326 -lib/ansible/modules/cloud/azure/azure_rm_dnszone_facts.py E325 lib/ansible/modules/cloud/azure/azure_rm_dnszone_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_functionapp.py E322 lib/ansible/modules/cloud/azure/azure_rm_functionapp.py E324 @@ -257,17 +223,12 @@ lib/ansible/modules/cloud/azure/azure_rm_functionapp.py E325 lib/ansible/modules/cloud/azure/azure_rm_functionapp.py E326 lib/ansible/modules/cloud/azure/azure_rm_functionapp_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_image.py E324 -lib/ansible/modules/cloud/azure/azure_rm_image.py E325 lib/ansible/modules/cloud/azure/azure_rm_image.py E326 lib/ansible/modules/cloud/azure/azure_rm_keyvault.py E326 -lib/ansible/modules/cloud/azure/azure_rm_keyvaultkey.py E325 lib/ansible/modules/cloud/azure/azure_rm_keyvaultkey.py E326 -lib/ansible/modules/cloud/azure/azure_rm_keyvaultsecret.py E325 lib/ansible/modules/cloud/azure/azure_rm_keyvaultsecret.py E326 -lib/ansible/modules/cloud/azure/azure_rm_loadbalancer.py E325 lib/ansible/modules/cloud/azure/azure_rm_loadbalancer.py E326 lib/ansible/modules/cloud/azure/azure_rm_loadbalancer_facts.py E326 -lib/ansible/modules/cloud/azure/azure_rm_managed_disk.py E325 lib/ansible/modules/cloud/azure/azure_rm_managed_disk.py E326 lib/ansible/modules/cloud/azure/azure_rm_managed_disk_facts.py E322 lib/ansible/modules/cloud/azure/azure_rm_managed_disk_facts.py E324 @@ -279,7 +240,6 @@ lib/ansible/modules/cloud/azure/azure_rm_mysqldatabase.py E326 lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py E322 lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py E324 lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py E326 -lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py E325 lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py E326 lib/ansible/modules/cloud/azure/azure_rm_networkinterface_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_postgresqldatabase.py E322 @@ -289,19 +249,15 @@ lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py E322 lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py E324 lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py E326 lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py E322 -lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py E325 lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py E326 lib/ansible/modules/cloud/azure/azure_rm_publicipaddress_facts.py E326 -lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py E325 lib/ansible/modules/cloud/azure/azure_rm_resourcegroup.py E326 lib/ansible/modules/cloud/azure/azure_rm_resourcegroup_facts.py E326 -lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py E325 lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py E326 lib/ansible/modules/cloud/azure/azure_rm_securitygroup_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_sqldatabase.py E326 lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py E322 lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py E324 -lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py E325 lib/ansible/modules/cloud/azure/azure_rm_sqlserver.py E326 lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py E322 lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py E324 @@ -313,7 +269,6 @@ lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py E325 lib/ansible/modules/cloud/azure/azure_rm_storageaccount.py E326 lib/ansible/modules/cloud/azure/azure_rm_storageaccount_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_storageblob.py E323 -lib/ansible/modules/cloud/azure/azure_rm_storageblob.py E325 lib/ansible/modules/cloud/azure/azure_rm_storageblob.py E326 lib/ansible/modules/cloud/azure/azure_rm_subnet.py E322 lib/ansible/modules/cloud/azure/azure_rm_subnet.py E324 @@ -337,36 +292,23 @@ lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py E324 lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py E325 lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py E326 lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py E322 -lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py E325 lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py E326 lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py E326 lib/ansible/modules/cloud/centurylink/clc_aa_policy.py E326 lib/ansible/modules/cloud/centurylink/clc_alert_policy.py E317 -lib/ansible/modules/cloud/centurylink/clc_alert_policy.py E324 lib/ansible/modules/cloud/centurylink/clc_blueprint_package.py E326 lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py E317 lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py E324 lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py E326 lib/ansible/modules/cloud/centurylink/clc_group.py E325 lib/ansible/modules/cloud/centurylink/clc_group.py E326 -lib/ansible/modules/cloud/centurylink/clc_loadbalancer.py E324 -lib/ansible/modules/cloud/centurylink/clc_modify_server.py E325 -lib/ansible/modules/cloud/centurylink/clc_modify_server.py E326 -lib/ansible/modules/cloud/centurylink/clc_publicip.py E325 -lib/ansible/modules/cloud/centurylink/clc_publicip.py E326 -lib/ansible/modules/cloud/centurylink/clc_server.py E324 -lib/ansible/modules/cloud/centurylink/clc_server.py E325 -lib/ansible/modules/cloud/centurylink/clc_server.py E326 lib/ansible/modules/cloud/centurylink/clc_server_snapshot.py E326 lib/ansible/modules/cloud/cloudscale/cloudscale_server.py E325 -lib/ansible/modules/cloud/cloudstack/cs_account.py E325 -lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py E325 lib/ansible/modules/cloud/cloudstack/cs_cluster.py E326 lib/ansible/modules/cloud/cloudstack/cs_domain.py E325 lib/ansible/modules/cloud/cloudstack/cs_host.py E326 lib/ansible/modules/cloud/cloudstack/cs_instance.py E325 lib/ansible/modules/cloud/cloudstack/cs_instance.py E326 -lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py E325 lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py E325 lib/ansible/modules/cloud/cloudstack/cs_iso.py E323 lib/ansible/modules/cloud/cloudstack/cs_iso.py E325 @@ -376,22 +318,18 @@ lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py E325 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E322 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E324 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E325 -lib/ansible/modules/cloud/cloudstack/cs_network_acl.py E325 lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py E324 -lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py E325 lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py E326 lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E322 lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E325 lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E326 lib/ansible/modules/cloud/cloudstack/cs_portforward.py E325 lib/ansible/modules/cloud/cloudstack/cs_project.py E322 -lib/ansible/modules/cloud/cloudstack/cs_project.py E325 lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py E325 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E322 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E323 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E325 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E326 -lib/ansible/modules/cloud/cloudstack/cs_staticnat.py E325 lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E322 lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E325 lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E326 @@ -407,14 +345,10 @@ lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py E325 lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py E322 lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py E325 lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py E326 -lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py E325 lib/ansible/modules/cloud/cloudstack/cs_zone.py E322 lib/ansible/modules/cloud/cloudstack/cs_zone.py E325 lib/ansible/modules/cloud/cloudstack/cs_zone.py E326 lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E322 -lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E324 -lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E325 -lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E326 lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py E322 lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py E324 lib/ansible/modules/cloud/digital_ocean/digital_ocean_floating_ip.py E325 @@ -440,7 +374,6 @@ lib/ansible/modules/cloud/docker/docker_image_facts.py E325 lib/ansible/modules/cloud/docker/docker_login.py E322 lib/ansible/modules/cloud/docker/docker_login.py E324 lib/ansible/modules/cloud/docker/docker_login.py E325 -lib/ansible/modules/cloud/docker/docker_login.py E326 lib/ansible/modules/cloud/docker/docker_network.py E322 lib/ansible/modules/cloud/docker/docker_network.py E324 lib/ansible/modules/cloud/docker/docker_network.py E325 @@ -458,10 +391,7 @@ lib/ansible/modules/cloud/google/gc_storage.py E322 lib/ansible/modules/cloud/google/gc_storage.py E324 lib/ansible/modules/cloud/google/gc_storage.py E325 lib/ansible/modules/cloud/google/gc_storage.py E326 -lib/ansible/modules/cloud/google/gcdns_record.py E325 -lib/ansible/modules/cloud/google/gcdns_record.py E326 lib/ansible/modules/cloud/google/gce.py E324 -lib/ansible/modules/cloud/google/gce.py E325 lib/ansible/modules/cloud/google/gce.py E326 lib/ansible/modules/cloud/google/gce_eip.py E322 lib/ansible/modules/cloud/google/gce_instance_template.py E322 @@ -479,7 +409,6 @@ lib/ansible/modules/cloud/google/gce_mig.py E325 lib/ansible/modules/cloud/google/gce_net.py E323 lib/ansible/modules/cloud/google/gce_net.py E326 lib/ansible/modules/cloud/google/gce_pd.py E322 -lib/ansible/modules/cloud/google/gce_pd.py E325 lib/ansible/modules/cloud/google/gce_pd.py E326 lib/ansible/modules/cloud/google/gce_snapshot.py E324 lib/ansible/modules/cloud/google/gcp_backend_service.py E322 @@ -504,26 +433,21 @@ lib/ansible/modules/cloud/google/gcpubsub_facts.py E326 lib/ansible/modules/cloud/google/gcspanner.py E322 lib/ansible/modules/cloud/linode/linode.py E322 lib/ansible/modules/cloud/linode/linode.py E324 -lib/ansible/modules/cloud/lxc/lxc_container.py E325 lib/ansible/modules/cloud/lxc/lxc_container.py E326 lib/ansible/modules/cloud/lxd/lxd_container.py E322 lib/ansible/modules/cloud/lxd/lxd_container.py E324 lib/ansible/modules/cloud/lxd/lxd_container.py E325 lib/ansible/modules/cloud/lxd/lxd_profile.py E324 lib/ansible/modules/cloud/misc/helm.py E324 -lib/ansible/modules/cloud/misc/helm.py E325 lib/ansible/modules/cloud/misc/ovirt.py E322 lib/ansible/modules/cloud/misc/ovirt.py E326 lib/ansible/modules/cloud/misc/proxmox.py E324 -lib/ansible/modules/cloud/misc/proxmox.py E325 lib/ansible/modules/cloud/misc/proxmox_kvm.py E322 lib/ansible/modules/cloud/misc/proxmox_kvm.py E324 lib/ansible/modules/cloud/misc/proxmox_kvm.py E325 -lib/ansible/modules/cloud/misc/proxmox_kvm.py E326 lib/ansible/modules/cloud/misc/proxmox_template.py E323 lib/ansible/modules/cloud/misc/rhevm.py E322 lib/ansible/modules/cloud/misc/rhevm.py E324 -lib/ansible/modules/cloud/misc/rhevm.py E325 lib/ansible/modules/cloud/misc/serverless.py E324 lib/ansible/modules/cloud/misc/serverless.py E325 lib/ansible/modules/cloud/misc/terraform.py E324 @@ -549,14 +473,9 @@ lib/ansible/modules/cloud/oneandone/oneandone_private_network.py E326 lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py E324 lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py E325 lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py E326 -lib/ansible/modules/cloud/oneandone/oneandone_server.py E325 lib/ansible/modules/cloud/oneandone/oneandone_server.py E326 lib/ansible/modules/cloud/openstack/os_flavor_facts.py E324 -lib/ansible/modules/cloud/openstack/os_floating_ip.py E324 -lib/ansible/modules/cloud/openstack/os_floating_ip.py E325 -lib/ansible/modules/cloud/openstack/os_group.py E324 lib/ansible/modules/cloud/openstack/os_image.py E324 -lib/ansible/modules/cloud/openstack/os_image.py E325 lib/ansible/modules/cloud/openstack/os_image.py E326 lib/ansible/modules/cloud/openstack/os_ironic.py E322 lib/ansible/modules/cloud/openstack/os_ironic.py E323 @@ -566,53 +485,24 @@ lib/ansible/modules/cloud/openstack/os_ironic.py E326 lib/ansible/modules/cloud/openstack/os_ironic_node.py E322 lib/ansible/modules/cloud/openstack/os_ironic_node.py E324 lib/ansible/modules/cloud/openstack/os_ironic_node.py E326 -lib/ansible/modules/cloud/openstack/os_keypair.py E324 -lib/ansible/modules/cloud/openstack/os_keystone_domain.py E324 -lib/ansible/modules/cloud/openstack/os_keystone_domain.py E325 -lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py E324 lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py E322 lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py E325 lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py E326 -lib/ansible/modules/cloud/openstack/os_keystone_service.py E324 -lib/ansible/modules/cloud/openstack/os_keystone_service.py E325 -lib/ansible/modules/cloud/openstack/os_network.py E324 -lib/ansible/modules/cloud/openstack/os_network.py E325 -lib/ansible/modules/cloud/openstack/os_nova_flavor.py E324 -lib/ansible/modules/cloud/openstack/os_nova_flavor.py E325 -lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py E324 -lib/ansible/modules/cloud/openstack/os_port.py E324 lib/ansible/modules/cloud/openstack/os_port.py E325 -lib/ansible/modules/cloud/openstack/os_project.py E324 -lib/ansible/modules/cloud/openstack/os_project.py E325 -lib/ansible/modules/cloud/openstack/os_project_facts.py E324 lib/ansible/modules/cloud/openstack/os_quota.py E322 lib/ansible/modules/cloud/openstack/os_quota.py E323 lib/ansible/modules/cloud/openstack/os_quota.py E324 lib/ansible/modules/cloud/openstack/os_quota.py E326 -lib/ansible/modules/cloud/openstack/os_recordset.py E324 -lib/ansible/modules/cloud/openstack/os_router.py E324 -lib/ansible/modules/cloud/openstack/os_router.py E325 lib/ansible/modules/cloud/openstack/os_security_group.py E324 -lib/ansible/modules/cloud/openstack/os_security_group_rule.py E324 lib/ansible/modules/cloud/openstack/os_security_group_rule.py E326 lib/ansible/modules/cloud/openstack/os_server.py E322 lib/ansible/modules/cloud/openstack/os_server.py E324 -lib/ansible/modules/cloud/openstack/os_server.py E325 -lib/ansible/modules/cloud/openstack/os_server_facts.py E325 -lib/ansible/modules/cloud/openstack/os_server_volume.py E324 lib/ansible/modules/cloud/openstack/os_stack.py E324 -lib/ansible/modules/cloud/openstack/os_stack.py E325 lib/ansible/modules/cloud/openstack/os_subnet.py E324 -lib/ansible/modules/cloud/openstack/os_subnet.py E325 lib/ansible/modules/cloud/openstack/os_subnet.py E326 lib/ansible/modules/cloud/openstack/os_subnets_facts.py E322 lib/ansible/modules/cloud/openstack/os_subnets_facts.py E323 -lib/ansible/modules/cloud/openstack/os_user.py E324 -lib/ansible/modules/cloud/openstack/os_user.py E325 -lib/ansible/modules/cloud/openstack/os_user_facts.py E324 lib/ansible/modules/cloud/openstack/os_volume.py E322 -lib/ansible/modules/cloud/openstack/os_volume.py E324 -lib/ansible/modules/cloud/openstack/os_zone.py E324 lib/ansible/modules/cloud/openstack/os_zone.py E326 lib/ansible/modules/cloud/ovirt/ovirt_affinity_group.py E324 lib/ansible/modules/cloud/ovirt/ovirt_affinity_group.py E325 @@ -744,7 +634,6 @@ lib/ansible/modules/cloud/packet/packet_device.py E325 lib/ansible/modules/cloud/packet/packet_sshkey.py E322 lib/ansible/modules/cloud/profitbricks/profitbricks.py E322 lib/ansible/modules/cloud/profitbricks/profitbricks.py E324 -lib/ansible/modules/cloud/profitbricks/profitbricks.py E325 lib/ansible/modules/cloud/profitbricks/profitbricks.py E326 lib/ansible/modules/cloud/profitbricks/profitbricks_datacenter.py E325 lib/ansible/modules/cloud/profitbricks/profitbricks_datacenter.py E326 @@ -762,12 +651,9 @@ lib/ansible/modules/cloud/pubnub/pubnub_blocks.py E325 lib/ansible/modules/cloud/rackspace/rax.py E322 lib/ansible/modules/cloud/rackspace/rax.py E324 lib/ansible/modules/cloud/rackspace/rax.py E325 -lib/ansible/modules/cloud/rackspace/rax.py E326 lib/ansible/modules/cloud/rackspace/rax_cbs.py E324 lib/ansible/modules/cloud/rackspace/rax_cbs.py E325 -lib/ansible/modules/cloud/rackspace/rax_cbs.py E326 lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py E325 -lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py E326 lib/ansible/modules/cloud/rackspace/rax_cdb.py E324 lib/ansible/modules/cloud/rackspace/rax_cdb.py E325 lib/ansible/modules/cloud/rackspace/rax_cdb.py E326 @@ -775,7 +661,6 @@ lib/ansible/modules/cloud/rackspace/rax_cdb_database.py E325 lib/ansible/modules/cloud/rackspace/rax_cdb_user.py E325 lib/ansible/modules/cloud/rackspace/rax_clb.py E324 lib/ansible/modules/cloud/rackspace/rax_clb.py E325 -lib/ansible/modules/cloud/rackspace/rax_clb.py E326 lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py E322 lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py E325 lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py E326 @@ -789,7 +674,6 @@ lib/ansible/modules/cloud/rackspace/rax_files.py E326 lib/ansible/modules/cloud/rackspace/rax_files_objects.py E323 lib/ansible/modules/cloud/rackspace/rax_files_objects.py E324 lib/ansible/modules/cloud/rackspace/rax_files_objects.py E325 -lib/ansible/modules/cloud/rackspace/rax_files_objects.py E326 lib/ansible/modules/cloud/rackspace/rax_identity.py E325 lib/ansible/modules/cloud/rackspace/rax_identity.py E326 lib/ansible/modules/cloud/rackspace/rax_keypair.py E325 @@ -811,13 +695,11 @@ lib/ansible/modules/cloud/rackspace/rax_network.py E325 lib/ansible/modules/cloud/rackspace/rax_queue.py E325 lib/ansible/modules/cloud/rackspace/rax_scaling_group.py E324 lib/ansible/modules/cloud/rackspace/rax_scaling_group.py E325 -lib/ansible/modules/cloud/rackspace/rax_scaling_group.py E326 lib/ansible/modules/cloud/rackspace/rax_scaling_policy.py E324 lib/ansible/modules/cloud/rackspace/rax_scaling_policy.py E325 lib/ansible/modules/cloud/smartos/imgadm.py E317 lib/ansible/modules/cloud/smartos/imgadm.py E325 lib/ansible/modules/cloud/smartos/imgadm.py E326 -lib/ansible/modules/cloud/smartos/smartos_image_facts.py E324 lib/ansible/modules/cloud/smartos/vmadm.py E322 lib/ansible/modules/cloud/smartos/vmadm.py E324 lib/ansible/modules/cloud/smartos/vmadm.py E325 @@ -869,7 +751,6 @@ lib/ansible/modules/cloud/vultr/vr_user.py E325 lib/ansible/modules/cloud/vultr/vr_user.py E326 lib/ansible/modules/clustering/consul.py E322 lib/ansible/modules/clustering/consul.py E324 -lib/ansible/modules/clustering/consul.py E325 lib/ansible/modules/clustering/consul_acl.py E325 lib/ansible/modules/clustering/consul_kv.py E322 lib/ansible/modules/clustering/consul_kv.py E324 @@ -885,8 +766,6 @@ lib/ansible/modules/clustering/k8s/k8s_raw.py E321 lib/ansible/modules/clustering/k8s/k8s_scale.py E321 lib/ansible/modules/clustering/openshift/openshift_raw.py E321 lib/ansible/modules/clustering/openshift/openshift_scale.py E321 -lib/ansible/modules/clustering/znode.py E324 -lib/ansible/modules/clustering/znode.py E325 lib/ansible/modules/clustering/znode.py E326 lib/ansible/modules/commands/command.py E322 lib/ansible/modules/commands/command.py E323 @@ -915,41 +794,26 @@ lib/ansible/modules/database/influxdb/influxdb_user.py E325 lib/ansible/modules/database/influxdb/influxdb_user.py E326 lib/ansible/modules/database/influxdb/influxdb_write.py E324 lib/ansible/modules/database/influxdb/influxdb_write.py E325 -lib/ansible/modules/database/misc/elasticsearch_plugin.py E324 -lib/ansible/modules/database/misc/kibana_plugin.py E324 -lib/ansible/modules/database/misc/kibana_plugin.py E325 -lib/ansible/modules/database/misc/kibana_plugin.py E326 lib/ansible/modules/database/misc/riak.py E324 -lib/ansible/modules/database/misc/riak.py E325 -lib/ansible/modules/database/misc/riak.py E326 lib/ansible/modules/database/mongodb/mongodb_parameter.py E317 lib/ansible/modules/database/mongodb/mongodb_parameter.py E323 -lib/ansible/modules/database/mongodb/mongodb_parameter.py E325 lib/ansible/modules/database/mongodb/mongodb_parameter.py E326 lib/ansible/modules/database/mongodb/mongodb_user.py E322 lib/ansible/modules/database/mongodb/mongodb_user.py E324 lib/ansible/modules/database/mongodb/mongodb_user.py E325 lib/ansible/modules/database/mssql/mssql_db.py E324 -lib/ansible/modules/database/mssql/mssql_db.py E325 -lib/ansible/modules/database/mssql/mssql_db.py E326 lib/ansible/modules/database/mysql/mysql_db.py E324 -lib/ansible/modules/database/mysql/mysql_db.py E325 lib/ansible/modules/database/mysql/mysql_replication.py E324 lib/ansible/modules/database/mysql/mysql_replication.py E325 lib/ansible/modules/database/mysql/mysql_replication.py E326 lib/ansible/modules/database/mysql/mysql_user.py E322 -lib/ansible/modules/database/mysql/mysql_user.py E325 -lib/ansible/modules/database/mysql/mysql_user.py E326 lib/ansible/modules/database/postgresql/postgresql_db.py E324 lib/ansible/modules/database/postgresql/postgresql_ext.py E322 lib/ansible/modules/database/postgresql/postgresql_ext.py E324 lib/ansible/modules/database/postgresql/postgresql_lang.py E324 -lib/ansible/modules/database/postgresql/postgresql_lang.py E325 lib/ansible/modules/database/postgresql/postgresql_lang.py E326 lib/ansible/modules/database/postgresql/postgresql_privs.py E322 lib/ansible/modules/database/postgresql/postgresql_privs.py E324 -lib/ansible/modules/database/postgresql/postgresql_privs.py E325 -lib/ansible/modules/database/postgresql/postgresql_privs.py E326 lib/ansible/modules/database/postgresql/postgresql_schema.py E322 lib/ansible/modules/database/postgresql/postgresql_schema.py E324 lib/ansible/modules/database/postgresql/postgresql_user.py E322 @@ -957,22 +821,15 @@ lib/ansible/modules/database/postgresql/postgresql_user.py E324 lib/ansible/modules/database/postgresql/postgresql_user.py E325 lib/ansible/modules/database/postgresql/postgresql_user.py E326 lib/ansible/modules/database/proxysql/proxysql_backend_servers.py E322 -lib/ansible/modules/database/proxysql/proxysql_backend_servers.py E324 lib/ansible/modules/database/proxysql/proxysql_backend_servers.py E325 lib/ansible/modules/database/proxysql/proxysql_global_variables.py E322 -lib/ansible/modules/database/proxysql/proxysql_global_variables.py E324 lib/ansible/modules/database/proxysql/proxysql_manage_config.py E322 -lib/ansible/modules/database/proxysql/proxysql_manage_config.py E324 lib/ansible/modules/database/proxysql/proxysql_mysql_users.py E322 -lib/ansible/modules/database/proxysql/proxysql_mysql_users.py E324 lib/ansible/modules/database/proxysql/proxysql_mysql_users.py E325 lib/ansible/modules/database/proxysql/proxysql_query_rules.py E322 -lib/ansible/modules/database/proxysql/proxysql_query_rules.py E324 lib/ansible/modules/database/proxysql/proxysql_query_rules.py E325 lib/ansible/modules/database/proxysql/proxysql_replication_hostgroups.py E322 -lib/ansible/modules/database/proxysql/proxysql_replication_hostgroups.py E324 lib/ansible/modules/database/proxysql/proxysql_scheduler.py E322 -lib/ansible/modules/database/proxysql/proxysql_scheduler.py E324 lib/ansible/modules/database/proxysql/proxysql_scheduler.py E325 lib/ansible/modules/database/vertica/vertica_configuration.py E324 lib/ansible/modules/database/vertica/vertica_facts.py E324 @@ -994,8 +851,6 @@ lib/ansible/modules/files/copy.py E323 lib/ansible/modules/files/file.py E322 lib/ansible/modules/files/file.py E324 lib/ansible/modules/files/find.py E324 -lib/ansible/modules/files/find.py E325 -lib/ansible/modules/files/find.py E326 lib/ansible/modules/files/ini_file.py E323 lib/ansible/modules/files/lineinfile.py E322 lib/ansible/modules/files/lineinfile.py E323 @@ -1044,13 +899,7 @@ lib/ansible/modules/messaging/rabbitmq_exchange.py E325 lib/ansible/modules/messaging/rabbitmq_exchange.py E326 lib/ansible/modules/messaging/rabbitmq_policy.py E324 lib/ansible/modules/messaging/rabbitmq_queue.py E324 -lib/ansible/modules/messaging/rabbitmq_queue.py E325 -lib/ansible/modules/messaging/rabbitmq_queue.py E326 lib/ansible/modules/messaging/rabbitmq_user.py E324 -lib/ansible/modules/messaging/rabbitmq_user.py E325 -lib/ansible/modules/messaging/rabbitmq_user.py E326 -lib/ansible/modules/messaging/rabbitmq_vhost.py E325 -lib/ansible/modules/messaging/rabbitmq_vhost.py E326 lib/ansible/modules/monitoring/airbrake_deployment.py E324 lib/ansible/modules/monitoring/airbrake_deployment.py E325 lib/ansible/modules/monitoring/airbrake_deployment.py E326 @@ -1059,69 +908,35 @@ lib/ansible/modules/monitoring/bigpanda.py E324 lib/ansible/modules/monitoring/bigpanda.py E325 lib/ansible/modules/monitoring/bigpanda.py E326 lib/ansible/modules/monitoring/datadog_event.py E324 -lib/ansible/modules/monitoring/datadog_event.py E325 -lib/ansible/modules/monitoring/datadog_event.py E326 lib/ansible/modules/monitoring/datadog_monitor.py E324 lib/ansible/modules/monitoring/datadog_monitor.py E325 lib/ansible/modules/monitoring/datadog_monitor.py E326 lib/ansible/modules/monitoring/grafana_dashboard.py E325 lib/ansible/modules/monitoring/grafana_datasource.py E324 lib/ansible/modules/monitoring/grafana_datasource.py E325 -lib/ansible/modules/monitoring/honeybadger_deployment.py E325 -lib/ansible/modules/monitoring/honeybadger_deployment.py E326 lib/ansible/modules/monitoring/icinga2_host.py E322 lib/ansible/modules/monitoring/icinga2_host.py E324 lib/ansible/modules/monitoring/logentries.py E322 lib/ansible/modules/monitoring/logentries.py E326 lib/ansible/modules/monitoring/logicmonitor.py E317 lib/ansible/modules/monitoring/logicmonitor.py E324 -lib/ansible/modules/monitoring/logicmonitor.py E325 lib/ansible/modules/monitoring/logicmonitor.py E326 lib/ansible/modules/monitoring/logicmonitor_facts.py E317 lib/ansible/modules/monitoring/logicmonitor_facts.py E324 -lib/ansible/modules/monitoring/logstash_plugin.py E324 lib/ansible/modules/monitoring/nagios.py E317 lib/ansible/modules/monitoring/nagios.py E324 lib/ansible/modules/monitoring/newrelic_deployment.py E325 lib/ansible/modules/monitoring/newrelic_deployment.py E326 lib/ansible/modules/monitoring/pagerduty.py E324 -lib/ansible/modules/monitoring/pagerduty.py E325 -lib/ansible/modules/monitoring/pagerduty.py E326 lib/ansible/modules/monitoring/pingdom.py E326 lib/ansible/modules/monitoring/rollbar_deployment.py E325 lib/ansible/modules/monitoring/rollbar_deployment.py E326 -lib/ansible/modules/monitoring/sensu_check.py E325 -lib/ansible/modules/monitoring/sensu_check.py E326 -lib/ansible/modules/monitoring/sensu_client.py E325 -lib/ansible/modules/monitoring/sensu_client.py E326 -lib/ansible/modules/monitoring/sensu_handler.py E325 lib/ansible/modules/monitoring/sensu_handler.py E326 lib/ansible/modules/monitoring/sensu_subscription.py E325 lib/ansible/modules/monitoring/sensu_subscription.py E326 -lib/ansible/modules/monitoring/statusio_maintenance.py E324 -lib/ansible/modules/monitoring/statusio_maintenance.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_group.py E324 -lib/ansible/modules/monitoring/zabbix/zabbix_group.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_group.py E326 -lib/ansible/modules/monitoring/zabbix/zabbix_host.py E324 -lib/ansible/modules/monitoring/zabbix/zabbix_host.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_host.py E326 -lib/ansible/modules/monitoring/zabbix/zabbix_hostmacro.py E324 lib/ansible/modules/monitoring/zabbix/zabbix_hostmacro.py E325 lib/ansible/modules/monitoring/zabbix/zabbix_hostmacro.py E326 lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py E317 -lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py E324 -lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_maintenance.py E326 -lib/ansible/modules/monitoring/zabbix/zabbix_proxy.py E324 -lib/ansible/modules/monitoring/zabbix/zabbix_proxy.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_proxy.py E326 -lib/ansible/modules/monitoring/zabbix/zabbix_screen.py E324 -lib/ansible/modules/monitoring/zabbix/zabbix_screen.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_screen.py E326 -lib/ansible/modules/monitoring/zabbix/zabbix_template.py E324 -lib/ansible/modules/monitoring/zabbix/zabbix_template.py E325 -lib/ansible/modules/monitoring/zabbix/zabbix_template.py E326 lib/ansible/modules/net_tools/basics/get_url.py E322 lib/ansible/modules/net_tools/basics/get_url.py E323 lib/ansible/modules/net_tools/basics/get_url.py E324 @@ -1137,8 +952,6 @@ lib/ansible/modules/net_tools/cloudflare_dns.py E325 lib/ansible/modules/net_tools/dnsimple.py E324 lib/ansible/modules/net_tools/dnsimple.py E325 lib/ansible/modules/net_tools/dnsmadeeasy.py E324 -lib/ansible/modules/net_tools/dnsmadeeasy.py E325 -lib/ansible/modules/net_tools/dnsmadeeasy.py E326 lib/ansible/modules/net_tools/haproxy.py E317 lib/ansible/modules/net_tools/haproxy.py E324 lib/ansible/modules/net_tools/haproxy.py E325 @@ -1147,31 +960,17 @@ lib/ansible/modules/net_tools/ipify_facts.py E324 lib/ansible/modules/net_tools/ipify_facts.py E325 lib/ansible/modules/net_tools/ldap/ldap_attr.py E322 lib/ansible/modules/net_tools/ldap/ldap_attr.py E324 -lib/ansible/modules/net_tools/ldap/ldap_attr.py E325 -lib/ansible/modules/net_tools/ldap/ldap_attr.py E326 lib/ansible/modules/net_tools/ldap/ldap_entry.py E324 -lib/ansible/modules/net_tools/ldap/ldap_entry.py E325 -lib/ansible/modules/net_tools/ldap/ldap_entry.py E326 lib/ansible/modules/net_tools/nmcli.py E324 -lib/ansible/modules/net_tools/nsupdate.py E324 lib/ansible/modules/net_tools/omapi_host.py E317 lib/ansible/modules/net_tools/omapi_host.py E322 -lib/ansible/modules/net_tools/omapi_host.py E324 -lib/ansible/modules/net_tools/omapi_host.py E325 lib/ansible/modules/net_tools/snmp_facts.py E322 lib/ansible/modules/net_tools/snmp_facts.py E324 lib/ansible/modules/network/a10/a10_server.py E324 -lib/ansible/modules/network/a10/a10_server.py E325 -lib/ansible/modules/network/a10/a10_server.py E326 lib/ansible/modules/network/a10/a10_server_axapi3.py E324 -lib/ansible/modules/network/a10/a10_server_axapi3.py E325 lib/ansible/modules/network/a10/a10_server_axapi3.py E326 lib/ansible/modules/network/a10/a10_service_group.py E324 -lib/ansible/modules/network/a10/a10_service_group.py E325 -lib/ansible/modules/network/a10/a10_service_group.py E326 lib/ansible/modules/network/a10/a10_virtual_server.py E324 -lib/ansible/modules/network/a10/a10_virtual_server.py E325 -lib/ansible/modules/network/a10/a10_virtual_server.py E326 lib/ansible/modules/network/aci/aci_ap.py E326 lib/ansible/modules/network/aci/aci_bd.py E326 lib/ansible/modules/network/aci/aci_bd_subnet.py E326 @@ -1210,11 +1009,6 @@ lib/ansible/modules/network/aos/_aos_device.py E324 lib/ansible/modules/network/aos/_aos_device.py E325 lib/ansible/modules/network/aos/_aos_device.py E326 lib/ansible/modules/network/aos/_aos_login.py E324 -lib/ansible/modules/network/aruba/aruba_config.py E325 -lib/ansible/modules/network/asa/asa_acl.py E325 -lib/ansible/modules/network/asa/asa_acl.py E326 -lib/ansible/modules/network/asa/asa_config.py E325 -lib/ansible/modules/network/asa/asa_config.py E326 lib/ansible/modules/network/bigswitch/bcf_switch.py E325 lib/ansible/modules/network/bigswitch/bcf_switch.py E326 lib/ansible/modules/network/bigswitch/bigmon_chain.py E325 @@ -1225,20 +1019,11 @@ lib/ansible/modules/network/bigswitch/bigmon_policy.py E326 lib/ansible/modules/network/citrix/_netscaler.py E324 lib/ansible/modules/network/cloudengine/ce_aaa_server.py E322 lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py E322 -lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py E325 -lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py E326 lib/ansible/modules/network/cloudengine/ce_acl.py E322 -lib/ansible/modules/network/cloudengine/ce_acl.py E325 -lib/ansible/modules/network/cloudengine/ce_acl.py E326 lib/ansible/modules/network/cloudengine/ce_acl_advance.py E322 -lib/ansible/modules/network/cloudengine/ce_acl_advance.py E325 -lib/ansible/modules/network/cloudengine/ce_acl_advance.py E326 lib/ansible/modules/network/cloudengine/ce_acl_interface.py E322 lib/ansible/modules/network/cloudengine/ce_bfd_global.py E322 lib/ansible/modules/network/cloudengine/ce_bfd_session.py E322 -lib/ansible/modules/network/cloudengine/ce_bfd_session.py E325 -lib/ansible/modules/network/cloudengine/ce_bfd_view.py E322 -lib/ansible/modules/network/cloudengine/ce_bfd_view.py E325 lib/ansible/modules/network/cloudengine/ce_bgp.py E322 lib/ansible/modules/network/cloudengine/ce_bgp_af.py E322 lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py E322 @@ -1254,7 +1039,6 @@ lib/ansible/modules/network/cloudengine/ce_dldp.py E322 lib/ansible/modules/network/cloudengine/ce_dldp.py E323 lib/ansible/modules/network/cloudengine/ce_dldp_interface.py E322 lib/ansible/modules/network/cloudengine/ce_eth_trunk.py E322 -lib/ansible/modules/network/cloudengine/ce_eth_trunk.py E325 lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py E322 lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py E322 lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py E322 @@ -1264,14 +1048,11 @@ lib/ansible/modules/network/cloudengine/ce_facts.py E324 lib/ansible/modules/network/cloudengine/ce_file_copy.py E322 lib/ansible/modules/network/cloudengine/ce_info_center_debug.py E322 lib/ansible/modules/network/cloudengine/ce_info_center_global.py E322 -lib/ansible/modules/network/cloudengine/ce_info_center_global.py E325 lib/ansible/modules/network/cloudengine/ce_info_center_log.py E322 lib/ansible/modules/network/cloudengine/ce_info_center_trap.py E322 lib/ansible/modules/network/cloudengine/ce_interface.py E322 -lib/ansible/modules/network/cloudengine/ce_interface.py E325 lib/ansible/modules/network/cloudengine/ce_interface.py E326 lib/ansible/modules/network/cloudengine/ce_interface_ospf.py E322 -lib/ansible/modules/network/cloudengine/ce_interface_ospf.py E325 lib/ansible/modules/network/cloudengine/ce_ip_interface.py E322 lib/ansible/modules/network/cloudengine/ce_link_status.py E322 lib/ansible/modules/network/cloudengine/ce_mlag_config.py E322 @@ -1287,7 +1068,6 @@ lib/ansible/modules/network/cloudengine/ce_ntp.py E322 lib/ansible/modules/network/cloudengine/ce_ntp_auth.py E322 lib/ansible/modules/network/cloudengine/ce_ospf.py E322 lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py E322 -lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py E325 lib/ansible/modules/network/cloudengine/ce_reboot.py E317 lib/ansible/modules/network/cloudengine/ce_reboot.py E322 lib/ansible/modules/network/cloudengine/ce_rollback.py E322 @@ -1311,17 +1091,13 @@ lib/ansible/modules/network/cloudengine/ce_switchport.py E322 lib/ansible/modules/network/cloudengine/ce_vlan.py E322 lib/ansible/modules/network/cloudengine/ce_vrf.py E322 lib/ansible/modules/network/cloudengine/ce_vrf_af.py E322 -lib/ansible/modules/network/cloudengine/ce_vrf_af.py E325 -lib/ansible/modules/network/cloudengine/ce_vrf_af.py E326 lib/ansible/modules/network/cloudengine/ce_vrf_interface.py E322 lib/ansible/modules/network/cloudengine/ce_vrrp.py E322 -lib/ansible/modules/network/cloudengine/ce_vrrp.py E325 lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py E322 lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py E322 lib/ansible/modules/network/cloudengine/ce_vxlan_global.py E322 lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py E322 lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py E322 -lib/ansible/modules/network/cloudvision/cv_server_provision.py E324 lib/ansible/modules/network/cnos/cnos_backup.py E322 lib/ansible/modules/network/cnos/cnos_backup.py E323 lib/ansible/modules/network/cnos/cnos_backup.py E326 @@ -1344,26 +1120,11 @@ lib/ansible/modules/network/cnos/cnos_template.py E326 lib/ansible/modules/network/cnos/cnos_vlag.py E326 lib/ansible/modules/network/cnos/cnos_vlan.py E326 lib/ansible/modules/network/cumulus/nclu.py E325 -lib/ansible/modules/network/dellos10/dellos10_config.py E325 -lib/ansible/modules/network/dellos10/dellos10_config.py E326 -lib/ansible/modules/network/dellos10/dellos10_facts.py E324 -lib/ansible/modules/network/dellos6/dellos6_config.py E325 -lib/ansible/modules/network/dellos6/dellos6_config.py E326 -lib/ansible/modules/network/dellos6/dellos6_facts.py E324 -lib/ansible/modules/network/dellos9/dellos9_config.py E325 -lib/ansible/modules/network/dellos9/dellos9_config.py E326 -lib/ansible/modules/network/dellos9/dellos9_facts.py E324 -lib/ansible/modules/network/edgeos/edgeos_config.py E325 -lib/ansible/modules/network/edgeos/edgeos_config.py E326 lib/ansible/modules/network/edgeos/edgeos_facts.py E324 lib/ansible/modules/network/enos/enos_command.py E323 lib/ansible/modules/network/enos/enos_config.py E323 -lib/ansible/modules/network/enos/enos_config.py E325 -lib/ansible/modules/network/enos/enos_config.py E326 lib/ansible/modules/network/enos/enos_facts.py E323 lib/ansible/modules/network/enos/enos_facts.py E324 -lib/ansible/modules/network/eos/eos_eapi.py E325 -lib/ansible/modules/network/eos/eos_eapi.py E326 lib/ansible/modules/network/eos/eos_facts.py E324 lib/ansible/modules/network/eos/eos_interface.py E325 lib/ansible/modules/network/eos/eos_l2_interface.py E326 @@ -1386,7 +1147,6 @@ lib/ansible/modules/network/f5/bigip_device_group.py E324 lib/ansible/modules/network/f5/bigip_device_httpd.py E326 lib/ansible/modules/network/f5/bigip_device_sshd.py E326 lib/ansible/modules/network/f5/bigip_facts.py E324 -lib/ansible/modules/network/f5/bigip_facts.py E325 lib/ansible/modules/network/f5/bigip_facts.py E326 lib/ansible/modules/network/f5/bigip_gtm_facts.py E326 lib/ansible/modules/network/f5/bigip_gtm_pool.py E324 @@ -1450,19 +1210,13 @@ lib/ansible/modules/network/ios/ios_logging.py E324 lib/ansible/modules/network/ios/ios_vlan.py E325 lib/ansible/modules/network/ios/ios_vrf.py E325 lib/ansible/modules/network/iosxr/iosxr_command.py E322 -lib/ansible/modules/network/iosxr/iosxr_config.py E325 -lib/ansible/modules/network/iosxr/iosxr_config.py E326 lib/ansible/modules/network/iosxr/iosxr_facts.py E324 lib/ansible/modules/network/iosxr/iosxr_logging.py E324 lib/ansible/modules/network/iosxr/iosxr_logging.py E326 lib/ansible/modules/network/iosxr/iosxr_system.py E324 lib/ansible/modules/network/ironware/ironware_command.py E323 lib/ansible/modules/network/ironware/ironware_config.py E323 -lib/ansible/modules/network/ironware/ironware_config.py E325 -lib/ansible/modules/network/ironware/ironware_config.py E326 lib/ansible/modules/network/ironware/ironware_facts.py E323 -lib/ansible/modules/network/junos/junos_banner.py E325 -lib/ansible/modules/network/junos/junos_banner.py E326 lib/ansible/modules/network/junos/junos_config.py E324 lib/ansible/modules/network/junos/junos_config.py E325 lib/ansible/modules/network/junos/junos_config.py E326 @@ -1484,19 +1238,13 @@ lib/ansible/modules/network/junos/junos_lldp_interface.py E326 lib/ansible/modules/network/junos/junos_logging.py E322 lib/ansible/modules/network/junos/junos_logging.py E325 lib/ansible/modules/network/junos/junos_logging.py E326 -lib/ansible/modules/network/junos/junos_package.py E325 -lib/ansible/modules/network/junos/junos_package.py E326 lib/ansible/modules/network/junos/junos_rpc.py E326 -lib/ansible/modules/network/junos/junos_scp.py E325 -lib/ansible/modules/network/junos/junos_scp.py E326 lib/ansible/modules/network/junos/junos_static_route.py E322 lib/ansible/modules/network/junos/junos_static_route.py E324 lib/ansible/modules/network/junos/junos_static_route.py E325 lib/ansible/modules/network/junos/junos_static_route.py E326 lib/ansible/modules/network/junos/junos_system.py E325 lib/ansible/modules/network/junos/junos_system.py E326 -lib/ansible/modules/network/junos/junos_user.py E325 -lib/ansible/modules/network/junos/junos_user.py E326 lib/ansible/modules/network/junos/junos_vlan.py E325 lib/ansible/modules/network/junos/junos_vlan.py E326 lib/ansible/modules/network/junos/junos_vrf.py E324 @@ -1552,18 +1300,12 @@ lib/ansible/modules/network/netvisor/pn_vrouterlbif.py E324 lib/ansible/modules/network/nso/nso_action.py E324 lib/ansible/modules/network/nso/nso_action.py E325 lib/ansible/modules/network/nxos/_nxos_ip_interface.py E324 -lib/ansible/modules/network/nxos/_nxos_ip_interface.py E325 lib/ansible/modules/network/nxos/_nxos_portchannel.py E324 lib/ansible/modules/network/nxos/nxos_aaa_server.py E326 lib/ansible/modules/network/nxos/nxos_acl.py E326 lib/ansible/modules/network/nxos/nxos_bgp.py E324 -lib/ansible/modules/network/nxos/nxos_bgp.py E325 lib/ansible/modules/network/nxos/nxos_bgp.py E326 lib/ansible/modules/network/nxos/nxos_bgp_af.py E324 -lib/ansible/modules/network/nxos/nxos_bgp_af.py E325 -lib/ansible/modules/network/nxos/nxos_bgp_af.py E326 -lib/ansible/modules/network/nxos/nxos_bgp_neighbor.py E325 -lib/ansible/modules/network/nxos/nxos_bgp_neighbor.py E326 lib/ansible/modules/network/nxos/nxos_bgp_neighbor_af.py E325 lib/ansible/modules/network/nxos/nxos_bgp_neighbor_af.py E326 lib/ansible/modules/network/nxos/nxos_command.py E326 @@ -1571,64 +1313,25 @@ lib/ansible/modules/network/nxos/nxos_evpn_global.py E325 lib/ansible/modules/network/nxos/nxos_evpn_global.py E326 lib/ansible/modules/network/nxos/nxos_facts.py E324 lib/ansible/modules/network/nxos/nxos_file_copy.py E324 -lib/ansible/modules/network/nxos/nxos_gir.py E325 lib/ansible/modules/network/nxos/nxos_gir.py E326 lib/ansible/modules/network/nxos/nxos_hsrp.py E324 lib/ansible/modules/network/nxos/nxos_igmp.py E324 -lib/ansible/modules/network/nxos/nxos_igmp.py E325 -lib/ansible/modules/network/nxos/nxos_igmp.py E326 lib/ansible/modules/network/nxos/nxos_igmp_interface.py E324 -lib/ansible/modules/network/nxos/nxos_igmp_interface.py E325 lib/ansible/modules/network/nxos/nxos_igmp_interface.py E326 lib/ansible/modules/network/nxos/nxos_igmp_snooping.py E325 -lib/ansible/modules/network/nxos/nxos_igmp_snooping.py E326 -lib/ansible/modules/network/nxos/nxos_interface.py E325 -lib/ansible/modules/network/nxos/nxos_interface.py E326 -lib/ansible/modules/network/nxos/nxos_interface_ospf.py E325 -lib/ansible/modules/network/nxos/nxos_interface_ospf.py E326 -lib/ansible/modules/network/nxos/nxos_linkagg.py E324 -lib/ansible/modules/network/nxos/nxos_linkagg.py E325 -lib/ansible/modules/network/nxos/nxos_linkagg.py E326 lib/ansible/modules/network/nxos/nxos_lldp.py E326 lib/ansible/modules/network/nxos/nxos_logging.py E325 -lib/ansible/modules/network/nxos/nxos_ntp_auth.py E324 lib/ansible/modules/network/nxos/nxos_ntp_options.py E324 -lib/ansible/modules/network/nxos/nxos_ntp_options.py E325 -lib/ansible/modules/network/nxos/nxos_ntp_options.py E326 lib/ansible/modules/network/nxos/nxos_nxapi.py E325 lib/ansible/modules/network/nxos/nxos_nxapi.py E326 -lib/ansible/modules/network/nxos/nxos_ospf_vrf.py E325 -lib/ansible/modules/network/nxos/nxos_ospf_vrf.py E326 -lib/ansible/modules/network/nxos/nxos_pim_interface.py E325 lib/ansible/modules/network/nxos/nxos_pim_interface.py E326 -lib/ansible/modules/network/nxos/nxos_pim_rp_address.py E325 lib/ansible/modules/network/nxos/nxos_pim_rp_address.py E326 lib/ansible/modules/network/nxos/nxos_reboot.py E325 lib/ansible/modules/network/nxos/nxos_smu.py E324 -lib/ansible/modules/network/nxos/nxos_snapshot.py E325 -lib/ansible/modules/network/nxos/nxos_snapshot.py E326 -lib/ansible/modules/network/nxos/nxos_snmp_user.py E325 -lib/ansible/modules/network/nxos/nxos_snmp_user.py E326 lib/ansible/modules/network/nxos/nxos_static_route.py E324 lib/ansible/modules/network/nxos/nxos_system.py E325 -lib/ansible/modules/network/nxos/nxos_udld.py E325 -lib/ansible/modules/network/nxos/nxos_udld.py E326 -lib/ansible/modules/network/nxos/nxos_user.py E325 -lib/ansible/modules/network/nxos/nxos_vlan.py E325 lib/ansible/modules/network/nxos/nxos_vpc.py E324 -lib/ansible/modules/network/nxos/nxos_vpc.py E325 -lib/ansible/modules/network/nxos/nxos_vpc.py E326 -lib/ansible/modules/network/nxos/nxos_vpc_interface.py E324 lib/ansible/modules/network/nxos/nxos_vpc_interface.py E325 -lib/ansible/modules/network/nxos/nxos_vrf.py E325 -lib/ansible/modules/network/nxos/nxos_vrf_af.py E325 -lib/ansible/modules/network/nxos/nxos_vrf_af.py E326 -lib/ansible/modules/network/nxos/nxos_vrrp.py E325 -lib/ansible/modules/network/nxos/nxos_vrrp.py E326 -lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py E325 -lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py E326 -lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py E325 -lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py E326 lib/ansible/modules/network/onyx/onyx_command.py E323 lib/ansible/modules/network/onyx/onyx_config.py E323 lib/ansible/modules/network/onyx/onyx_config.py E325 @@ -1643,41 +1346,29 @@ lib/ansible/modules/network/onyx/onyx_vlan.py E325 lib/ansible/modules/network/ordnance/ordnance_config.py E322 lib/ansible/modules/network/ordnance/ordnance_config.py E324 lib/ansible/modules/network/ordnance/ordnance_config.py E325 -lib/ansible/modules/network/ordnance/ordnance_config.py E326 lib/ansible/modules/network/ordnance/ordnance_facts.py E322 lib/ansible/modules/network/ordnance/ordnance_facts.py E324 lib/ansible/modules/network/ordnance/ordnance_facts.py E325 -lib/ansible/modules/network/ovs/openvswitch_bridge.py E324 lib/ansible/modules/network/ovs/openvswitch_bridge.py E326 lib/ansible/modules/network/ovs/openvswitch_port.py E324 lib/ansible/modules/network/panos/_panos_nat_policy.py E324 -lib/ansible/modules/network/panos/_panos_nat_policy.py E325 lib/ansible/modules/network/panos/_panos_security_policy.py E322 lib/ansible/modules/network/panos/_panos_security_policy.py E324 lib/ansible/modules/network/panos/_panos_security_policy.py E325 -lib/ansible/modules/network/panos/panos_admin.py E325 lib/ansible/modules/network/panos/panos_check.py E324 -lib/ansible/modules/network/panos/panos_commit.py E325 -lib/ansible/modules/network/panos/panos_dag.py E325 lib/ansible/modules/network/panos/panos_dag_tags.py E325 lib/ansible/modules/network/panos/panos_interface.py E325 lib/ansible/modules/network/panos/panos_lic.py E325 -lib/ansible/modules/network/panos/panos_loadcfg.py E325 lib/ansible/modules/network/panos/panos_match_rule.py E326 -lib/ansible/modules/network/panos/panos_mgtconfig.py E325 lib/ansible/modules/network/panos/panos_nat_rule.py E322 lib/ansible/modules/network/panos/panos_nat_rule.py E324 -lib/ansible/modules/network/panos/panos_nat_rule.py E325 lib/ansible/modules/network/panos/panos_nat_rule.py E326 lib/ansible/modules/network/panos/panos_object.py E324 lib/ansible/modules/network/panos/panos_object.py E326 -lib/ansible/modules/network/panos/panos_pg.py E325 -lib/ansible/modules/network/panos/panos_query_rules.py E324 lib/ansible/modules/network/panos/panos_query_rules.py E326 lib/ansible/modules/network/panos/panos_sag.py E322 lib/ansible/modules/network/panos/panos_sag.py E323 lib/ansible/modules/network/panos/panos_sag.py E324 -lib/ansible/modules/network/panos/panos_sag.py E325 lib/ansible/modules/network/panos/panos_sag.py E326 lib/ansible/modules/network/panos/panos_security_rule.py E322 lib/ansible/modules/network/panos/panos_security_rule.py E324 @@ -1687,10 +1378,7 @@ lib/ansible/modules/network/radware/vdirect_commit.py E321 lib/ansible/modules/network/radware/vdirect_file.py E321 lib/ansible/modules/network/radware/vdirect_runnable.py E321 lib/ansible/modules/network/sros/sros_config.py E323 -lib/ansible/modules/network/sros/sros_config.py E325 lib/ansible/modules/network/sros/sros_config.py E326 -lib/ansible/modules/network/vyos/vyos_config.py E325 -lib/ansible/modules/network/vyos/vyos_config.py E326 lib/ansible/modules/network/vyos/vyos_facts.py E324 lib/ansible/modules/network/vyos/vyos_interface.py E324 lib/ansible/modules/network/vyos/vyos_interface.py E325 @@ -1709,50 +1397,31 @@ lib/ansible/modules/notification/grove.py E326 lib/ansible/modules/notification/hall.py E324 lib/ansible/modules/notification/hipchat.py E322 lib/ansible/modules/notification/hipchat.py E324 -lib/ansible/modules/notification/hipchat.py E325 -lib/ansible/modules/notification/hipchat.py E326 lib/ansible/modules/notification/irc.py E322 lib/ansible/modules/notification/irc.py E324 -lib/ansible/modules/notification/irc.py E325 lib/ansible/modules/notification/irc.py E326 lib/ansible/modules/notification/mail.py E322 lib/ansible/modules/notification/mail.py E324 lib/ansible/modules/notification/mattermost.py E325 lib/ansible/modules/notification/mattermost.py E326 lib/ansible/modules/notification/mqtt.py E324 -lib/ansible/modules/notification/mqtt.py E325 lib/ansible/modules/notification/nexmo.py E326 lib/ansible/modules/notification/pushbullet.py E322 lib/ansible/modules/notification/pushover.py E324 lib/ansible/modules/notification/pushover.py E326 lib/ansible/modules/notification/rocketchat.py E317 -lib/ansible/modules/notification/rocketchat.py E324 -lib/ansible/modules/notification/rocketchat.py E325 -lib/ansible/modules/notification/rocketchat.py E326 lib/ansible/modules/notification/sendgrid.py E322 -lib/ansible/modules/notification/sendgrid.py E325 lib/ansible/modules/notification/slack.py E324 -lib/ansible/modules/notification/slack.py E325 -lib/ansible/modules/notification/slack.py E326 lib/ansible/modules/notification/snow_record.py E317 -lib/ansible/modules/packaging/language/bower.py E325 -lib/ansible/modules/packaging/language/bower.py E326 lib/ansible/modules/packaging/language/bundler.py E324 -lib/ansible/modules/packaging/language/bundler.py E325 -lib/ansible/modules/packaging/language/bundler.py E326 lib/ansible/modules/packaging/language/composer.py E324 lib/ansible/modules/packaging/language/composer.py E325 lib/ansible/modules/packaging/language/composer.py E326 lib/ansible/modules/packaging/language/cpanm.py E324 -lib/ansible/modules/packaging/language/cpanm.py E325 lib/ansible/modules/packaging/language/easy_install.py E324 -lib/ansible/modules/packaging/language/easy_install.py E325 -lib/ansible/modules/packaging/language/easy_install.py E326 lib/ansible/modules/packaging/language/gem.py E325 lib/ansible/modules/packaging/language/gem.py E326 lib/ansible/modules/packaging/language/maven_artifact.py E324 -lib/ansible/modules/packaging/language/maven_artifact.py E325 -lib/ansible/modules/packaging/language/maven_artifact.py E326 lib/ansible/modules/packaging/language/npm.py E325 lib/ansible/modules/packaging/language/npm.py E326 lib/ansible/modules/packaging/language/pear.py E322 @@ -1760,7 +1429,6 @@ lib/ansible/modules/packaging/language/pear.py E326 lib/ansible/modules/packaging/language/pip.py E322 lib/ansible/modules/packaging/language/pip.py E324 lib/ansible/modules/packaging/language/pip.py E325 -lib/ansible/modules/packaging/os/apk.py E325 lib/ansible/modules/packaging/os/apk.py E326 lib/ansible/modules/packaging/os/apt.py E322 lib/ansible/modules/packaging/os/apt.py E326 @@ -1773,15 +1441,10 @@ lib/ansible/modules/packaging/os/apt_rpm.py E324 lib/ansible/modules/packaging/os/apt_rpm.py E326 lib/ansible/modules/packaging/os/dnf.py E322 lib/ansible/modules/packaging/os/dnf.py E324 -lib/ansible/modules/packaging/os/dnf.py E325 lib/ansible/modules/packaging/os/dnf.py E326 -lib/ansible/modules/packaging/os/homebrew.py E325 lib/ansible/modules/packaging/os/homebrew.py E326 -lib/ansible/modules/packaging/os/homebrew_cask.py E325 lib/ansible/modules/packaging/os/homebrew_cask.py E326 lib/ansible/modules/packaging/os/layman.py E322 -lib/ansible/modules/packaging/os/layman.py E325 -lib/ansible/modules/packaging/os/layman.py E326 lib/ansible/modules/packaging/os/macports.py E322 lib/ansible/modules/packaging/os/macports.py E325 lib/ansible/modules/packaging/os/macports.py E326 @@ -1793,11 +1456,7 @@ lib/ansible/modules/packaging/os/opkg.py E326 lib/ansible/modules/packaging/os/package_facts.py E326 lib/ansible/modules/packaging/os/pacman.py E326 lib/ansible/modules/packaging/os/pkg5.py E326 -lib/ansible/modules/packaging/os/pkg5_publisher.py E325 -lib/ansible/modules/packaging/os/pkg5_publisher.py E326 lib/ansible/modules/packaging/os/pkgin.py E322 -lib/ansible/modules/packaging/os/pkgin.py E325 -lib/ansible/modules/packaging/os/pkgin.py E326 lib/ansible/modules/packaging/os/pkgng.py E322 lib/ansible/modules/packaging/os/pkgng.py E324 lib/ansible/modules/packaging/os/pkgng.py E325 @@ -1806,27 +1465,20 @@ lib/ansible/modules/packaging/os/pkgutil.py E325 lib/ansible/modules/packaging/os/portage.py E322 lib/ansible/modules/packaging/os/portage.py E324 lib/ansible/modules/packaging/os/portage.py E325 -lib/ansible/modules/packaging/os/portage.py E326 lib/ansible/modules/packaging/os/portinstall.py E322 lib/ansible/modules/packaging/os/portinstall.py E325 lib/ansible/modules/packaging/os/portinstall.py E326 lib/ansible/modules/packaging/os/pulp_repo.py E322 lib/ansible/modules/packaging/os/pulp_repo.py E324 -lib/ansible/modules/packaging/os/pulp_repo.py E325 -lib/ansible/modules/packaging/os/pulp_repo.py E326 -lib/ansible/modules/packaging/os/redhat_subscription.py E325 lib/ansible/modules/packaging/os/rhn_channel.py E322 lib/ansible/modules/packaging/os/rhn_channel.py E326 lib/ansible/modules/packaging/os/rhn_register.py E324 -lib/ansible/modules/packaging/os/rhn_register.py E325 lib/ansible/modules/packaging/os/rhsm_repository.py E324 lib/ansible/modules/packaging/os/slackpkg.py E322 lib/ansible/modules/packaging/os/slackpkg.py E324 lib/ansible/modules/packaging/os/slackpkg.py E325 lib/ansible/modules/packaging/os/slackpkg.py E326 lib/ansible/modules/packaging/os/sorcery.py E324 -lib/ansible/modules/packaging/os/sorcery.py E325 -lib/ansible/modules/packaging/os/sorcery.py E326 lib/ansible/modules/packaging/os/svr4pkg.py E324 lib/ansible/modules/packaging/os/svr4pkg.py E325 lib/ansible/modules/packaging/os/svr4pkg.py E326 @@ -1846,12 +1498,9 @@ lib/ansible/modules/packaging/os/yum.py E324 lib/ansible/modules/packaging/os/yum.py E325 lib/ansible/modules/packaging/os/yum.py E326 lib/ansible/modules/packaging/os/yum_repository.py E322 -lib/ansible/modules/packaging/os/yum_repository.py E325 lib/ansible/modules/packaging/os/yum_repository.py E326 lib/ansible/modules/packaging/os/zypper.py E325 lib/ansible/modules/packaging/os/zypper.py E326 -lib/ansible/modules/packaging/os/zypper_repository.py E325 -lib/ansible/modules/packaging/os/zypper_repository.py E326 lib/ansible/modules/remote_management/foreman/foreman.py E322 lib/ansible/modules/remote_management/foreman/foreman.py E324 lib/ansible/modules/remote_management/foreman/foreman.py E325 @@ -1866,7 +1515,6 @@ lib/ansible/modules/remote_management/manageiq/manageiq_alert_profiles.py E324 lib/ansible/modules/remote_management/manageiq/manageiq_alerts.py E324 lib/ansible/modules/remote_management/manageiq/manageiq_policies.py E324 lib/ansible/modules/remote_management/manageiq/manageiq_provider.py E324 -lib/ansible/modules/remote_management/manageiq/manageiq_provider.py E325 lib/ansible/modules/remote_management/manageiq/manageiq_provider.py E326 lib/ansible/modules/remote_management/manageiq/manageiq_tags.py E324 lib/ansible/modules/remote_management/manageiq/manageiq_user.py E324 @@ -1915,23 +1563,12 @@ lib/ansible/modules/remote_management/ucs/ucs_vnic_template.py E326 lib/ansible/modules/remote_management/ucs/ucs_vsans.py E322 lib/ansible/modules/remote_management/ucs/ucs_wwn_pool.py E322 lib/ansible/modules/remote_management/ucs/ucs_wwn_pool.py E323 -lib/ansible/modules/source_control/git.py E324 -lib/ansible/modules/source_control/git.py E325 -lib/ansible/modules/source_control/git.py E326 -lib/ansible/modules/source_control/git_config.py E325 -lib/ansible/modules/source_control/git_config.py E326 lib/ansible/modules/source_control/github_hooks.py E325 lib/ansible/modules/source_control/github_hooks.py E326 lib/ansible/modules/source_control/github_issue.py E326 -lib/ansible/modules/source_control/github_key.py E325 -lib/ansible/modules/source_control/github_key.py E326 -lib/ansible/modules/source_control/github_release.py E325 -lib/ansible/modules/source_control/github_release.py E326 lib/ansible/modules/source_control/gitlab_group.py E325 lib/ansible/modules/source_control/gitlab_project.py E324 -lib/ansible/modules/source_control/gitlab_project.py E325 lib/ansible/modules/source_control/gitlab_project.py E326 -lib/ansible/modules/source_control/gitlab_user.py E325 lib/ansible/modules/source_control/gitlab_user.py E326 lib/ansible/modules/source_control/subversion.py E322 lib/ansible/modules/storage/infinidat/infini_export.py E323 @@ -1941,17 +1578,13 @@ lib/ansible/modules/storage/infinidat/infini_export_client.py E326 lib/ansible/modules/storage/infinidat/infini_pool.py E325 lib/ansible/modules/storage/infinidat/infini_pool.py E326 lib/ansible/modules/storage/netapp/na_cdot_license.py E324 -lib/ansible/modules/storage/netapp/na_cdot_license.py E325 -lib/ansible/modules/storage/netapp/na_cdot_license.py E326 lib/ansible/modules/storage/netapp/na_cdot_lun.py E325 -lib/ansible/modules/storage/netapp/na_cdot_user.py E324 lib/ansible/modules/storage/netapp/na_cdot_volume.py E317 lib/ansible/modules/storage/netapp/na_cdot_volume.py E322 lib/ansible/modules/storage/netapp/na_cdot_volume.py E324 lib/ansible/modules/storage/netapp/na_cdot_volume.py E325 lib/ansible/modules/storage/netapp/netapp_e_amg.py E322 lib/ansible/modules/storage/netapp/netapp_e_amg.py E325 -lib/ansible/modules/storage/netapp/netapp_e_amg.py E326 lib/ansible/modules/storage/netapp/netapp_e_amg_role.py E322 lib/ansible/modules/storage/netapp/netapp_e_amg_role.py E325 lib/ansible/modules/storage/netapp/netapp_e_amg_role.py E326 @@ -1976,7 +1609,6 @@ lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py E325 lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py E326 lib/ansible/modules/storage/netapp/netapp_e_storage_system.py E322 lib/ansible/modules/storage/netapp/netapp_e_storage_system.py E324 -lib/ansible/modules/storage/netapp/netapp_e_storage_system.py E325 lib/ansible/modules/storage/netapp/netapp_e_storagepool.py E322 lib/ansible/modules/storage/netapp/netapp_e_storagepool.py E324 lib/ansible/modules/storage/netapp/netapp_e_storagepool.py E325 @@ -1991,15 +1623,11 @@ lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py E324 lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py E325 lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py E326 lib/ansible/modules/storage/netapp/sf_account_manager.py E322 -lib/ansible/modules/storage/netapp/sf_account_manager.py E324 lib/ansible/modules/storage/netapp/sf_check_connections.py E322 -lib/ansible/modules/storage/netapp/sf_check_connections.py E324 lib/ansible/modules/storage/netapp/sf_snapshot_schedule_manager.py E322 lib/ansible/modules/storage/netapp/sf_snapshot_schedule_manager.py E325 lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py E322 -lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py E324 lib/ansible/modules/storage/netapp/sf_volume_manager.py E322 -lib/ansible/modules/storage/netapp/sf_volume_manager.py E324 lib/ansible/modules/storage/netapp/sf_volume_manager.py E325 lib/ansible/modules/storage/zfs/zfs.py E322 lib/ansible/modules/storage/zfs/zfs.py E323 @@ -2013,8 +1641,6 @@ lib/ansible/modules/system/aix_lvol.py E324 lib/ansible/modules/system/authorized_key.py E322 lib/ansible/modules/system/authorized_key.py E324 lib/ansible/modules/system/authorized_key.py E325 -lib/ansible/modules/system/authorized_key.py E326 -lib/ansible/modules/system/awall.py E325 lib/ansible/modules/system/beadm.py E325 lib/ansible/modules/system/beadm.py E326 lib/ansible/modules/system/capabilities.py E322 @@ -2027,19 +1653,15 @@ lib/ansible/modules/system/gluster_volume.py E322 lib/ansible/modules/system/gluster_volume.py E324 lib/ansible/modules/system/gluster_volume.py E326 lib/ansible/modules/system/group.py E325 -lib/ansible/modules/system/interfaces_file.py E325 -lib/ansible/modules/system/interfaces_file.py E326 lib/ansible/modules/system/iptables.py E324 lib/ansible/modules/system/iptables.py E325 lib/ansible/modules/system/iptables.py E326 lib/ansible/modules/system/java_cert.py E324 lib/ansible/modules/system/java_cert.py E325 lib/ansible/modules/system/known_hosts.py E324 -lib/ansible/modules/system/known_hosts.py E325 lib/ansible/modules/system/lvg.py E324 lib/ansible/modules/system/lvol.py E324 lib/ansible/modules/system/make.py E317 -lib/ansible/modules/system/make.py E324 lib/ansible/modules/system/mksysb.py E325 lib/ansible/modules/system/mksysb.py E326 lib/ansible/modules/system/mount.py E325 @@ -2050,12 +1672,8 @@ lib/ansible/modules/system/open_iscsi.py E322 lib/ansible/modules/system/open_iscsi.py E324 lib/ansible/modules/system/open_iscsi.py E325 lib/ansible/modules/system/open_iscsi.py E326 -lib/ansible/modules/system/openwrt_init.py E325 -lib/ansible/modules/system/openwrt_init.py E326 lib/ansible/modules/system/osx_defaults.py E322 lib/ansible/modules/system/osx_defaults.py E324 -lib/ansible/modules/system/osx_defaults.py E325 -lib/ansible/modules/system/osx_defaults.py E326 lib/ansible/modules/system/pam_limits.py E325 lib/ansible/modules/system/pam_limits.py E326 lib/ansible/modules/system/pamd.py E324 @@ -2070,16 +1688,12 @@ lib/ansible/modules/system/sefcontext.py E326 lib/ansible/modules/system/selinux.py E324 lib/ansible/modules/system/selinux_permissive.py E322 lib/ansible/modules/system/selinux_permissive.py E324 -lib/ansible/modules/system/selinux_permissive.py E325 -lib/ansible/modules/system/selinux_permissive.py E326 lib/ansible/modules/system/service.py E323 lib/ansible/modules/system/service.py E324 lib/ansible/modules/system/setup.py E324 lib/ansible/modules/system/solaris_zone.py E324 lib/ansible/modules/system/svc.py E322 lib/ansible/modules/system/svc.py E324 -lib/ansible/modules/system/sysctl.py E325 -lib/ansible/modules/system/sysctl.py E326 lib/ansible/modules/system/timezone.py E326 lib/ansible/modules/system/ufw.py E322 lib/ansible/modules/system/ufw.py E324 @@ -2087,35 +1701,18 @@ lib/ansible/modules/system/ufw.py E326 lib/ansible/modules/system/user.py E324 lib/ansible/modules/system/vdo.py E324 lib/ansible/modules/system/vdo.py E326 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py E325 lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py E326 lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py E324 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py E325 lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py E325 lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py E323 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_list.py E325 lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py E322 lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py E324 lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_template.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py E325 lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py E322 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py E325 -lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py E325 lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py E317 -lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py E324 -lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py E325 lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py E326 lib/ansible/modules/web_infrastructure/apache2_module.py E325 lib/ansible/modules/web_infrastructure/apache2_module.py E326 -lib/ansible/modules/web_infrastructure/deploy_helper.py E324 -lib/ansible/modules/web_infrastructure/deploy_helper.py E325 lib/ansible/modules/web_infrastructure/django_manage.py E317 lib/ansible/modules/web_infrastructure/django_manage.py E322 lib/ansible/modules/web_infrastructure/django_manage.py E325 @@ -2128,10 +1725,6 @@ lib/ansible/modules/web_infrastructure/htpasswd.py E326 lib/ansible/modules/web_infrastructure/jenkins_job.py E325 lib/ansible/modules/web_infrastructure/jenkins_plugin.py E322 lib/ansible/modules/web_infrastructure/jenkins_plugin.py E324 -lib/ansible/modules/web_infrastructure/jenkins_plugin.py E325 -lib/ansible/modules/web_infrastructure/jenkins_plugin.py E326 -lib/ansible/modules/web_infrastructure/jenkins_script.py E325 lib/ansible/modules/web_infrastructure/jira.py E322 lib/ansible/modules/web_infrastructure/jira.py E324 lib/ansible/modules/web_infrastructure/jira.py E325 -lib/ansible/modules/web_infrastructure/taiga_issue.py E324