community.aws.wafv2_ip_set_info 模块 – 获取 wafv2 IP 集信息

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定： community.aws.wafv2_ip_set_info。

community.aws 1.5.0 中的新增功能

概要 

获取有关现有 wafv2 IP 集的信息。

要求 

执行此模块的主机需要以下要求。

python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0

参数 

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key 字符串	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_ID`、`AWS_ACCESS_KEY` 或 `EC2_ACCESS_KEY` 环境变量，优先级依次递减。 aws_access_key 和 profile 选项是互斥的。 aws_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。 `EC2_ACCESS_KEY` 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中删除。
aws_ca_bundle 路径	验证 SSL 证书时使用的 CA 捆绑包的位置。也可以使用 `AWS_CA_BUNDLE` 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 日志记录器来解析在任务期间进行的唯一（而不是总计）`"resource:action"` API 调用，将集合输出到任务结果中的 resource_actions 密钥。使用 `aws_resource_action` 回调将输出到 playbook 期间进行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认) `true`
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。也可以使用 `AWS_URL` 或 `EC2_URL` 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。 `EC2_URL` 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中删除。
name 字符串 / 必需	IP 集的名称。
profile 别名：aws_profile 字符串	用于身份验证的命名 AWS 配置文件。有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。也可以使用 `AWS_PROFILE` 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
region 别名：aws_region、ec2_region 字符串	要使用的 AWS 区域。对于 IAM、Route53 和 CloudFront 等全球服务，将忽略 region。也可以使用 `AWS_REGION` 或 `EC2_REGION` 环境变量。有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 `ec2_region` 别名已弃用，将在 2024 年 12 月 1 日后的某个版本中移除。对 `EC2_REGION` 环境变量的支持已弃用，将在 2024 年 12 月 1 日后的某个版本中移除。
scope 字符串 / 必需	指定这是用于 AWS CloudFront 分发还是用于区域应用程序。选项 `"CLOUDFRONT"` `"REGIONAL"`
secret_key 别名：aws_secret_access_key、aws_secret_key、ec2_secret_key 字符串	AWS 密钥访问密钥。有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。也可以使用 `AWS_SECRET_ACCESS_KEY`、`AWS_SECRET_KEY` 或 `EC2_SECRET_KEY` 环境变量（优先级递减）。 secret_key 和 profile 选项互斥。为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024 年 12 月 1 日后的某个版本中移除。对 `EC2_SECRET_KEY` 环境变量的支持已弃用，将在 2024 年 12 月 1 日后的某个版本中移除。
session_token 别名：aws_session_token、security_token、aws_security_token、access_token 字符串	用于临时凭证的 AWS STS 会话令牌。有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。也可以使用 `AWS_SESSION_TOKEN`、`AWS_SECURITY_TOKEN` 或 `EC2_SECURITY_TOKEN` 环境变量（优先级递减）。 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 月 1 日后的某个版本中移除。对 `EC2_SECRET_KEY` 和 `AWS_SECURITY_TOKEN` 环境变量的支持已弃用，将在 2024 年 12 月 1 日后的某个版本中移除。
validate_certs 布尔值	设置为 `false` 时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改为设置 aws_ca_bundle。选项 `false` `true` ← (默认)

注释 

注意

注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文中读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文中读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

- name: test ip set
  wafv2_ip_set_info:
    name: test02
    scope: REGIONAL

返回值 

公共返回值已在此处记录此处，以下是此模块特有的字段

键	描述
addresses 列表 / 元素=字符串	IP 集的当前地址已返回：只要 IP 集存在，就会始终返回。示例： `["8.8.8.8/32", "8.8.4.4/32"]`
arn 字符串	IP 集 arn 已返回：只要 IP 集存在，就会始终返回。示例： `"arn:aws:wafv2:eu-central-1:11111111:regional/ipset/test02/4b007330-2934-4dc5-af24-82dcb3aeb127"`
description 字符串	IP 集的描述已返回：只要 IP 集存在，就会始终返回。示例： `"Some IP set description"`
ip_address_version 字符串	IP 集的 IP 版本已返回：只要 IP 集存在，就会始终返回。示例： `"IPV4"`
name 字符串	IP 集名称已返回：只要 IP 集存在，就会始终返回。示例： `"test02"`

作者

Markus Bergholz (@markuman)