From e5b990a55a77371439c373071c22d7d70e95a534 Mon Sep 17 00:00:00 2001 From: John R Barker Date: Thu, 9 Mar 2017 16:20:25 +0000 Subject: [PATCH] Fix invalid fields in module DOCUMENATION (#22297) * fix module doc fields * More module docs corrections * More module docs corrections * More module docs corrections * More module docs corrections * correct aliases * Review comments * Must quote ':' * More authors * Use suboptions: * restore type: bool * type should be in the same place * More tidyups * authors * Use suboptions * revert * remove duplicate author * More issues post rebase --- lib/ansible/modules/cloud/amazon/_ec2_vpc.py | 29 +++++++----- .../modules/cloud/amazon/cloudformation.py | 2 +- .../modules/cloud/amazon/ec2_elb_lb.py | 8 ++-- lib/ansible/modules/cloud/amazon/ec2_lc.py | 2 +- .../modules/cloud/amazon/ec2_metric_alarm.py | 6 +-- lib/ansible/modules/cloud/amazon/ec2_vol.py | 1 - .../cloud/amazon/ec2_vpc_nacl_facts.py | 2 +- .../modules/cloud/amazon/ecs_service.py | 3 +- .../cloud/amazon/ecs_taskdefinition.py | 3 -- .../amazon/elasticache_parameter_group.py | 3 -- .../cloud/amazon/elasticache_snapshot.py | 5 --- lib/ansible/modules/cloud/amazon/s3_sync.py | 4 +- .../cloud/azure/azure_rm_networkinterface.py | 1 - .../cloud/azure/azure_rm_securitygroup.py | 3 +- .../azure/azure_rm_virtualnetwork_facts.py | 2 +- .../cloudstack/cs_loadbalancer_rule_member.py | 1 - .../cloud/digital_ocean/digital_ocean_tag.py | 1 + .../modules/cloud/docker/docker_container.py | 2 +- .../modules/cloud/docker/docker_image.py | 10 +---- .../cloud/docker/docker_image_facts.py | 2 +- .../modules/cloud/docker/docker_login.py | 2 +- .../modules/cloud/docker/docker_network.py | 2 +- .../modules/cloud/docker/docker_service.py | 9 ---- lib/ansible/modules/cloud/linode/linode.py | 16 ------- lib/ansible/modules/cloud/misc/proxmox.py | 17 ++----- lib/ansible/modules/cloud/misc/proxmox_kvm.py | 2 - .../modules/cloud/misc/proxmox_template.py | 6 +-- lib/ansible/modules/cloud/misc/virt.py | 2 +- .../modules/cloud/openstack/_glance_image.py | 1 + .../modules/cloud/openstack/_nova_compute.py | 1 + .../cloud/openstack/_quantum_network.py | 1 + .../cloud/openstack/_quantum_subnet.py | 1 + .../modules/cloud/openstack/os_floating_ip.py | 1 + .../modules/cloud/openstack/os_keypair.py | 1 + .../cloud/openstack/os_keystone_domain.py | 3 ++ .../modules/cloud/openstack/os_router.py | 2 - .../cloud/openstack/os_security_group_rule.py | 1 + .../cloud/openstack/os_server_facts.py | 1 + .../modules/cloud/openstack/os_user.py | 1 + .../cloud/ovh/ovh_ip_loadbalancing_backend.py | 3 +- .../ovirt/ovirt_external_providers_facts.py | 1 + .../modules/cloud/ovirt/ovirt_quotas_facts.py | 1 + .../modules/cloud/rackspace/rax_clb_nodes.py | 4 -- lib/ansible/modules/database/misc/riak.py | 9 ---- .../modules/database/mongodb/mongodb_user.py | 1 - lib/ansible/modules/files/patch.py | 4 +- lib/ansible/modules/monitoring/bigpanda.py | 4 +- .../modules/network/bigswitch/bigmon_chain.py | 1 + .../network/bigswitch/bigmon_policy.py | 1 + .../modules/network/illumos/dladm_linkprop.py | 6 +-- .../modules/network/lenovo/cnos_backup.py | 1 + .../modules/network/lenovo/cnos_bgp.py | 1 + .../modules/network/lenovo/cnos_command.py | 1 + .../lenovo/cnos_conditional_command.py | 1 + .../lenovo/cnos_conditional_template.py | 1 + .../modules/network/lenovo/cnos_factory.py | 1 + .../modules/network/lenovo/cnos_facts.py | 1 + .../modules/network/lenovo/cnos_image.py | 1 + .../modules/network/lenovo/cnos_interface.py | 1 + .../network/lenovo/cnos_portchannel.py | 1 + .../modules/network/lenovo/cnos_reload.py | 1 + .../modules/network/lenovo/cnos_rollback.py | 1 + .../modules/network/lenovo/cnos_save.py | 1 + .../modules/network/lenovo/cnos_showrun.py | 1 + .../modules/network/lenovo/cnos_template.py | 1 + .../modules/network/lenovo/cnos_vlag.py | 1 + .../modules/network/lenovo/cnos_vlan.py | 1 + .../modules/network/netvisor/pn_cluster.py | 1 - .../modules/network/netvisor/pn_ospf.py | 1 - .../modules/network/netvisor/pn_ospfarea.py | 1 - .../modules/network/netvisor/pn_show.py | 1 - .../modules/network/netvisor/pn_trunk.py | 1 - .../modules/network/netvisor/pn_vlag.py | 1 - .../modules/network/netvisor/pn_vlan.py | 1 - .../modules/network/netvisor/pn_vrouter.py | 1 - .../modules/network/netvisor/pn_vrouterbgp.py | 1 - .../modules/network/netvisor/pn_vrouterif.py | 1 - .../network/netvisor/pn_vrouterlbif.py | 1 - .../modules/network/panos/panos_interface.py | 2 +- .../modules/notification/cisco_spark.py | 4 +- lib/ansible/modules/packaging/os/apk.py | 1 + .../modules/packaging/os/homebrew_tap.py | 5 +-- lib/ansible/modules/packaging/os/package.py | 2 - lib/ansible/modules/packaging/os/portage.py | 2 - .../remote_management/ipmi/ipmi_boot.py | 5 +-- .../remote_management/ipmi/ipmi_power.py | 2 - .../remote_management/stacki/stacki_host.py | 2 +- .../modules/storage/netapp/na_cdot_license.py | 44 ++++++++++++------- .../modules/storage/netapp/na_cdot_qtree.py | 3 +- .../modules/storage/netapp/na_cdot_svm.py | 7 ++- .../modules/storage/netapp/na_cdot_user.py | 4 +- .../modules/storage/netapp/na_cdot_volume.py | 6 +-- .../storage/netapp/netapp_e_amg_role.py | 2 - .../storage/netapp/netapp_e_amg_sync.py | 2 - .../modules/storage/netapp/netapp_e_facts.py | 2 - .../storage/netapp/netapp_e_flashcache.py | 2 - .../modules/storage/netapp/netapp_e_host.py | 4 +- .../storage/netapp/netapp_e_hostgroup.py | 2 - .../storage/netapp/netapp_e_snapshot_group.py | 2 - .../netapp/netapp_e_snapshot_images.py | 2 - .../netapp/netapp_e_snapshot_volume.py | 5 +-- .../storage/netapp/netapp_e_storage_system.py | 2 - .../storage/netapp/netapp_e_storagepool.py | 2 - .../modules/storage/netapp/netapp_e_volume.py | 2 - .../storage/netapp/netapp_e_volume_copy.py | 4 +- .../netapp/sf_snapshot_schedule_manager.py | 2 +- .../storage/netapp/sf_volume_manager.py | 15 +++---- lib/ansible/modules/storage/zfs/zfs_facts.py | 10 ++--- .../modules/storage/zfs/zpool_facts.py | 6 +-- lib/ansible/modules/system/aix_inittab.py | 11 +---- lib/ansible/modules/system/beadm.py | 2 +- lib/ansible/modules/system/pam_limits.py | 2 +- lib/ansible/modules/system/ufw.py | 2 +- .../ansible_tower/tower_credential.py | 1 + .../ansible_tower/tower_group.py | 1 + .../ansible_tower/tower_host.py | 1 + .../ansible_tower/tower_inventory.py | 1 + .../ansible_tower/tower_job_cancel.py | 1 + .../ansible_tower/tower_job_launch.py | 1 + .../ansible_tower/tower_job_list.py | 1 + .../ansible_tower/tower_job_template.py | 1 + .../ansible_tower/tower_job_wait.py | 1 + .../ansible_tower/tower_label.py | 1 + .../ansible_tower/tower_organization.py | 1 + .../ansible_tower/tower_project.py | 1 + .../ansible_tower/tower_role.py | 1 + .../ansible_tower/tower_team.py | 1 + .../ansible_tower/tower_user.py | 1 + .../web_infrastructure/apache2_mod_proxy.py | 1 + .../modules/web_infrastructure/htpasswd.py | 2 +- .../web_infrastructure/jenkins_script.py | 2 +- .../modules/web_infrastructure/letsencrypt.py | 4 +- lib/ansible/modules/windows/win_chocolatey.py | 3 +- lib/ansible/modules/windows/win_psexec.py | 2 +- lib/ansible/modules/windows/win_robocopy.py | 4 +- .../modules/windows/win_scheduled_task.py | 1 + lib/ansible/modules/windows/win_stat.py | 1 - lib/ansible/modules/windows/win_unzip.py | 2 +- 138 files changed, 176 insertions(+), 256 deletions(-) diff --git a/lib/ansible/modules/cloud/amazon/_ec2_vpc.py b/lib/ansible/modules/cloud/amazon/_ec2_vpc.py index 2f2db3f6bad..3f093d5dc28 100644 --- a/lib/ansible/modules/cloud/amazon/_ec2_vpc.py +++ b/lib/ansible/modules/cloud/amazon/_ec2_vpc.py @@ -32,7 +32,7 @@ deprecated: >- options: cidr_block: description: - - "The cidr block representing the VPC, e.g. 10.0.0.0/16, required when I(state) is 'present'." + - "The cidr block representing the VPC, e.g. C(10.0.0.0/16), required when I(state=present)." required: false instance_tenancy: description: @@ -42,56 +42,61 @@ options: choices: [ "default", "dedicated" ] dns_support: description: - - toggles the "Enable DNS resolution" flag + - Toggles the "Enable DNS resolution" flag. required: false default: "yes" choices: [ "yes", "no" ] dns_hostnames: description: - - toggles the "Enable DNS hostname support for instances" flag + - Toggles the "Enable DNS hostname support for instances" flag. required: false default: "yes" choices: [ "yes", "no" ] subnets: description: - - 'A dictionary array of subnets to add of the form: { cidr: ..., az: ... , resource_tags: ... }. Where az is the desired availability zone of the subnet, but it is not required. Tags (i.e.: resource_tags) is also optional and use dictionary form: { "Environment":"Dev", "Tier":"Web", ...}. 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.' + - 'A dictionary array of subnets to add of the form C({ cidr: ..., az: ... , resource_tags: ... }).' + - Where C(az) is the desired availability zone of the subnet, optional. + - 'Tags C(resource_tags) use dictionary form C({ "Environment":"Dev", "Tier":"Web", ...}), optional.' + - 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 - resource_tags: See resource_tags for VPC below. The main difference is subnet tags not specified here will be deleted. vpc_id: description: - - A VPC id to terminate when state=absent + - 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: { tag1: value1, tag2: value2 }. Tags in this list are used in conjunction with CIDR block to uniquely identify a VPC in lieu of vpc_id. Therefore, if CIDR/Tag combination does not exist, a new VPC will be created. VPC tags not on this list will be ignored. Prior to 1.7, specifying a resource tag was optional.' + - 'A dictionary array of resource tags of the form C({ tag1: value1, tag2: value2 }). + - Tags in this list are used in conjunction with CIDR block to uniquely identify a VPC in lieu of vpc_id. Therefore, if CIDR/Tag combination does not exist, a new VPC will be created. VPC tags not on this list will be ignored. Prior to 1.7, specifying a resource tag was optional.' required: true version_added: "1.6" internet_gateway: description: - - Toggle whether there should be an Internet gateway attached to the VPC + - Toggle whether there should be an Internet gateway attached to the VPC. required: false default: "no" choices: [ "yes", "no" ] route_tables: description: - - 'A dictionary array of route tables to add of the form: { subnets: [172.22.2.0/24, 172.22.3.0/24,], routes: [{ dest: 0.0.0.0/0, gw: igw},], resource_tags: ... }. Where the subnets list is those subnets the route table should be associated with, and the routes list is a list of routes to be in the table. The special keyword for the gw of igw specifies that you should the route should go through the internet gateway attached to the VPC. gw also accepts instance-ids, interface-ids, and vpc-peering-connection-ids in addition igw. resource_tags is optional and uses dictionary form: { "Name": "public", ... }. 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.' + - 'A dictionary array of route tables to add of the form: C({ subnets: [172.22.2.0/24, 172.22.3.0/24,], routes: [{ dest: 0.0.0.0/0, gw: igw},], resource_tags: ... }). Where the subnets list is those subnets the route table should be associated with, and the routes list is a list of routes to be in the table. The special keyword for the gw of igw specifies that you should the route should go through the internet gateway attached to the VPC. gw also accepts instance-ids, interface-ids, and vpc-peering-connection-ids in addition igw. resource_tags is optional and uses dictionary form: C({ "Name": "public", ... }). 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 + - Wait for the VPC to be in state 'available' before returning. required: false default: "no" choices: [ "yes", "no" ] wait_timeout: description: - - how long before wait gives up, in seconds + - How long before wait gives up, in seconds. default: 300 state: description: - - Create or terminate the VPC + - Create or terminate the VPC. required: true choices: [ "present", "absent" ] author: "Carson Gee (@carsongee)" diff --git a/lib/ansible/modules/cloud/amazon/cloudformation.py b/lib/ansible/modules/cloud/amazon/cloudformation.py index e58abd9277a..4fd17c4a673 100644 --- a/lib/ansible/modules/cloud/amazon/cloudformation.py +++ b/lib/ansible/modules/cloud/amazon/cloudformation.py @@ -104,7 +104,7 @@ author: "James S. Martin (@jsmartin)" extends_documentation_fragment: - aws - ec2 -requires: [ botocore>=1.4.57 ] +requirements: [ botocore>=1.4.57 ] ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py b/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py index 88dc9aed02a..e647fdcf62e 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py +++ b/lib/ansible/modules/cloud/amazon/ec2_elb_lb.py @@ -71,24 +71,24 @@ options: security_group_ids: description: - A list of security groups to apply to the elb - require: false + required: false default: None version_added: "1.6" security_group_names: description: - A list of security group names to apply to the elb - require: false + required: false default: None version_added: "2.0" health_check: description: - An associative array of health check configuration settings (see example) - require: false + required: false default: None access_logs: description: - An associative array of access logs configuration settings (see example) - require: false + required: false default: None version_added: "2.0" subnets: diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc.py b/lib/ansible/modules/cloud/amazon/ec2_lc.py index 5cff544bcbe..2ac5c52b38c 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_lc.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc.py @@ -118,7 +118,7 @@ options: extends_documentation_fragment: - aws - ec2 -requires: +requirements: - "boto >= 2.39.0" """ diff --git a/lib/ansible/modules/cloud/amazon/ec2_metric_alarm.py b/lib/ansible/modules/cloud/amazon/ec2_metric_alarm.py index 6606b32d8f6..f8fd2f6a147 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_metric_alarm.py +++ b/lib/ansible/modules/cloud/amazon/ec2_metric_alarm.py @@ -50,12 +50,12 @@ options: - Operation applied to the metric - Works in conjunction with period and evaluation_periods to determine the comparison value required: false - options: ['SampleCount','Average','Sum','Minimum','Maximum'] + choices: ['SampleCount','Average','Sum','Minimum','Maximum'] comparison: description: - Determines how the threshold value is compared required: false - options: ['<=','<','>','>='] + choices: ['<=','<','>','>='] threshold: description: - Sets the min/max bound for triggering the alarm @@ -72,7 +72,7 @@ options: description: - The threshold's unit of measurement required: false - options: ['Seconds','Microseconds','Milliseconds','Bytes','Kilobytes','Megabytes','Gigabytes','Terabytes','Bits','Kilobits','Megabits','Gigabits','Terabits','Percent','Count','Bytes/Second','Kilobytes/Second','Megabytes/Second','Gigabytes/Second','Terabytes/Second','Bits/Second','Kilobits/Second','Megabits/Second','Gigabits/Second','Terabits/Second','Count/Second','None'] + choices: ['Seconds','Microseconds','Milliseconds','Bytes','Kilobytes','Megabytes','Gigabytes','Terabytes','Bits','Kilobits','Megabits','Gigabits','Terabits','Percent','Count','Bytes/Second','Kilobytes/Second','Megabytes/Second','Gigabytes/Second','Terabytes/Second','Bits/Second','Kilobits/Second','Megabits/Second','Gigabits/Second','Terabits/Second','Count/Second','None'] description: description: - A longer description of the alarm diff --git a/lib/ansible/modules/cloud/amazon/ec2_vol.py b/lib/ansible/modules/cloud/amazon/ec2_vol.py index bbe7396c166..2cc86a720f0 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vol.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vol.py @@ -114,7 +114,6 @@ options: tags: description: - tag:value pairs to add to the volume after creation - type: dict required: false default: {} version_added: "2.3" diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py index e7f6a5b2380..9f36c987b83 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py @@ -26,7 +26,7 @@ description: - Gather facts about Network ACLs in an AWS VPC version_added: "2.2" author: "Brad Davidson (@brandond)" -requires: [ boto3 ] +requirements: [ boto3 ] options: nacl_ids: description: diff --git a/lib/ansible/modules/cloud/amazon/ecs_service.py b/lib/ansible/modules/cloud/amazon/ecs_service.py index 54a0dc58f78..54c4f707871 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_service.py +++ b/lib/ansible/modules/cloud/amazon/ecs_service.py @@ -27,8 +27,7 @@ description: notes: - the service role specified must be assumable (i.e. have a trust relationship for the ecs service, ecs.amazonaws.com) - for details of the parameters and returns see U(http://boto3.readthedocs.org/en/latest/reference/services/ecs.html) -dependencies: - - An IAM role must have been created + - An IAM role must have been previously created version_added: "2.1" author: - "Mark Chance (@java1guy)" diff --git a/lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py b/lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py index 9c51eea3072..2b2d7f85581 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py +++ b/lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py @@ -45,12 +45,10 @@ options: description: - A revision number for the task definition required: False - type: int containers: description: - A list of containers definitions required: False - type: list of dicts with container definitions network_mode: description: - The Docker networking mode to use for the containers in the task. @@ -67,7 +65,6 @@ options: description: - A list of names of volumes to be attached required: False - type: list of name 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 0bf2f94281d..aa517441c46 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py +++ b/lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py @@ -33,12 +33,10 @@ options: - The name of the cache parameter group family that the cache parameter group can be used with. choices: ['memcached1.4', 'redis2.6', 'redis2.8', 'redis3.2'] required: yes - type: string name: description: - A user-specified name for the cache parameter group. required: yes - type: string description: description: - A user-specified description for the cache parameter group. @@ -51,7 +49,6 @@ options: description: - A user-specified list of parameters to reset or modify for the cache parameter group. required: no - type: dict default: None """ diff --git a/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py b/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py index 1294f09c3fd..8eb992db853 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py +++ b/lib/ansible/modules/cloud/amazon/elasticache_snapshot.py @@ -31,7 +31,6 @@ options: name: description: - The name of the snapshot we want to create, copy, delete - type: string required: yes state: description: @@ -40,25 +39,21 @@ options: replication_id: description: - The name of the existing replication group to make the snapshot. - type: string required: no default: null cluster_id: description: - The name of an existing cache cluster in the replication group to make the snapshot. - type: string required: no default: null target: description: - The name of a snapshot copy - type: string required: no default: null bucket: description: - The s3 bucket to which the snapshot is exported - type: string required: no default: null """ diff --git a/lib/ansible/modules/cloud/amazon/s3_sync.py b/lib/ansible/modules/cloud/amazon/s3_sync.py index 5c64abf284e..5c84c342255 100644 --- a/lib/ansible/modules/cloud/amazon/s3_sync.py +++ b/lib/ansible/modules/cloud/amazon/s3_sync.py @@ -62,10 +62,8 @@ options: choices: [ '', private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control ] mime_map: description: - - Dict entry from extension to MIME type. This will override any default/sniffed MIME type. - type: dict + - 'Dict entry from extension to MIME type. This will override any default/sniffed MIME type. For example C({".txt": "application/text", ".yml": "appication/text"})' required: false - sample: {".txt": "application/text", ".yml": "appication/text"} include: description: - Shell pattern-style file matching. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py index 4580dfec8db..e3812211947 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py @@ -137,7 +137,6 @@ options: - 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. - type: list required: false default: null extends_documentation_fragment: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py index de2569d0941..bcb051f7920 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_securitygroup.py @@ -69,10 +69,9 @@ options: rules: description: - Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary. - type: complex required: false default: null - contains: + suboptions: name: description: Unique name for the rule. required: true 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 229df95b74c..0fe41608774 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork_facts.py @@ -54,7 +54,7 @@ options: extends_documentation_fragment: - azure -authors: +author: - "Chris Houseknecht house@redhat.com" - "Matt Davis mdavis@redhat.com" 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 0695ed9be5b..0617fe04776 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py @@ -49,7 +49,6 @@ options: description: - List of VMs to assign to or remove from the rule. required: true - type: list aliases: [ 'vm' ] state: description: diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py index 3ad387a90c3..cb8834b1bf5 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py @@ -25,6 +25,7 @@ module: digital_ocean_tag short_description: Create and remove tag(s) to DigitalOcean resource. description: - Create and remove tag(s) to DigitalOcean resource. +author: "Victor Volle (@kontrafiktion)" version_added: "2.2" options: name: diff --git a/lib/ansible/modules/cloud/docker/docker_container.py b/lib/ansible/modules/cloud/docker/docker_container.py index e22a847d485..8d2239f59a4 100644 --- a/lib/ansible/modules/cloud/docker/docker_container.py +++ b/lib/ansible/modules/cloud/docker/docker_container.py @@ -185,7 +185,7 @@ options: kill_signal: description: - Override default signal used to kill a running container. - default null: + default: null required: false kernel_memory: description: diff --git a/lib/ansible/modules/cloud/docker/docker_image.py b/lib/ansible/modules/cloud/docker/docker_image.py index 2feab4b7c80..8a8e39079eb 100644 --- a/lib/ansible/modules/cloud/docker/docker_image.py +++ b/lib/ansible/modules/cloud/docker/docker_image.py @@ -134,7 +134,6 @@ options: - Provide a dictionary of C(key:value) build arguments that map to Dockerfile ARG directive. - Docker expects the value to be a string. For convenience any non-string values will be converted to strings. - Requires Docker API >= 1.21 and docker-py >= 1.7.0. - type: complex required: false version_added: "2.2" container_limits: @@ -142,20 +141,15 @@ options: - A dictionary of limits applied to each container created by the build process. required: false version_added: "2.1" - type: complex - contains: + suboptions: memory: description: Set memory limit for build - type: int memswap: description: Total memory (memory + swap), -1 to disable swap - type: int cpushares: description: CPU shares (relative weight) - type: int cpusetcpus: description: CPUs in which to allow execution, e.g., "0-3", "0,1" - type: str use_tls: description: - "DEPRECATED. Whether to use tls to connect to the docker server. Set to C(no) when TLS will not be used. Set to @@ -177,7 +171,7 @@ requirements: - "docker-py >= 1.7.0" - "Docker API >= 1.20" -authors: +author: - Pavel Antonov (@softzilla) - Chris Houseknecht (@chouseknecht) - James Tanner (@jctanner) diff --git a/lib/ansible/modules/cloud/docker/docker_image_facts.py b/lib/ansible/modules/cloud/docker/docker_image_facts.py index 81e16fe5e2a..dcae12558b7 100644 --- a/lib/ansible/modules/cloud/docker/docker_image_facts.py +++ b/lib/ansible/modules/cloud/docker/docker_image_facts.py @@ -48,7 +48,7 @@ requirements: - "docker-py >= 1.7.0" - "Docker API >= 1.20" -authors: +author: - Chris Houseknecht (@chouseknecht) - James Tanner (@jctanner) diff --git a/lib/ansible/modules/cloud/docker/docker_login.py b/lib/ansible/modules/cloud/docker/docker_login.py index d97a8878654..65c0de0f9d9 100644 --- a/lib/ansible/modules/cloud/docker/docker_login.py +++ b/lib/ansible/modules/cloud/docker/docker_login.py @@ -93,7 +93,7 @@ requirements: - "docker-py >= 1.7.0" - "Docker API >= 1.20" - 'Only to be able to logout (state=absent): the docker command line utility' -authors: +author: - "Olaf Kilian " - "Chris Houseknecht (@chouseknecht)" - "James Tanner (@jctanner)" diff --git a/lib/ansible/modules/cloud/docker/docker_network.py b/lib/ansible/modules/cloud/docker/docker_network.py index 867907b4a5c..8fe6a3671c1 100644 --- a/lib/ansible/modules/cloud/docker/docker_network.py +++ b/lib/ansible/modules/cloud/docker/docker_network.py @@ -100,7 +100,7 @@ options: extends_documentation_fragment: - docker -authors: +author: - "Ben Keith (@keitwb)" - "Chris Houseknecht (@chouseknecht)" diff --git a/lib/ansible/modules/cloud/docker/docker_service.py b/lib/ansible/modules/cloud/docker/docker_service.py index 0c674cc313b..92f26801cc4 100644 --- a/lib/ansible/modules/cloud/docker/docker_service.py +++ b/lib/ansible/modules/cloud/docker/docker_service.py @@ -44,19 +44,16 @@ 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. - type: path 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 no C(definition) is provided. - type: str 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. - type: list required: false state: description: @@ -67,18 +64,15 @@ options: - absent - present default: present - type: str required: false services: description: - When C(state) is I(present) run I(docker-compose up) on a subset of services. - type: list 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. - type: complex required: false dependencies: description: @@ -90,7 +84,6 @@ options: description: - Provide docker-compose yaml describing one or more services, networks and volumes. - Mutually exclusive with C(project_src) and C(files). - type: complex required: false hostname_check: description: @@ -103,7 +96,6 @@ options: - By default containers will be recreated when their configuration differs from the service definition. - Setting to I(never) ignores configuration differences and leaves existing containers unchanged. - Setting to I(always) forces recreation of all existing containers. - type: str required: false choices: - always @@ -139,7 +131,6 @@ options: remove_images: description: - Use with state I(absent) to remove the all images or only local images. - type: str required: false default: null remove_volumes: diff --git a/lib/ansible/modules/cloud/linode/linode.py b/lib/ansible/modules/cloud/linode/linode.py index 7509cbf92c7..9abfcb79658 100644 --- a/lib/ansible/modules/cloud/linode/linode.py +++ b/lib/ansible/modules/cloud/linode/linode.py @@ -40,19 +40,16 @@ options: - Name to give the instance (alphanumeric, dashes, underscore) - To keep sanity on the Linode Web Console, name is prepended with LinodeID_ default: null - type: string displaygroup: description: - Add the instance to a Display Group in Linode Manager default: null - type: string version_added: "2.3" linode_id: description: - Unique ID of a linode server aliases: [ 'lid' ] default: null - type: integer additional_disks: description: > List of dictionaries for creating additional disks that are added to the Linode configuration settings. @@ -69,7 +66,6 @@ options: description: - Set threshold in MB of bandwidth in alerts. default: null - type: integer version_added: "2.3" alert_bwout_enabled: description: @@ -81,7 +77,6 @@ options: description: - Set threshold in MB of bandwidth out alerts. default: null - type: integer version_added: "2.3" alert_bwquota_enabled: description: @@ -93,7 +88,6 @@ options: description: - Set threshold in MB of bandwidth quota alerts. default: null - type: integer version_added: "2.3" alert_cpu_enabled: description: @@ -105,7 +99,6 @@ options: description: - Set percentage threshold for receiving CPU usage alerts. Each CPU core adds 100% to total. default: null - type: integer version_added: "2.3" alert_diskio_enabled: description: @@ -117,30 +110,25 @@ options: description: - Set threshold for average IO ops/sec over 2 hour period. default: null - type: integer version_added: "2.3" backupweeklyday: description: - Integer value for what day of the week to store weekly backups. default: null - type: integer version_added: "2.3" plan: description: - plan to use for the instance (Linode plan) default: null - type: integer payment_term: description: - payment term to use for the instance (payment term in months) default: 1 - type: integer choices: [1, 12, 24] password: description: - root password to apply to a new server (auto generated if missing) default: null - type: string private_ip: description: - Add private IPv4 address when Linode is created. @@ -151,22 +139,18 @@ options: description: - SSH public key applied to root user default: null - type: string swap: description: - swap size in MB default: 512 - type: integer distribution: description: - distribution to use for the instance (Linode Distribution) default: null - type: integer datacenter: description: - datacenter to create an instance in (Linode Datacenter) default: null - type: integer wait: description: - wait for the instance to be in state 'running' before returning diff --git a/lib/ansible/modules/cloud/misc/proxmox.py b/lib/ansible/modules/cloud/misc/proxmox.py index 7039438967d..1ed4d20c325 100644 --- a/lib/ansible/modules/cloud/misc/proxmox.py +++ b/lib/ansible/modules/cloud/misc/proxmox.py @@ -53,7 +53,7 @@ options: - enable / disable https certificate verification default: false required: false - type: boolean + type: bool node: description: - Proxmox VE node, when new VM will be created @@ -108,59 +108,50 @@ options: required: false netif: description: - - specifies network interfaces for the container + - specifies network interfaces for the container. As a hash/dictionary defining interfaces. default: null required: false - type: A hash/dictionary defining interfaces mounts: description: - - specifies additional mounts (separate disks) for the container + - specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points default: null required: false - type: A hash/dictionary defining mount points version_added: "2.2" ip_address: description: - specifies the address the container will be assigned default: null required: false - type: string onboot: description: - specifies whether a VM will be started during system bootup default: false required: false - type: boolean storage: description: - target storage default: 'local' required: false - type: string cpuunits: description: - CPU weight for a VM default: 1000 required: false - type: integer nameserver: description: - sets DNS server IP address for a container default: null required: false - type: string searchdomain: description: - sets DNS search domain for a container default: null required: false - type: string timeout: description: - timeout for operations default: 30 required: false - type: integer force: description: - forcing operations @@ -169,7 +160,7 @@ options: - with states C(stopped) , C(restarted) allow to force stop instance default: false required: false - type: boolean + type: bool state: description: - Indicate desired state of the instance diff --git a/lib/ansible/modules/cloud/misc/proxmox_kvm.py b/lib/ansible/modules/cloud/misc/proxmox_kvm.py index f37a504c0fd..c7406c6970e 100644 --- a/lib/ansible/modules/cloud/misc/proxmox_kvm.py +++ b/lib/ansible/modules/cloud/misc/proxmox_kvm.py @@ -491,8 +491,6 @@ options: - Creates a virtual hardware watchdog device. required: false default: null -Notes: - - Requires proxmoxer and requests modules on host. This modules can be installed with pip. requirements: [ "proxmoxer", "requests" ] ''' diff --git a/lib/ansible/modules/cloud/misc/proxmox_template.py b/lib/ansible/modules/cloud/misc/proxmox_template.py index e46a167fc99..08f8fa5f085 100644 --- a/lib/ansible/modules/cloud/misc/proxmox_template.py +++ b/lib/ansible/modules/cloud/misc/proxmox_template.py @@ -45,7 +45,7 @@ options: - enable / disable https certificate verification default: false required: false - type: boolean + type: bool node: description: - Proxmox VE node, when you will operate with template @@ -76,19 +76,17 @@ options: - target storage default: 'local' required: false - type: string timeout: description: - timeout for operations default: 30 required: false - type: integer force: description: - can be used only with C(state=present), exists template will be overwritten default: false required: false - type: boolean + type: bool state: description: - Indicate desired state of the template diff --git a/lib/ansible/modules/cloud/misc/virt.py b/lib/ansible/modules/cloud/misc/virt.py index 987221a6277..a6111dface2 100644 --- a/lib/ansible/modules/cloud/misc/virt.py +++ b/lib/ansible/modules/cloud/misc/virt.py @@ -59,7 +59,7 @@ options: description: - libvirt connection uri required: false - defaults: qemu:///system + default: qemu:///system xml: description: - XML document used with the define command diff --git a/lib/ansible/modules/cloud/openstack/_glance_image.py b/lib/ansible/modules/cloud/openstack/_glance_image.py index 18b960bbf9d..53ef88f463a 100644 --- a/lib/ansible/modules/cloud/openstack/_glance_image.py +++ b/lib/ansible/modules/cloud/openstack/_glance_image.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['deprecated'], DOCUMENTATION = ''' --- module: glance_image +author: "Benno Joy (@bennojoy)" version_added: "1.2" deprecated: Deprecated in 1.10. Use M(os_image) instead. short_description: Add/Delete images from glance diff --git a/lib/ansible/modules/cloud/openstack/_nova_compute.py b/lib/ansible/modules/cloud/openstack/_nova_compute.py index fad08d9536d..454954a573b 100644 --- a/lib/ansible/modules/cloud/openstack/_nova_compute.py +++ b/lib/ansible/modules/cloud/openstack/_nova_compute.py @@ -25,6 +25,7 @@ DOCUMENTATION = ''' --- module: nova_compute version_added: "1.2" +author: "Benno Joy (@bennojoy)" deprecated: Deprecated in 2.0. Use M(os_server) instead. short_description: Create/Delete VMs from OpenStack description: diff --git a/lib/ansible/modules/cloud/openstack/_quantum_network.py b/lib/ansible/modules/cloud/openstack/_quantum_network.py index 3662296a4e9..ef43f23022c 100644 --- a/lib/ansible/modules/cloud/openstack/_quantum_network.py +++ b/lib/ansible/modules/cloud/openstack/_quantum_network.py @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: quantum_network version_added: "1.4" +author: "Benno Joy (@bennojoy)" deprecated: Deprecated in 2.0. Use M(os_network) instead. short_description: Creates/Removes networks from OpenStack description: diff --git a/lib/ansible/modules/cloud/openstack/_quantum_subnet.py b/lib/ansible/modules/cloud/openstack/_quantum_subnet.py index 2598d2457a8..1844c47fd98 100644 --- a/lib/ansible/modules/cloud/openstack/_quantum_subnet.py +++ b/lib/ansible/modules/cloud/openstack/_quantum_subnet.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['deprecated'], DOCUMENTATION = ''' --- module: quantum_subnet +author: "Benno Joy (@bennojoy)" deprecated: Deprecated in 2.0. Use M(os_subnet) instead. version_added: "1.2" short_description: Add/remove subnet from a network diff --git a/lib/ansible/modules/cloud/openstack/os_floating_ip.py b/lib/ansible/modules/cloud/openstack/os_floating_ip.py index ab169f6722d..a40dd4cc46b 100644 --- a/lib/ansible/modules/cloud/openstack/os_floating_ip.py +++ b/lib/ansible/modules/cloud/openstack/os_floating_ip.py @@ -23,6 +23,7 @@ DOCUMENTATION = ''' --- module: os_floating_ip version_added: "2.0" +author: "Davide Guerri " short_description: Add/Remove floating IP from an instance extends_documentation_fragment: openstack description: diff --git a/lib/ansible/modules/cloud/openstack/os_keypair.py b/lib/ansible/modules/cloud/openstack/os_keypair.py index 3ff0f81aa7a..d22975e5939 100644 --- a/lib/ansible/modules/cloud/openstack/os_keypair.py +++ b/lib/ansible/modules/cloud/openstack/os_keypair.py @@ -25,6 +25,7 @@ DOCUMENTATION = ''' --- module: os_keypair short_description: Add/Delete a keypair from OpenStack +author: "Benno Joy (@bennojoy)" extends_documentation_fragment: openstack version_added: "2.0" description: diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_domain.py b/lib/ansible/modules/cloud/openstack/os_keystone_domain.py index c50e386f0fe..5e511c6bb95 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_domain.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_domain.py @@ -22,6 +22,9 @@ DOCUMENTATION = ''' --- module: os_keystone_domain short_description: Manage OpenStack Identity Domains +author: + - Monty + - Haneef Ali extends_documentation_fragment: openstack version_added: "2.1" description: diff --git a/lib/ansible/modules/cloud/openstack/os_router.py b/lib/ansible/modules/cloud/openstack/os_router.py index 6af1f890d1e..40e01b1cb43 100644 --- a/lib/ansible/modules/cloud/openstack/os_router.py +++ b/lib/ansible/modules/cloud/openstack/os_router.py @@ -52,13 +52,11 @@ options: description: - Unique name or ID of the external gateway network. - required I(interfaces) or I(enable_snat) are provided. - type: string required: false default: None project: description: - Unique name or ID of the project. - type: string required: false default: None version_added: "2.2" 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 fb09f75ba29..061233903d5 100644 --- a/lib/ansible/modules/cloud/openstack/os_security_group_rule.py +++ b/lib/ansible/modules/cloud/openstack/os_security_group_rule.py @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: os_security_group_rule short_description: Add/Delete rule from an existing security group +author: "Benno Joy (@bennojoy)" extends_documentation_fragment: openstack version_added: "2.0" description: diff --git a/lib/ansible/modules/cloud/openstack/os_server_facts.py b/lib/ansible/modules/cloud/openstack/os_server_facts.py index cc6246ad313..ea142334ac9 100644 --- a/lib/ansible/modules/cloud/openstack/os_server_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_server_facts.py @@ -23,6 +23,7 @@ DOCUMENTATION = ''' --- module: os_server_facts short_description: Retrieve facts about one or more compute instances +author: Monty version_added: "2.0" description: - Retrieve facts about server instances from OpenStack. diff --git a/lib/ansible/modules/cloud/openstack/os_user.py b/lib/ansible/modules/cloud/openstack/os_user.py index 11cdabc5315..86bfcbc2e5a 100644 --- a/lib/ansible/modules/cloud/openstack/os_user.py +++ b/lib/ansible/modules/cloud/openstack/os_user.py @@ -23,6 +23,7 @@ DOCUMENTATION = ''' module: os_user short_description: Manage OpenStack Identity Users extends_documentation_fragment: openstack +author: David Shrewsbury version_added: "2.0" description: - Manage OpenStack Identity users. Users can be created, 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 ee4cd22c59b..abba043a727 100644 --- a/lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py +++ b/lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py @@ -76,11 +76,10 @@ options: - The consumer key to use timeout: required: false - type: "int" default: 120 description: - The timeout in seconds used to wait for a task to be - completed. Default is 120 seconds. + completed. ''' diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_external_providers_facts.py b/lib/ansible/modules/cloud/ovirt/ovirt_external_providers_facts.py index ac03036e3eb..9dd26e9c6da 100644 --- a/lib/ansible/modules/cloud/ovirt/ovirt_external_providers_facts.py +++ b/lib/ansible/modules/cloud/ovirt/ovirt_external_providers_facts.py @@ -27,6 +27,7 @@ DOCUMENTATION = ''' --- module: ovirt_external_providers_facts short_description: Retrieve facts about one or more oVirt external providers +author: "Ondra Machacek (@machacekondra)" version_added: "2.3" description: - "Retrieve facts about one or more oVirt external providers." diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_quotas_facts.py b/lib/ansible/modules/cloud/ovirt/ovirt_quotas_facts.py index 510be1fde06..daf59879c66 100644 --- a/lib/ansible/modules/cloud/ovirt/ovirt_quotas_facts.py +++ b/lib/ansible/modules/cloud/ovirt/ovirt_quotas_facts.py @@ -28,6 +28,7 @@ DOCUMENTATION = ''' module: ovirt_quotas_facts short_description: Retrieve facts about one or more oVirt quotas version_added: "2.3" +author: "Red Hat" description: - "Retrieve facts about one or more oVirt quotas." notes: diff --git a/lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py b/lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py index 844834d7476..839d35065d6 100644 --- a/lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py +++ b/lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py @@ -43,17 +43,14 @@ options: balancer load_balancer_id: required: true - type: integer description: - Load balancer id node_id: required: false - type: integer description: - Node id port: required: false - type: integer description: - Port number of the load balanced service on the node state: @@ -81,7 +78,6 @@ options: - Wait for the load balancer to become active before returning wait_timeout: required: false - type: integer default: 30 description: - How long to wait before giving up and returning an error diff --git a/lib/ansible/modules/database/misc/riak.py b/lib/ansible/modules/database/misc/riak.py index 050d0c36594..3f9efac12fe 100644 --- a/lib/ansible/modules/database/misc/riak.py +++ b/lib/ansible/modules/database/misc/riak.py @@ -39,46 +39,37 @@ options: - The command you would like to perform against the cluster. required: false default: null - aliases: [] choices: ['ping', 'kv_test', 'join', 'plan', 'commit'] config_dir: description: - The path to the riak configuration directory required: false default: /etc/riak - aliases: [] http_conn: description: - The ip address and port that is listening for Riak HTTP queries required: false default: 127.0.0.1:8098 - aliases: [] target_node: description: - The target node for certain operations (join, ping) required: false default: riak@127.0.0.1 - aliases: [] wait_for_handoffs: description: - Number of seconds to wait for handoffs to complete. required: false default: null - aliases: [] - type: 'int' wait_for_ring: description: - Number of seconds to wait for all nodes to agree on the ring. required: false default: null - aliases: [] - type: 'int' wait_for_service: description: - Waits for a riak service to come online before continuing. required: false default: None - aliases: [] choices: ['kv'] validate_certs: description: diff --git a/lib/ansible/modules/database/mongodb/mongodb_user.py b/lib/ansible/modules/database/mongodb/mongodb_user.py index c80acdd6ffc..9f9bce148b4 100644 --- a/lib/ansible/modules/database/mongodb/mongodb_user.py +++ b/lib/ansible/modules/database/mongodb/mongodb_user.py @@ -99,7 +99,6 @@ options: required: false default: "readWrite" state: - state: description: - The database user state required: false diff --git a/lib/ansible/modules/files/patch.py b/lib/ansible/modules/files/patch.py index 27534199429..8e66b1be89b 100644 --- a/lib/ansible/modules/files/patch.py +++ b/lib/ansible/modules/files/patch.py @@ -67,7 +67,6 @@ options: that will be stripped from each file name found in the patch file. For more information see the strip parameter of the GNU patch tool. required: false - type: "int" default: "0" backup: version_added: "2.0" @@ -83,9 +82,8 @@ options: line endings into LF. Line endings of src and dest must match. If set to C(no), patch will replace CRLF in src files on POSIX. required: false - type: "bool" default: "no" -note: +notes: - This module requires GNU I(patch) utility to be installed on the remote host. ''' diff --git a/lib/ansible/modules/monitoring/bigpanda.py b/lib/ansible/modules/monitoring/bigpanda.py index cf67e535ce1..333dd119bd2 100644 --- a/lib/ansible/modules/monitoring/bigpanda.py +++ b/lib/ansible/modules/monitoring/bigpanda.py @@ -33,7 +33,7 @@ options: description: - "The name of the component being deployed. Ex: billing" required: true - alias: name + aliases: ['name'] version: description: - The deployment version. @@ -52,7 +52,7 @@ options: - Name of affected host name. Can be a list. required: false default: machine's hostname - alias: host + aliases: ['host'] env: description: - The environment name, typically 'production', 'staging', etc. diff --git a/lib/ansible/modules/network/bigswitch/bigmon_chain.py b/lib/ansible/modules/network/bigswitch/bigmon_chain.py index 8b28d142677..f7645ad8e0d 100644 --- a/lib/ansible/modules/network/bigswitch/bigmon_chain.py +++ b/lib/ansible/modules/network/bigswitch/bigmon_chain.py @@ -26,6 +26,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: bigmon_chain +author: "Ted (@tedelhourani)" short_description: Create and remove a bigmon inline service chain. description: - Create and remove a bigmon inline service chain. diff --git a/lib/ansible/modules/network/bigswitch/bigmon_policy.py b/lib/ansible/modules/network/bigswitch/bigmon_policy.py index dcf38777a11..8ca2ac8a64a 100644 --- a/lib/ansible/modules/network/bigswitch/bigmon_policy.py +++ b/lib/ansible/modules/network/bigswitch/bigmon_policy.py @@ -26,6 +26,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: bigmon_policy +author: "Ted (@tedelhourani)" short_description: Create and remove a bigmon out-of-band policy. description: - Create and remove a bigmon out-of-band policy. diff --git a/lib/ansible/modules/network/illumos/dladm_linkprop.py b/lib/ansible/modules/network/illumos/dladm_linkprop.py index e592a4ad048..81108d050b2 100644 --- a/lib/ansible/modules/network/illumos/dladm_linkprop.py +++ b/lib/ansible/modules/network/illumos/dladm_linkprop.py @@ -35,32 +35,28 @@ options: link: description: - Link interface name. - type: str required: true aliases: [ "nic", "interface" ] property: description: - Specifies the name of the property we want to manage. - type: str required: true aliases: [ "name" ] value: description: - Specifies the value we want to set for the link property. - type: str required: false temporary: description: - Specifies that lin property configuration is temporary. Temporary link property configuration does not persist across reboots. required: false - type: boolean + type: bool default: false state: description: - Set or reset the property value. required: false - type: str default: "present" choices: [ "present", "absent", "reset" ] ''' diff --git a/lib/ansible/modules/network/lenovo/cnos_backup.py b/lib/ansible/modules/network/lenovo/cnos_backup.py index dedd2d85dab..6969361533f 100644 --- a/lib/ansible/modules/network/lenovo/cnos_backup.py +++ b/lib/ansible/modules/network/lenovo/cnos_backup.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_backup +author: "Dave Kasberg (@dkasberg)" short_description: Backup the current running or startup configuration to a remote server on devices running Lenovo CNOS description: - This module allows you to work with switch configurations. It provides a diff --git a/lib/ansible/modules/network/lenovo/cnos_bgp.py b/lib/ansible/modules/network/lenovo/cnos_bgp.py index ef3ad475687..9f7513c91d3 100644 --- a/lib/ansible/modules/network/lenovo/cnos_bgp.py +++ b/lib/ansible/modules/network/lenovo/cnos_bgp.py @@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_bgp +author: "Dave Kasberg (@dkasberg)" short_description: Manage BGP resources and attributes on devices running Lenovo CNOS description: - This module allows you to work with Border Gateway Protocol (BGP) related configurations. diff --git a/lib/ansible/modules/network/lenovo/cnos_command.py b/lib/ansible/modules/network/lenovo/cnos_command.py index e542c236fe1..24b2efa2ccf 100644 --- a/lib/ansible/modules/network/lenovo/cnos_command.py +++ b/lib/ansible/modules/network/lenovo/cnos_command.py @@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_command +author: "Dave Kasberg (@dkasberg)" short_description: Execute a single command on devices running Lenovo CNOS description: - This module allows you to modify the switch running configuration. It provides a way to diff --git a/lib/ansible/modules/network/lenovo/cnos_conditional_command.py b/lib/ansible/modules/network/lenovo/cnos_conditional_command.py index 938acf405ee..a1db011880f 100644 --- a/lib/ansible/modules/network/lenovo/cnos_conditional_command.py +++ b/lib/ansible/modules/network/lenovo/cnos_conditional_command.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_conditional_command +author: "Dave Kasberg (@dkasberg)" short_description: Execute a single command based on condition on devices running Lenovo CNOS description: - This module allows you to modify the running configuration of a switch. It provides a way to diff --git a/lib/ansible/modules/network/lenovo/cnos_conditional_template.py b/lib/ansible/modules/network/lenovo/cnos_conditional_template.py index 0dc66a4bbe7..7d447206f62 100644 --- a/lib/ansible/modules/network/lenovo/cnos_conditional_template.py +++ b/lib/ansible/modules/network/lenovo/cnos_conditional_template.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_conditional_template +author: "Dave Kasberg (@dkasberg)" short_description: Manage switch configuration using templates based on condition on devices running Lenovo CNOS description: - This module allows you to work with the running configuration of a switch. It provides a way to diff --git a/lib/ansible/modules/network/lenovo/cnos_factory.py b/lib/ansible/modules/network/lenovo/cnos_factory.py index 8bc93c698c0..e70069f9327 100644 --- a/lib/ansible/modules/network/lenovo/cnos_factory.py +++ b/lib/ansible/modules/network/lenovo/cnos_factory.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_factory +author: "Dave Kasberg (@dkasberg)" short_description: Reset the switch's startup configuration to default (factory) on devices running Lenovo CNOS description: - This module allows you to reset a switch’s startup configuration. The method provides a way to reset the diff --git a/lib/ansible/modules/network/lenovo/cnos_facts.py b/lib/ansible/modules/network/lenovo/cnos_facts.py index 1994f2396fb..55c40cca3e1 100644 --- a/lib/ansible/modules/network/lenovo/cnos_facts.py +++ b/lib/ansible/modules/network/lenovo/cnos_facts.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_facts +author: "Dave Kasberg (@dkasberg)" short_description: Collect facts on devices running Lenovo CNOS description: - This module allows you to view the switch information. It executes the show sysinfo CLI command on a switch diff --git a/lib/ansible/modules/network/lenovo/cnos_image.py b/lib/ansible/modules/network/lenovo/cnos_image.py index 6d91850af30..fcaf0ace52a 100644 --- a/lib/ansible/modules/network/lenovo/cnos_image.py +++ b/lib/ansible/modules/network/lenovo/cnos_image.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_image +author: "Dave Kasberg (@dkasberg)" short_description: Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS description: - This module allows you to work with switch firmware images. It provides a way to download a firmware image diff --git a/lib/ansible/modules/network/lenovo/cnos_interface.py b/lib/ansible/modules/network/lenovo/cnos_interface.py index f5d97aa146c..fc35c2776c2 100644 --- a/lib/ansible/modules/network/lenovo/cnos_interface.py +++ b/lib/ansible/modules/network/lenovo/cnos_interface.py @@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_interface +author: "Dave Kasberg (@dkasberg)" short_description: Manage interface configuration on devices running Lenovo CNOS description: - This module allows you to work with interface related configurations. The operators used are diff --git a/lib/ansible/modules/network/lenovo/cnos_portchannel.py b/lib/ansible/modules/network/lenovo/cnos_portchannel.py index a6ceddba3ac..a5e90037e98 100644 --- a/lib/ansible/modules/network/lenovo/cnos_portchannel.py +++ b/lib/ansible/modules/network/lenovo/cnos_portchannel.py @@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_portchannel +author: "Dave Kasberg (@dkasberg)" short_description: Manage portchannel (port aggregation) configuration on devices running Lenovo CNOS description: - This module allows you to work with port aggregation related configurations. The operators diff --git a/lib/ansible/modules/network/lenovo/cnos_reload.py b/lib/ansible/modules/network/lenovo/cnos_reload.py index ea07593bfcf..fbaf319a231 100644 --- a/lib/ansible/modules/network/lenovo/cnos_reload.py +++ b/lib/ansible/modules/network/lenovo/cnos_reload.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_reload +author: "Dave Kasberg (@dkasberg)" short_description: Perform switch restart on devices running Lenovo CNOS description: - This module allows you to restart the switch using the current startup configuration. diff --git a/lib/ansible/modules/network/lenovo/cnos_rollback.py b/lib/ansible/modules/network/lenovo/cnos_rollback.py index c1e68903218..b34d9ebc391 100644 --- a/lib/ansible/modules/network/lenovo/cnos_rollback.py +++ b/lib/ansible/modules/network/lenovo/cnos_rollback.py @@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_rollback +author: "Dave Kasberg (@dkasberg)" short_description: Roll back the running or startup configuration from a remote server on devices running Lenovo CNOS description: - This module allows you to work with switch configurations. It provides a way to roll back configurations diff --git a/lib/ansible/modules/network/lenovo/cnos_save.py b/lib/ansible/modules/network/lenovo/cnos_save.py index 0ac74e2f77e..5e302cd9d60 100644 --- a/lib/ansible/modules/network/lenovo/cnos_save.py +++ b/lib/ansible/modules/network/lenovo/cnos_save.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_save +author: "Dave Kasberg (@dkasberg)" short_description: Save the running configuration as the startup configuration on devices running Lenovo CNOS description: - This module allows you to copy the running configuration of a switch over its startup configuration. diff --git a/lib/ansible/modules/network/lenovo/cnos_showrun.py b/lib/ansible/modules/network/lenovo/cnos_showrun.py index 1b2ec26cf85..90a486704f5 100644 --- a/lib/ansible/modules/network/lenovo/cnos_showrun.py +++ b/lib/ansible/modules/network/lenovo/cnos_showrun.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_showrun +author: "Dave Kasberg (@dkasberg)" short_description: Collect the current running configuration on devices running Lenovo CNOS description: - This module allows you to view the switch running configuration. It executes the display running-config CLI diff --git a/lib/ansible/modules/network/lenovo/cnos_template.py b/lib/ansible/modules/network/lenovo/cnos_template.py index 7cfc110fd70..212ad1a04ee 100644 --- a/lib/ansible/modules/network/lenovo/cnos_template.py +++ b/lib/ansible/modules/network/lenovo/cnos_template.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_template +author: "Dave Kasberg (@dkasberg)" short_description: Manage switch configuration using templates on devices running Lenovo CNOS description: - This module allows you to work with the running configuration of a switch. It provides a way diff --git a/lib/ansible/modules/network/lenovo/cnos_vlag.py b/lib/ansible/modules/network/lenovo/cnos_vlag.py index f6bc2af5282..8d9830e0d20 100644 --- a/lib/ansible/modules/network/lenovo/cnos_vlag.py +++ b/lib/ansible/modules/network/lenovo/cnos_vlag.py @@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_vlag +author: "Dave Kasberg (@dkasberg)" short_description: Manage VLAG resources and attributes on devices running Lenovo CNOS description: - This module allows you to work with virtual Link Aggregation Groups diff --git a/lib/ansible/modules/network/lenovo/cnos_vlan.py b/lib/ansible/modules/network/lenovo/cnos_vlan.py index be6515c9b0c..ad72e80d6c3 100644 --- a/lib/ansible/modules/network/lenovo/cnos_vlan.py +++ b/lib/ansible/modules/network/lenovo/cnos_vlan.py @@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: cnos_vlan +author: "Dave Kasberg (@dkasberg)" short_description: Manage VLAN resources and attributes on devices running Lenovo CNOS description: - This module allows you to work with VLAN related configurations. The diff --git a/lib/ansible/modules/network/netvisor/pn_cluster.py b/lib/ansible/modules/network/netvisor/pn_cluster.py index 12228b7ebda..30601890bb0 100644 --- a/lib/ansible/modules/network/netvisor/pn_cluster.py +++ b/lib/ansible/modules/network/netvisor/pn_cluster.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_cluster author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to create/delete a cluster. description: - Execute cluster-create or cluster-delete command. diff --git a/lib/ansible/modules/network/netvisor/pn_ospf.py b/lib/ansible/modules/network/netvisor/pn_ospf.py index d75c48558ba..f99ec61215c 100644 --- a/lib/ansible/modules/network/netvisor/pn_ospf.py +++ b/lib/ansible/modules/network/netvisor/pn_ospf.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_ospf author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to add/remove ospf protocol to a vRouter. description: - Execute vrouter-ospf-add, vrouter-ospf-remove command. diff --git a/lib/ansible/modules/network/netvisor/pn_ospfarea.py b/lib/ansible/modules/network/netvisor/pn_ospfarea.py index 2df554ec920..1a2329d18e9 100644 --- a/lib/ansible/modules/network/netvisor/pn_ospfarea.py +++ b/lib/ansible/modules/network/netvisor/pn_ospfarea.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_ospfarea author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to add/remove ospf area to/from a vrouter. description: - Execute vrouter-ospf-add, vrouter-ospf-remove command. diff --git a/lib/ansible/modules/network/netvisor/pn_show.py b/lib/ansible/modules/network/netvisor/pn_show.py index 87e321b8808..5feda23a85f 100644 --- a/lib/ansible/modules/network/netvisor/pn_show.py +++ b/lib/ansible/modules/network/netvisor/pn_show.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_show author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: Run show commands on nvOS device. description: - Execute show command in the nodes and returns the results diff --git a/lib/ansible/modules/network/netvisor/pn_trunk.py b/lib/ansible/modules/network/netvisor/pn_trunk.py index 35ef4e615d6..0b4defee0bf 100644 --- a/lib/ansible/modules/network/netvisor/pn_trunk.py +++ b/lib/ansible/modules/network/netvisor/pn_trunk.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_trunk author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to create/delete/modify a trunk. description: - Execute trunk-create or trunk-delete command. diff --git a/lib/ansible/modules/network/netvisor/pn_vlag.py b/lib/ansible/modules/network/netvisor/pn_vlag.py index 83cf1ac155e..2e8dd90e9aa 100644 --- a/lib/ansible/modules/network/netvisor/pn_vlag.py +++ b/lib/ansible/modules/network/netvisor/pn_vlag.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_vlag author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to create/delete/modify vlag. description: - Execute vlag-create/vlag-delete/vlag-modify command. diff --git a/lib/ansible/modules/network/netvisor/pn_vlan.py b/lib/ansible/modules/network/netvisor/pn_vlan.py index 77f26a2a194..b55c4dae917 100644 --- a/lib/ansible/modules/network/netvisor/pn_vlan.py +++ b/lib/ansible/modules/network/netvisor/pn_vlan.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_vlan author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to create/delete a VLAN. description: - Execute vlan-create or vlan-delete command. diff --git a/lib/ansible/modules/network/netvisor/pn_vrouter.py b/lib/ansible/modules/network/netvisor/pn_vrouter.py index 255220e78ed..d7be94a0db7 100644 --- a/lib/ansible/modules/network/netvisor/pn_vrouter.py +++ b/lib/ansible/modules/network/netvisor/pn_vrouter.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_vrouter author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1 short_description: CLI command to create/delete/modify a vrouter. description: - Execute vrouter-create, vrouter-delete, vrouter-modify command. diff --git a/lib/ansible/modules/network/netvisor/pn_vrouterbgp.py b/lib/ansible/modules/network/netvisor/pn_vrouterbgp.py index f0b78e4fb42..9c50de130f9 100644 --- a/lib/ansible/modules/network/netvisor/pn_vrouterbgp.py +++ b/lib/ansible/modules/network/netvisor/pn_vrouterbgp.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_vrouterbgp author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to add/remove/modify vrouter-bgp. description: - Execute vrouter-bgp-add, vrouter-bgp-remove, vrouter-bgp-modify command. diff --git a/lib/ansible/modules/network/netvisor/pn_vrouterif.py b/lib/ansible/modules/network/netvisor/pn_vrouterif.py index 6da1a0b177d..111fefdb66a 100644 --- a/lib/ansible/modules/network/netvisor/pn_vrouterif.py +++ b/lib/ansible/modules/network/netvisor/pn_vrouterif.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_vrouterif author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to add/remove/modify vrouter-interface. description: - Execute vrouter-interface-add, vrouter-interface-remove, diff --git a/lib/ansible/modules/network/netvisor/pn_vrouterlbif.py b/lib/ansible/modules/network/netvisor/pn_vrouterlbif.py index c0c63752905..e19864b997d 100644 --- a/lib/ansible/modules/network/netvisor/pn_vrouterlbif.py +++ b/lib/ansible/modules/network/netvisor/pn_vrouterlbif.py @@ -27,7 +27,6 @@ DOCUMENTATION = """ module: pn_vrouterlbif author: "Pluribus Networks (@amitsi)" version_added: "2.2" -version: 1.0 short_description: CLI command to add/remove vrouter-loopback-interface. description: - Execute vrouter-loopback-interface-add, vrouter-loopback-interface-remove diff --git a/lib/ansible/modules/network/panos/panos_interface.py b/lib/ansible/modules/network/panos/panos_interface.py index cf7288dc70a..de3ae724e32 100644 --- a/lib/ansible/modules/network/panos/panos_interface.py +++ b/lib/ansible/modules/network/panos/panos_interface.py @@ -33,7 +33,7 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)" version_added: "2.3" requirements: - pan-python can be obtained from PyPi U(https://pypi.python.org/pypi/pan-python) -note: +notes: - Checkmode is not supported. options: ip_address: diff --git a/lib/ansible/modules/notification/cisco_spark.py b/lib/ansible/modules/notification/cisco_spark.py index abb2f9165f5..fa3245934e5 100644 --- a/lib/ansible/modules/notification/cisco_spark.py +++ b/lib/ansible/modules/notification/cisco_spark.py @@ -39,7 +39,7 @@ options: recipient_type: description: - - The request parametmer you would like to send the message to. + - The request parameter you would like to send the message to. - Messages can be sent to either a room or individual (by ID or E-Mail). required: True choices: ['roomId', 'toPersonEmail', 'toPersonId'] @@ -59,7 +59,7 @@ options: personal_token: description: - Your personal access token required to validate the Spark API. - require: true + required: true aliases: ['token'] message: diff --git a/lib/ansible/modules/packaging/os/apk.py b/lib/ansible/modules/packaging/os/apk.py index 8d8c5a6f808..04e305440fd 100644 --- a/lib/ansible/modules/packaging/os/apk.py +++ b/lib/ansible/modules/packaging/os/apk.py @@ -28,6 +28,7 @@ module: apk short_description: Manages apk packages description: - Manages I(apk) packages for Alpine Linux. +author: "Kevin Brebanov (@kbrebanov)" version_added: "2.0" options: name: diff --git a/lib/ansible/modules/packaging/os/homebrew_tap.py b/lib/ansible/modules/packaging/os/homebrew_tap.py index 6562c0bcee1..2dff3f52da7 100644 --- a/lib/ansible/modules/packaging/os/homebrew_tap.py +++ b/lib/ansible/modules/packaging/os/homebrew_tap.py @@ -46,11 +46,10 @@ options: - The optional git URL of the repository to tap. The URL is not assumed to be on GitHub, and the protocol doesn't have to be HTTP. Any location and protocol that git can handle is fine. - required: false - version_added: "2.2" - note: - I(name) option may not be a list of multiple taps (but a single tap instead) when this option is provided. + required: false + version_added: "2.2" state: description: - state of the repository. diff --git a/lib/ansible/modules/packaging/os/package.py b/lib/ansible/modules/packaging/os/package.py index 85712b6d903..461800bbc1b 100644 --- a/lib/ansible/modules/packaging/os/package.py +++ b/lib/ansible/modules/packaging/os/package.py @@ -29,8 +29,6 @@ module: package version_added: 2.0 author: - Ansible Inc -maintainers: - - Ansible Core Team short_description: Generic OS package manager description: - Installs, upgrade and removes packages using the underlying OS package manager. diff --git a/lib/ansible/modules/packaging/os/portage.py b/lib/ansible/modules/packaging/os/portage.py index da501271937..5b0f205a4d5 100644 --- a/lib/ansible/modules/packaging/os/portage.py +++ b/lib/ansible/modules/packaging/os/portage.py @@ -165,7 +165,6 @@ options: - Specifies the number of packages to build simultaneously. required: false default: None - type: int version_added: 2.3 loadavg: @@ -174,7 +173,6 @@ options: - other builds running and the load average is at least LOAD required: false default: None - type: float version_added: 2.3 requirements: [ gentoolkit ] diff --git a/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py b/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py index 514422dadcc..5c1c90f869e 100644 --- a/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py +++ b/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py @@ -36,7 +36,6 @@ options: description: - Remote RMCP port. required: false - type: int default: 623 user: description: @@ -70,7 +69,7 @@ options: - If set, ask that system firmware uses this device beyond next boot. Be aware many systems do not honor this. required: false - type: boolean + type: bool default: false uefiboot: description: @@ -78,7 +77,7 @@ options: 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: boolean + type: bool default: false requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/remote_management/ipmi/ipmi_power.py b/lib/ansible/modules/remote_management/ipmi/ipmi_power.py index 137cf44b388..6871e896ac7 100644 --- a/lib/ansible/modules/remote_management/ipmi/ipmi_power.py +++ b/lib/ansible/modules/remote_management/ipmi/ipmi_power.py @@ -36,7 +36,6 @@ options: description: - Remote RMCP port. required: false - type: int default: 623 user: description: @@ -61,7 +60,6 @@ options: description: - Maximum number of seconds before interrupt request. required: false - type: int default: 300 requirements: - "python >= 2.6" diff --git a/lib/ansible/modules/remote_management/stacki/stacki_host.py b/lib/ansible/modules/remote_management/stacki/stacki_host.py index a0e82d39c52..2a8743933d8 100644 --- a/lib/ansible/modules/remote_management/stacki/stacki_host.py +++ b/lib/ansible/modules/remote_management/stacki/stacki_host.py @@ -62,7 +62,7 @@ options: force_install: description: - Set value to True to force node into install state if it already exists in stacki. - requiored: False + required: False author: "Hugh Ma " ''' diff --git a/lib/ansible/modules/storage/netapp/na_cdot_license.py b/lib/ansible/modules/storage/netapp/na_cdot_license.py index 095034e862e..a504e5b34a7 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_license.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_license.py @@ -57,21 +57,35 @@ options: description: - List of licenses to add or remove. - Please note that trying to remove a non-existent license will throw an error. - valid_options: - - base : Cluster Base License, - - nfs : NFS License, - - cifs : CIFS License, - - iscsi : iSCSI License, - - fcp : FCP License, - - cdmi : CDMI License, - - snaprestore : SnapRestore License, - - snapmirror : SnapMirror License, - - flexclone : FlexClone License, - - snapvault : SnapVault License, - - snaplock : SnapLock License, - - snapmanagersuite : SnapManagerSuite License, - - snapprotectapps : SnapProtectApp License, - - v_storageattach : Virtual Attached Storage License + suboptions: + base: + description: Cluster Base License + nfs: + description: NFS License + cifs: + description: CIFS License + iscsi: + description: iSCSI License + fcp: + description: FCP License + cdmi: + description: CDMI License + snaprestore: + description: SnapRestore License + snapmirror: + description: SnapMirror License + flexclone: + description: FlexClone License + snapvault: + description: SnapVault License + snaplock: + description: SnapLock License + snapmanagersuite: + description: SnapManagerSuite License + snapprotectapps: + description: SnapProtectApp License + v_storageattach: + description: Virtual Attached Storage License ''' diff --git a/lib/ansible/modules/storage/netapp/na_cdot_qtree.py b/lib/ansible/modules/storage/netapp/na_cdot_qtree.py index 348c8dce3c2..7e2c708ef47 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_qtree.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_qtree.py @@ -49,8 +49,7 @@ options: flexvol_name: description: - - The name of the FlexVol the Qtree should exist on. - note: required when C(state=present) + - The name of the FlexVol the Qtree should exist on. Required when C(state=present). vserver: description: diff --git a/lib/ansible/modules/storage/netapp/na_cdot_svm.py b/lib/ansible/modules/storage/netapp/na_cdot_svm.py index 0051b387291..1f0b8595e5c 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_svm.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_svm.py @@ -49,13 +49,12 @@ options: root_volume: description: - - Root volume of the SVM. - note: required when C(state=present) + - Root volume of the SVM. Required when C(state=present). root_volume_aggregate: description: - The aggregate on which the root volume will be created. - note: required when C(state=present) + - Required when C(state=present). root_volume_security_style: description: @@ -65,7 +64,7 @@ options: - Possible values are 'unix', 'ntfs', 'mixed'. - The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume. - Valid options are "unix" for NFS, "ntfs" for CIFS, "mixed" for Mixed, "unified" for Unified. - note: required when C(state=present) + - Required when C(state=present) choices: ['unix', 'ntfs', 'mixed', 'unified'] ''' diff --git a/lib/ansible/modules/storage/netapp/na_cdot_user.py b/lib/ansible/modules/storage/netapp/na_cdot_user.py index b79181c4242..0cc71a7c327 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_user.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_user.py @@ -58,7 +58,6 @@ options: - Authentication method for the application. - Not all authentication methods are valid for an application. - Valid authentication methods for each application are as denoted in I(authentication_choices_description). - authentication_choices_description: - password for console application - password, domain, nsswitch, cert for http application. - password, domain, nsswitch, cert for ontapi application. @@ -80,8 +79,7 @@ options: role_name: description: - - The name of the role. - note: required when C(state=present) + - The name of the role. Required when C(state=present) vserver: diff --git a/lib/ansible/modules/storage/netapp/na_cdot_volume.py b/lib/ansible/modules/storage/netapp/na_cdot_volume.py index f99f9a6c19e..32206a57281 100644 --- a/lib/ansible/modules/storage/netapp/na_cdot_volume.py +++ b/lib/ansible/modules/storage/netapp/na_cdot_volume.py @@ -61,13 +61,11 @@ options: aggregate_name: description: - - The name of the aggregate the flexvol should exist on. - note: required when C(state=present) + - The name of the aggregate the flexvol should exist on. Required when C(state=present). size: description: - - The size of the volume in (size_unit). - note: required when C(state=present) + - The size of the volume in (size_unit). Required when C(state=present). size_unit: description: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py index bfe3c4b8334..c45b408c159 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py @@ -42,8 +42,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py index 548b115ff0a..fade7025ed3 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py @@ -42,8 +42,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_facts.py b/lib/ansible/modules/storage/netapp/netapp_e_facts.py index 5a877afab61..816e5687d20 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_facts.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_facts.py @@ -38,8 +38,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py index da7d520542b..5ccdf81615f 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py @@ -41,8 +41,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_host.py b/lib/ansible/modules/storage/netapp/netapp_e_host.py index 458bb6fb8b6..68bc07bfd42 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_host.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_host.py @@ -41,9 +41,7 @@ options: api_url: required: true description: - - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 + - The url to the SANtricity WebServices Proxy or embedded REST API, for example C(https://prod-1.wahoo.acme.com/devmgr/v2). validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py index f89397af59d..0fb05443462 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py @@ -44,8 +44,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py index f0464bbf7c8..48527b1b230 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py @@ -42,8 +42,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py index 460d1a2a0c1..bb064ab8f6d 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py @@ -44,8 +44,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py index 87e08fb5af7..3bb5b479e06 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py @@ -29,7 +29,8 @@ description: - Create, update, remove snapshot volumes for NetApp E/EF-Series storage arrays. version_added: '2.2' author: Kevin Hulquest (@hulquest) -note: Only I(full_threshold) is supported for update operations. If the snapshot volume already exists and the threshold matches, then an C(ok) status will be returned, no other changes can be made to a pre-existing snapshot volume. +notes: + - Only I(full_threshold) is supported for update operations. If the snapshot volume already exists and the threshold matches, then an C(ok) status will be returned, no other changes can be made to a pre-existing snapshot volume. options: api_username: required: true @@ -43,8 +44,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true 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 64414af6f1e..ec9827beaf0 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py @@ -40,8 +40,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py index 89309708efd..0f4faeb71d7 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py @@ -41,8 +41,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_volume.py index 04820a30083..04812337ffd 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume.py @@ -42,8 +42,6 @@ options: required: true description: - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py index 179ee8ff5ad..e368c091c8a 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py @@ -41,9 +41,7 @@ options: api_url: required: true description: - - The url to the SANtricity WebServices Proxy or embedded REST API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 + - The url to the SANtricity WebServices Proxy or embedded REST API, for example C(https://prod-1.wahoo.acme.com/devmgr/v2). validate_certs: required: false default: true diff --git a/lib/ansible/modules/storage/netapp/sf_snapshot_schedule_manager.py b/lib/ansible/modules/storage/netapp/sf_snapshot_schedule_manager.py index b063204b863..be377ea22b9 100644 --- a/lib/ansible/modules/storage/netapp/sf_snapshot_schedule_manager.py +++ b/lib/ansible/modules/storage/netapp/sf_snapshot_schedule_manager.py @@ -98,8 +98,8 @@ options: - Starting date for the schedule. - Required when C(state=present). - Please use two '-' in the above format, or you may see an error- TypeError, is not JSON serializable description. + - "Format: C(2016--12--01T00:00:00Z)" required: false - format: 2016--12--01T00:00:00Z ''' EXAMPLES = """ diff --git a/lib/ansible/modules/storage/netapp/sf_volume_manager.py b/lib/ansible/modules/storage/netapp/sf_volume_manager.py index 26751561c45..3e244f0bc39 100644 --- a/lib/ansible/modules/storage/netapp/sf_volume_manager.py +++ b/lib/ansible/modules/storage/netapp/sf_volume_manager.py @@ -90,16 +90,15 @@ options: default: 'gb' access: - description: - - Access allowed for the volume. required: false choices: ['readOnly', 'readWrite', 'locked', 'replicationTarget'] - access_type_description: - - readOnly: Only read operations are allowed. - - readWrite: Reads and writes are allowed. - - 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. + description: + - "Access allowed for the volume." + - "readOnly: Only read operations are allowed." + - "readWrite: Reads and writes are allowed." + - "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 ''' diff --git a/lib/ansible/modules/storage/zfs/zfs_facts.py b/lib/ansible/modules/storage/zfs/zfs_facts.py index 178273ce5d0..b51aeba968e 100644 --- a/lib/ansible/modules/storage/zfs/zfs_facts.py +++ b/lib/ansible/modules/storage/zfs/zfs_facts.py @@ -35,8 +35,7 @@ options: name: description: - ZFS dataset name. - alias: [ "ds", "dataset" ] - type: str + aliases: [ "ds", "dataset" ] required: yes recurse: description: @@ -56,23 +55,20 @@ options: description: - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zfs(1M) man page. - alias: [ "props" ] - type: str + aliases: [ "props" ] default: all required: false type: description: - Specifies which datasets types to display. Multiple values have to be provided in comma-separated form. - alias: [ "props" ] - type: str + aliases: [ "props" ] default: all choices: [ 'all', 'filesystem', 'volume', 'snapshot', 'bookmark' ] required: false depth: description: - Specifiies recurion depth. - type: int default: None required: false ''' diff --git a/lib/ansible/modules/storage/zfs/zpool_facts.py b/lib/ansible/modules/storage/zfs/zpool_facts.py index ba9dbccfe7d..286d544abe7 100644 --- a/lib/ansible/modules/storage/zfs/zpool_facts.py +++ b/lib/ansible/modules/storage/zfs/zpool_facts.py @@ -35,8 +35,7 @@ options: name: description: - ZFS pool name. - alias: [ "pool", "zpool" ] - type: str + aliases: [ "pool", "zpool" ] required: false parsable: description: @@ -49,8 +48,7 @@ options: description: - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zpool(1M) man page. - alias: [ "props" ] - type: str + aliases: [ "props" ] default: all required: false ''' diff --git a/lib/ansible/modules/system/aix_inittab.py b/lib/ansible/modules/system/aix_inittab.py index 449887d9950..3a17fc7cc70 100644 --- a/lib/ansible/modules/system/aix_inittab.py +++ b/lib/ansible/modules/system/aix_inittab.py @@ -35,12 +35,10 @@ options: name: description: Name of the inittab entry. required: True - alias: service - type: string + aliases: ['service'] runlevel: description: Runlevel of the entry. required: True - type: string action: description: Action what the init has to do with this entry. required: True @@ -58,22 +56,17 @@ options: 'initdefault', 'sysinit' ] - type: string command: description: What command has to run. required: True - type: string insertafter: description: After which inittabline should the new entry inserted. - type: string state: description: Whether the entry should be present or absent in the inittab file - type: string choices: [ "present", "absent" ] default: present notes: - - The changes are persistent across reboots. - - You need root rights to read or adjust the inittab with the lsitab, chitab, + - The changes are persistent across reboots, you need root rights to read or adjust the inittab with the lsitab, chitab, mkitab or rmitab commands. - tested on AIX 7.1. requirements: [ 'itertools'] diff --git a/lib/ansible/modules/system/beadm.py b/lib/ansible/modules/system/beadm.py index 70ad08f91bf..3744588b78d 100644 --- a/lib/ansible/modules/system/beadm.py +++ b/lib/ansible/modules/system/beadm.py @@ -36,7 +36,7 @@ options: name: description: - ZFS boot environment name. - alias: [ "be" ] + aliases: [ "be" ] required: True snapshot: description: diff --git a/lib/ansible/modules/system/pam_limits.py b/lib/ansible/modules/system/pam_limits.py index 2ba934ab8da..ecef1be4587 100644 --- a/lib/ansible/modules/system/pam_limits.py +++ b/lib/ansible/modules/system/pam_limits.py @@ -26,7 +26,7 @@ DOCUMENTATION = ''' --- module: pam_limits version_added: "2.0" -authors: +author: - "Sebastien Rohaut (@usawa)" short_description: Modify Linux PAM limits description: diff --git a/lib/ansible/modules/system/ufw.py b/lib/ansible/modules/system/ufw.py index 92cd06ca2ee..347f4092edb 100644 --- a/lib/ansible/modules/system/ufw.py +++ b/lib/ansible/modules/system/ufw.py @@ -53,7 +53,7 @@ options: description: - Change the default policy for incoming or outgoing traffic. required: false - alias: default + aliases: ['default'] choices: ['allow', 'deny', 'reject'] direction: description: 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 9b17e0bd8d4..57f66f4baca 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_credential +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower credential. description: 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 738b5ea071d..bb0bafc94d1 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_group.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_group +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower group. description: 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 12562e999b2..77819f44469 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_host.py @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: tower_host version_added: "2.3" +author: "Wayne Witzel III (@wwitzel3)" short_description: create, update, or destroy Ansible Tower host. description: - Create, update, or destroy Ansible Tower hosts. See 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 5eac8724c2a..71983e04149 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory.py @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: tower_inventory version_added: "2.3" +author: "Wayne Witzel III (@wwitzel3)" short_description: create, update, or destroy Ansible Tower inventory. description: - Create, update, or destroy Ansible Tower inventories. See diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py index 2f0042bce08..70b2f9ec2b7 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_job_cancel +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: Cancel an Ansible Tower Job. description: 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 3a7679d9d13..4d1d5fdf858 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 @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_job_launch +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: Launch an Ansible Job. description: 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 5c9c82f7f37..3b32b82bb3d 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 @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_job_list +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: List Ansible Tower jobs. description: 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 d50f0fce160..f06e84267c2 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 @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_job_template +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower job_template. description: 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 166d0a277f6..c1e9db77489 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 @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: tower_job_wait version_added: "2.3" +author: "Wayne Witzel III (@wwitzel3)" short_description: Wait for Ansible Tower job to finish. description: - Wait for Ansible Tower job to finish and report success or failure. See 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 dc6b2325825..4f8403bab05 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_label.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_label +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower label. description: 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 406c3804347..721e139770a 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_organization.py @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: tower_organization version_added: "2.3" +author: "Wayne Witzel III (@wwitzel3)" short_description: create, update, or destroy Ansible Tower organizations description: - Create, update, or destroy Ansible Tower organizations. See 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 dda5435bd6a..0079fa4a51f 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_project.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_project +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower projects description: 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 47982f67d71..4538bb19006 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_role.py @@ -24,6 +24,7 @@ DOCUMENTATION = ''' --- module: tower_role version_added: "2.3" +author: "Wayne Witzel III (@wwitzel3)" short_description: create, update, or destroy Ansible Tower role. description: - Create, update, or destroy Ansible Tower roles. See 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 9dd1da95868..29a3cd8dc14 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_team.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_team +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower team. description: 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 ad879a73291..85d3ed6e630 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_user.py @@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_user +author: "Wayne Witzel III (@wwitzel3)" version_added: "2.3" short_description: create, update, or destroy Ansible Tower user. description: diff --git a/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py b/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py index 71ae8a0b48b..e43b4045888 100644 --- a/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py +++ b/lib/ansible/modules/web_infrastructure/apache2_mod_proxy.py @@ -25,6 +25,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: apache2_mod_proxy +author: Olivier Boukili (@oboukili)" version_added: "2.2" short_description: Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool description: diff --git a/lib/ansible/modules/web_infrastructure/htpasswd.py b/lib/ansible/modules/web_infrastructure/htpasswd.py index 0c5d8bea9d6..b0bd75d71cd 100644 --- a/lib/ansible/modules/web_infrastructure/htpasswd.py +++ b/lib/ansible/modules/web_infrastructure/htpasswd.py @@ -72,7 +72,7 @@ notes: - "This module depends on the I(passlib) Python library, which needs to be installed on all target systems." - "On Debian, Ubuntu, or Fedora: install I(python-passlib)." - "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)." -requires: [ passlib>=1.6 ] +requirements: [ passlib>=1.6 ] author: "Ansible Core Team" """ diff --git a/lib/ansible/modules/web_infrastructure/jenkins_script.py b/lib/ansible/modules/web_infrastructure/jenkins_script.py index df77d4549c6..02494c3fdac 100644 --- a/lib/ansible/modules/web_infrastructure/jenkins_script.py +++ b/lib/ansible/modules/web_infrastructure/jenkins_script.py @@ -62,7 +62,7 @@ options: password: description: - The password to connect to the jenkins server with. - require: false + required: false default: null args: description: diff --git a/lib/ansible/modules/web_infrastructure/letsencrypt.py b/lib/ansible/modules/web_infrastructure/letsencrypt.py index 527f4b9a280..b00278dde14 100644 --- a/lib/ansible/modules/web_infrastructure/letsencrypt.py +++ b/lib/ansible/modules/web_infrastructure/letsencrypt.py @@ -88,7 +88,7 @@ options: will lead to an individual challenge that must be fulfilled for the CSR to be signed." required: true - alias: ['src'] + aliases: ['src'] data: description: - "The data to validate ongoing challenges." @@ -99,7 +99,7 @@ options: dest: description: The destination file for the certificate. required: true - alias: ['cert'] + aliases: ['cert'] remaining_days: description: - "The number of days the certificate must have left being valid. diff --git a/lib/ansible/modules/windows/win_chocolatey.py b/lib/ansible/modules/windows/win_chocolatey.py index 40295501935..315a7f4f426 100644 --- a/lib/ansible/modules/windows/win_chocolatey.py +++ b/lib/ansible/modules/windows/win_chocolatey.py @@ -59,7 +59,6 @@ options: description: - If package is already installed it, try to upgrade to the latest version or to the specified version. - As of Ansible v2.3 this is deprecated, set parameter C(state) to "latest" for the same result. - version_removed: '2.3' choices: - yes - no @@ -97,7 +96,7 @@ options: execution_timeout: description: - Timeout to pass to the native installer - require: false + required: false version_added: '2.3' author: "Trond Hindenes (@trondhindenes), Peter Mounce (@petemounce), Pepe Barbe (@elventear), Adam Keech (@smadam813)" ''' diff --git a/lib/ansible/modules/windows/win_psexec.py b/lib/ansible/modules/windows/win_psexec.py index 6fd2e4a63e6..836ca9832a1 100644 --- a/lib/ansible/modules/windows/win_psexec.py +++ b/lib/ansible/modules/windows/win_psexec.py @@ -92,7 +92,7 @@ options: - Wait for the application to terminate. - Only use for non-interactive applications. default: True -requires: [ psexec ] +requirements: [ psexec ] author: Dag Wieers (@dagwieers) ''' diff --git a/lib/ansible/modules/windows/win_robocopy.py b/lib/ansible/modules/windows/win_robocopy.py index 2ffb33441ac..2033eaa5ed4 100644 --- a/lib/ansible/modules/windows/win_robocopy.py +++ b/lib/ansible/modules/windows/win_robocopy.py @@ -47,7 +47,7 @@ options: choices: - true - false - defaults: false + default: false required: false purge: description: @@ -55,7 +55,7 @@ options: choices: - true - false - defaults: false + default: false required: false flags: description: diff --git a/lib/ansible/modules/windows/win_scheduled_task.py b/lib/ansible/modules/windows/win_scheduled_task.py index a21fe927262..807698655a0 100644 --- a/lib/ansible/modules/windows/win_scheduled_task.py +++ b/lib/ansible/modules/windows/win_scheduled_task.py @@ -25,6 +25,7 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = r''' --- module: win_scheduled_task +author: "Peter Mounce" version_added: "2.0" short_description: Manage scheduled tasks description: diff --git a/lib/ansible/modules/windows/win_stat.py b/lib/ansible/modules/windows/win_stat.py index aff0a4a5955..518e3d50f54 100644 --- a/lib/ansible/modules/windows/win_stat.py +++ b/lib/ansible/modules/windows/win_stat.py @@ -44,7 +44,6 @@ options: C(checksum_algorithm=md5). required: no default: True - version_removed: "2.3" get_checksum: description: - Whether to return a checksum of the file (default sha1) diff --git a/lib/ansible/modules/windows/win_unzip.py b/lib/ansible/modules/windows/win_unzip.py index 1525db07db7..cff6e95831d 100644 --- a/lib/ansible/modules/windows/win_unzip.py +++ b/lib/ansible/modules/windows/win_unzip.py @@ -34,7 +34,7 @@ description: - Unzips compressed files and archives. - Supports .zip files natively - Supports other formats supported by the Powershell Community Extensions (PSCX) module (basically everything 7zip supports) -requires: +requirements: - PSCX options: src: