community.aws.wafv2_ip_set 模块 – wafv2_ip_set

注意

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

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

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

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

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 string	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 botocore SDK 保持一致，aws_access_key_id 别名已在 5.1.0 版本中添加。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
addresses list / elements=string	包含一个字符串数组，指定一个或多个 IP 地址或以无类别域间路由 (CIDR) 表示法的 IP 地址块。 当 state=present 时是必需的。 当 state=absent 且定义了 addresses 时，只会从 IP 集中删除给定的 IP 地址。整个 IP 集本身将保持存在。
aws_ca_bundle path	用于验证 SSL 证书时使用的 CA 捆绑包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config dictionary	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs boolean	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出 playbook 期间创建的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description string	IP 集的描述。
endpoint_url 别名: ec2_url, aws_endpoint_url, s3_url string	要连接到的 URL，而不是默认的 AWS 端点。虽然这可用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
ip_address_version string	指定这是 IPv4 还是 IPv6 IP 集。 当 state=present 时是必需的。 选项 "IPV4" "IPV6"
name string / required	IP 集的名称。
profile 别名: aws_profile string	用于身份验证的命名 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 选项互斥。
purge_addresses boolean	设置为 no 时，保留现有地址。将修改和添加，但不会删除。 选项 false true ← (默认)
purge_tags boolean	如果 purge_tags=true 且设置了 tags，则现有标签将从资源中清除，以完全匹配 tags 参数定义的标签。 如果未设置 tags 参数，则不会修改标签，即使设置了 purge_tags=True。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，对于 purge_tags 参数，这些标签键将被忽略。有关更多信息，请参阅 Amazon 文档：https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
region 别名: aws_region, ec2_region string	要使用的 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-01 之后的版本中删除。 对 EC2_REGION 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
scope string / required	指定此规则是用于 AWS CloudFront 分配还是用于区域性应用程序，例如 API Gateway 或 Application LoadBalancer。 选项 "CLOUDFRONT" "REGIONAL"
secret_key 别名: aws_secret_access_key, aws_secret_key, ec2_secret_key string	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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
session_token 别名: aws_session_token, security_token, aws_security_token, access_token string	用于临时凭证的 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 选项是互斥的。 别名 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 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
state string / required	规则是否存在。 选项 "present" "absent"
tags 别名: resource_tags dictionary	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs boolean	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注意

注意

• 对 purge_tags 的支持在 4.0.0 版本中添加。

• 注意：对于模块，环境变量和配置文件是从 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:
    name: test02
    state: present
    description: hallo eins
    scope: REGIONAL
    ip_address_version: IPV4
    addresses:
      - 8.8.8.8/32
      - 8.8.4.4/32
    tags:
      A: B
      C: D

返回值

常用返回值记录在 此处，以下是此模块特有的字段

Key	描述
addresses list / elements=string	IP 集的当前地址 返回: 始终，只要 IP 集存在 示例: ["8.8.8.8/32", "8.8.4.4/32"]
arn string	IP 集 arn 返回: 始终，只要 IP 集存在 示例: "arn:aws:wafv2:eu-central-1:11111111:regional/ipset/test02/4b007330-2934-4dc5-af24-82dcb3aeb127"
description string	IP 集的描述 返回: 始终，只要 IP 集存在 示例: "Some IP set description"
ip_address_version string	IP 集的 IP 版本 返回: 始终，只要 IP 集存在 示例: "IPV4"
name string	IP 集名称 返回: 始终，只要 IP 集存在 示例: "test02"

作者

• Markus Bergholz (@markuman)

集合链接

• 问题跟踪器
• 存储库（来源）
• 通信