ansible / ansible.builtin / v2.9.7 / module / ec2_vpc_dhcp_option_info Gather information about dhcp options sets in AWS | "added in version" 2.2 of ansible.builtin" Authors: Nick Aslanidis (@naslanidis) preview | supported by communityansible.builtin.ec2_vpc_dhcp_option_info (v2.9.7) — module
pip
Install with pip install ansible==2.9.7
Gather information about dhcp options sets in AWS
This module was called C(ec2_vpc_dhcp_option_facts) before Ansible 2.9. The usage did not change.
# # Note: These examples do not set authentication details, see the AWS Guide for details. - name: Gather information about all DHCP Option sets for an account or profile ec2_vpc_dhcp_option_info: region: ap-southeast-2 profile: production register: dhcp_info
- name: Gather information about a filtered list of DHCP Option sets ec2_vpc_dhcp_option_info: region: ap-southeast-2 profile: production filters: "tag:Name": "abc-123" register: dhcp_info
- name: Gather information about a specific DHCP Option set by DhcpOptionId ec2_vpc_dhcp_option_info: region: ap-southeast-2 profile: production DhcpOptionsIds: dopt-123fece2 register: dhcp_info
region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeDhcpOptions.html) for possible filters. profile: aliases: - aws_profile description: - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - The I(aws_access_key) and I(profile) options are mutually exclusive. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - The I(aws_secret_key) and I(profile) options are mutually exclusive. type: str security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool dhcp_options_ids: aliases: - DhcpOptionIds description: - Get details of specific DHCP Option ID - Provide this value as a list debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool
changed: description: True if listing the dhcp options succeeds returned: always type: bool dhcp_options: description: The dhcp option sets for the account returned: always type: list