amazon.aws.ec2_vpc_dhcp_option_info 模块 – 收集 AWS 中 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_info。
amazon.aws 1.0.0 中的新增功能
概要
收集有关 AWS 中 DHCP 选项集的信息。
要求
执行此模块的主机上需要以下要求。
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。 |
|
使用 也可以使用 选择
|
|
获取特定 DHCP 选项 ID 的详细信息。 |
|
检查您是否具有查看 DHCP 选项所需的权限。 选择
|
|
要连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeDhcpOptions.html。 默认： |
|
用于身份验证的命名 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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 之后的版本中删除。 对 |
|
当设置为 强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。 选择
|
备注
注意
注意： 对于模块，环境变量和配置文件是从 Ansible ‘主机’ 上下文读取，而不是从 ‘控制器’ 上下文读取。因此，可能需要将文件显式复制到 ‘主机’。对于查找和连接插件，环境变量和配置文件是从 Ansible ‘控制器’ 上下文读取，而不是从 ‘主机’ 上下文读取。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible ‘主机’ 上下文中的配置文件（通常是
~/.aws/credentials）读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
# # 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
dhcp_options_ids: dopt-123fece2
register: dhcp_info
返回值
常见返回值记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
如果列出 DHCP 选项成功，则为 True。 返回： 始终 |
|
创建、关联或找到的 boto2 样式的 DHCP 选项。为了与 ec2_vpc_dhcp_option 的 返回： 始终 |
|
DHCP 选项集中主机的域名。 返回： 当可用时 示例： |
|
最多四个域名服务器的 IP 地址，或 AmazonProvidedDNS。 返回： 当可用时 示例： |
|
最多四个 NetBIOS 名称服务器的 IP 地址。 返回： 当可用时 示例： |
|
NetBIOS 节点类型（1、2、4 或 8）。 返回： 当可用时 示例： |
|
最多四个网络时间协议 (NTP) 服务器的 IP 地址。 返回： 当可用时 示例： |
|
创建、关联或找到的 DHCP 选项。 返回： 始终 |
|
选项集的 DHCP 配置。 返回： 成功 示例： |
|
DHCP 选项的名称。 返回： 始终 |
|
DHCP 选项的值列表。 返回： 始终 |
|
属性值。此值区分大小写。 返回： 始终 |
|
创建或找到的主 DHCP 选项集的 aws 资源 ID。 返回： 成功 示例： |
|
拥有 DHCP 选项集的 AWS 账户的 ID。 返回： 成功 示例： |
|
要应用于 DHCP 选项集的标签。 返回： 成功 示例： |