ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 14:41:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Fix invalid fields in module DOCUMENATION (#22297)

Browse source 
* 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
This commit is contained in:
John R Barker 2017-03-09 16:20:25 +00:00 • committed by GitHub
commit e5b990a55a
138 changed files with 176 additions and 256 deletions
Download patch file Download diff file Expand all files Collapse all files

29
lib/ansible/modules/cloud/amazon/_ec2_vpc.py
View file

@ -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)"

2
lib/ansible/modules/cloud/amazon/cloudformation.py
View file

@ -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 = '''

8
lib/ansible/modules/cloud/amazon/ec2_elb_lb.py
View file

@ -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:

2
lib/ansible/modules/cloud/amazon/ec2_lc.py
View file

@ -118,7 +118,7 @@ options:
extends_documentation_fragment:
- aws
- ec2
requires:
requirements:
- "boto >= 2.39.0"
"""

6
lib/ansible/modules/cloud/amazon/ec2_metric_alarm.py
View file

@ -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

1
lib/ansible/modules/cloud/amazon/ec2_vol.py
View file

@ -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"

2
lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py
View file

@ -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:

3
lib/ansible/modules/cloud/amazon/ecs_service.py
View file

@ -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)"

3
lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py
View file

@ -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

3
lib/ansible/modules/cloud/amazon/elasticache_parameter_group.py
View file

@ -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
"""

5
lib/ansible/modules/cloud/amazon/elasticache_snapshot.py
View file

@ -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
"""

4
lib/ansible/modules/cloud/amazon/s3_sync.py
View file

@ -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.