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 Bundle的位置。 也可以使用 |
|
用于修改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。 ec2_region 别名已弃用，将在2024-12-01之后的一个版本中删除。 对环境变量 |
|
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 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 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 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 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 选项集的标签。 返回：成功 示例： |