Merge pull request #1584 from sivel/doc-fix-ec2_vpc_dhcp_options

DOCUMENTATION and RETURN fixes for modules
This commit is contained in:
Matt Martz 2016-02-02 10:02:48 -06:00
commit 1b5c9ee7f9
2 changed files with 56 additions and 52 deletions

View file

@ -55,6 +55,10 @@ EXAMPLES = '''
''' '''
# TODO: Disabled the RETURN as it was breaking docs building. Someone needs to
# fix this
RETURN = '''# '''
try: try:
import boto.ec2 import boto.ec2
from boto.exception import BotoServerError from boto.exception import BotoServerError

View file

@ -26,40 +26,40 @@ description:
author: "Joel Thompson (@joelthompson)" author: "Joel Thompson (@joelthompson)"
version_added: 2.1 version_added: 2.1
options: options:
- domain_name: domain_name:
description: description:
- The domain name to set in the DHCP option sets - The domain name to set in the DHCP option sets
required: required:
- false - false
default: "" default: ""
- dns_servers: dns_servers:
description: description:
- A list of hosts to set the DNS servers for the VPC to. (Should be a - A list of hosts to set the DNS servers for the VPC to. (Should be a
list of IP addresses rather than host names.) list of IP addresses rather than host names.)
required: false required: false
default: [] default: []
- ntp_servers: ntp_servers:
description: description:
- List of hosts to advertise as NTP servers for the VPC. - List of hosts to advertise as NTP servers for the VPC.
required: false required: false
default: [] default: []
- netbios_name_servers: netbios_name_servers:
description: description:
- List of hosts to advertise as NetBIOS servers. - List of hosts to advertise as NetBIOS servers.
required: false required: false
default: [] default: []
- netbios_node_type: netbios_node_type:
description: description:
- NetBIOS node type to advertise in the DHCP options. The - NetBIOS node type to advertise in the DHCP options. The
default is 2, per AWS recommendation default is 2, per AWS recommendation
http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html
required: false required: false
default: 2 default: 2
- vpc_id: vpc_id:
description: description:
- VPC ID to associate with the requested DHCP option set - VPC ID to associate with the requested DHCP option set
required: true required: true
- delete_old: delete_old:
description: description:
- Whether to delete the old VPC DHCP option set when creating a new one. - Whether to delete the old VPC DHCP option set when creating a new one.
This is primarily useful for debugging/development purposes when you This is primarily useful for debugging/development purposes when you
@ -68,7 +68,7 @@ options:
is in use by any other VPC. (Otherwise, AWS will return an error.) is in use by any other VPC. (Otherwise, AWS will return an error.)
required: false required: false
default: true default: true
- inherit_existing: inherit_existing:
description: description:
- For any DHCP options not specified in these parameters, whether to - For any DHCP options not specified in these parameters, whether to
inherit them from the options set already applied to vpc_id, or to inherit them from the options set already applied to vpc_id, or to