amazon.aws.ec2_vpc_dhcp_option_info module – Gather information about dhcp options sets in AWS

Note

This module is part of the amazon.aws collection (version 3.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws.

To use it in a playbook, specify: amazon.aws.ec2_vpc_dhcp_option_info.

New in version 1.0.0: of amazon.aws

Synopsis

  • Gather information about dhcp options sets in AWS.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.16.0

  • botocore >= 1.19.0

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, access_key

string

AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

Not used by boto 2 based modules.

Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

aliases: ec2_secret_key, secret_key

string

AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • no ← (default)

  • yes

dhcp_options_ids

aliases: DhcpOptionIds

list / elements=string

Get details of specific DHCP Option IDs.

dry_run

aliases: DryRun

boolean

Checks whether you have the required permissions to view the DHCP Options.

Choices:

  • no ← (default)

  • yes

ec2_url

aliases: aws_endpoint_url, endpoint_url

string

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.

filters

dictionary

A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeDhcpOptions.html for possible filters.

profile

aliases: aws_profile

string

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

region

aliases: aws_region, ec2_region

string

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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

security_token

aliases: aws_security_token, access_token

string

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for communication with the AWS APIs.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

Examples

# # 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
  amazon.aws.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
  amazon.aws.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
  amazon.aws.ec2_vpc_dhcp_option_info:
    region: ap-southeast-2
    profile: production
    DhcpOptionsIds: dopt-123fece2
  register: dhcp_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

True if listing the dhcp options succeeds

Returned: always

dhcp_config

list / elements=string

The boto2-style DHCP options created, associated or found. Provided for consistency with ec2_vpc_dhcp_option’s new_config.

Returned: always

domain-name

list / elements=string

The domain name for hosts in the DHCP option sets

Returned: when available

Sample: [“my.example.com”]

domain-name-servers

list / elements=string

The IP addresses of up to four domain name servers, or AmazonProvidedDNS.

Returned: when available

Sample: [“10.0.0.1”, “10.0.1.1”]

netbios-name-servers

list / elements=string

The IP addresses of up to four NetBIOS name servers.

Returned: when available

Sample: [“10.0.0.1”, “10.0.1.1”]

netbios-node-type

string

The NetBIOS node type (1, 2, 4, or 8).

Returned: when available

Sample: 2

ntp-servers

list / elements=string

The IP addresses of up to four Network Time Protocol (NTP) servers.

Returned: when available

Sample: [“10.0.0.1”, “10.0.1.1”]

dhcp_options

list / elements=dictionary

The DHCP options created, associated or found

Returned: always

dhcp_configurations

list / elements=string

The DHCP configuration for the option set

Returned: success

Sample: [“{\”key\”: \”ntp-servers\”, \”values\”: [{\”value\”: \”10.0.0.2\” , \”value\”: \”10.0.1.2\”}]}”, “{\”key\”: \”netbios-name-servers\”, \”values\”: [{value\”: \”10.0.0.1\”}, {\”value\”: \”10.0.1.1\” }]}”]

dhcp_options_id

string

The aws resource id of the primary DCHP options set created or found

Returned: success

Sample: “dopt-0955331de6a20dd07”

owner_id

string

The ID of the AWS account that owns the DHCP options set.

Returned: success

Sample: “012345678912”

tags

list / elements=string

The tags to be applied to a DHCP options set

Returned: success

Sample: [“{\”Key\”: \”CreatedBy\”, \”Value\”: \”ansible-test\”}”, “{\”Key\”: \”Collection\”, \”Value\”: \”amazon.aws\”}”]

Authors

  • Nick Aslanidis (@naslanidis)