amazon.aws.ec2_vpc_dhcp_option 模块 – 管理 DHCP 选项，并可确保给定 VPC 的 DHCP 选项与请求匹配
注意
此模块是 amazon.aws 集合（版本 9.0.0）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：amazon.aws.ec2_vpc_dhcp_option。
amazon.aws 1.0.0 中的新增功能
概要
此模块删除或创建 DHCP 选项集，并可以将它们关联到 VPC。
或者，可以创建一个新的 DHCP 选项集，该选项集将 VPC 的现有 DHCP 选项集与提供的值进行合并。
当提供 dhcp_options_id 时，模块将 1. 删除（使用 state='absent'）2. 确保应用标签（如果 state='present' 并且提供了标签）3. 将其附加到 VPC（如果 state='present' 并且提供了 vpc_id）。
如果缺少任何可选值，它们将被视为无操作（即，继承 VPC 已存在的值）
要在继承的同时删除现有选项，请提供一个空值（例如，如果要从 VPC 的选项中删除 ntp_servers，请将其设置为 []）
要求
执行此模块的主机需要满足以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 还可以按优先级递减的顺序使用 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 已弃用对 |
|
用于验证 SSL 证书的 CA 捆绑包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选项
|
|
在关联新 VPC DHCP 选项集时是否删除旧的 VPC DHCP 选项集。 当您想快速回滚到旧的选项集时，这主要用于调试/开发目的。请注意，如果旧的 DHCP 选项集被任何其他 VPC 使用，则会忽略此设置，并且会保留旧的 DHCP 选项集。（否则，AWS 将返回错误。） 选项
|
|
现有 DHCP 选项集的 resource_id。如果指定了此项，则它将覆盖其他设置，但标签除外（标签将被更新以匹配） |
|
要将 VPC 的 DNS 服务器设置为的 IP 地址列表。 |
|
要在 DHCP 选项集中设置的域名。 |
|
要连接而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以按优先级递减的顺序使用 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 已弃用对 |
|
要作为 NetBIOS 服务器通告的主机列表。 |
|
要在 DHCP 选项中通告的 NetBIOS 节点类型。AWS 建议使用 2（当使用 netbios 名称服务时） https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html |
|
要作为 VPC 的 NTP 服务器通告的主机列表。 |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
如果 如果未设置 以 选项
|
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，region 将被忽略。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
AWS 秘密访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，aws_secret_access_key 别名在 5.1.0 版本中添加。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
创建/分配或删除 DHCP 选项。如果 state 设置为 absent，则会尽可能删除与 ID 或标签和选项匹配的 DHCP 选项集。 选项
|
|
一个表示要应用于资源的标签的字典。 如果未设置 |
|
当设置为 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项
|
|
要与请求的 DHCP 选项集关联的 VPC ID。 如果未提供 VPC ID，并且未找到匹配的选项集，则会创建一个新的 DHCP 选项集。 |
注释
注意
对
purge_tags的支持在 2.0.0 版本中添加。注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文而不是“控制器” 上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文而不是“主机” 上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “主机” 上下文中的配置文件（通常是
~/.aws/credentials）读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
# Completely overrides the VPC DHCP options associated with VPC vpc-123456 and deletes any existing
# DHCP option set that may have been attached to that VPC.
- amazon.aws.ec2_vpc_dhcp_option:
domain_name: "foo.example.com"
region: us-east-1
dns_servers:
- 10.0.0.1
- 10.0.1.1
ntp_servers:
- 10.0.0.2
- 10.0.1.2
netbios_name_servers:
- 10.0.0.1
- 10.0.1.1
netbios_node_type: 2
vpc_id: vpc-123456
delete_old: true
inherit_existing: false
# Ensure the DHCP option set for the VPC has 10.0.0.4 and 10.0.1.4 as the specified DNS servers, but
# keep any other existing settings. Also, keep the old DHCP option set around.
- amazon.aws.ec2_vpc_dhcp_option:
region: us-east-1
dns_servers:
- "{{groups['dns-primary']}}"
- "{{groups['dns-secondary']}}"
vpc_id: vpc-123456
inherit_existing: true
delete_old: false
## Create a DHCP option set with 4.4.4.4 and 8.8.8.8 as the specified DNS servers, with tags
## but do not assign to a VPC
- amazon.aws.ec2_vpc_dhcp_option:
region: us-east-1
dns_servers:
- 4.4.4.4
- 8.8.8.8
tags:
Name: google servers
Environment: Test
## Delete a DHCP options set that matches the tags and options specified
- amazon.aws.ec2_vpc_dhcp_option:
region: us-east-1
dns_servers:
- 4.4.4.4
- 8.8.8.8
tags:
Name: google servers
Environment: Test
state: absent
## Associate a DHCP options set with a VPC by ID
- amazon.aws.ec2_vpc_dhcp_option:
region: us-east-1
dhcp_options_id: dopt-12345678
vpc_id: vpc-123456
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
是否更改了 dhcp 选项 返回： 始终 |
|
已创建、关联或找到的 boto2 样式的 DHCP 选项 返回： 可用时 |
|
DHCP 选项集中主机的域名 返回： 可用时 示例： |
|
最多四个域名服务器的 IP 地址，或 AmazonProvidedDNS。 返回： 可用时 示例： |
|
最多四个 NetBIOS 名称服务器的 IP 地址。 返回： 可用时 示例： |
|
NetBIOS 节点类型（1、2、4 或 8）。 返回： 可用时 示例： |
|
最多四个网络时间协议 (NTP) 服务器的 IP 地址。 返回： 可用时 示例： |
|
已创建、关联或找到的 DHCP 选项 返回： 可用时 |
|
选项集的 DHCP 配置 返回： 成功 示例： |
|
创建或找到的主要 DCHP 选项集的 aws 资源 ID 返回： 成功 示例： |
|
拥有 DHCP 选项集的 AWS 账户的 ID。 返回： 成功 示例： |
|
要应用于 DHCP 选项集的标签 返回： 成功 示例: |
|
创建、查找或删除的主 DHCP 选项集的 AWS 资源 ID。 返回： 可用时 |