mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Fix DOCUMENTATION for ec2_vpc_dhcp_options.py and add missing RETURN to ec2_vol_facts.py
This commit is contained in:
parent
8eeb30da3d
commit
78759c667a
2 changed files with 56 additions and 52 deletions
|
@ -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
|
||||||
|
|
|
@ -20,61 +20,61 @@ short_description: Ensures the DHCP options for the given VPC match what's
|
||||||
requested
|
requested
|
||||||
description:
|
description:
|
||||||
- Converges the DHCP option set for the given VPC to the variables requested.
|
- Converges the DHCP option set for the given VPC to the variables requested.
|
||||||
If any of the optional values are missing, they will either be treated
|
If any of the optional values are missing, they will either be treated
|
||||||
as a no-op (i.e., inherit what already exists for the VPC) or a purge of
|
as a no-op (i.e., inherit what already exists for the VPC) or a purge of
|
||||||
existing options. Most of the options should be self-explanatory.
|
existing options. Most of the options should be self-explanatory.
|
||||||
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
|
||||||
want to quickly roll back to the old option set. Note that this setting
|
want to quickly roll back to the old option set. Note that this setting
|
||||||
will be ignored, and the old DHCP option set will be preserved, if it
|
will be ignored, and the old DHCP option set will be preserved, if it
|
||||||
is in use by any other VPC. (Otherwise, AWS will return an error.)
|
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
|
||||||
reset them to be empty.
|
reset them to be empty.
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
extends_documentation_fragment: aws
|
extends_documentation_fragment: aws
|
||||||
requirements:
|
requirements:
|
||||||
- boto
|
- boto
|
||||||
|
|
Loading…
Reference in a new issue