community.aws.networkfirewall_info 模块 – 描述 AWS 网络防火墙

注意

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

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

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

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

community.aws 4.0.0 中的新增功能

概要

• 用于描述 AWS 网络防火墙的模块。

要求

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

• 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 botocore SDK 保持一致，aws_access_key_id 别名在 5.1.0 版本中添加。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中删除。
arn 字符串	网络防火墙的 ARN。 与 name 和 vpc_ids 互斥。
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 字符串	网络防火墙的名称。 与 arn 和 vpc_ids 互斥。
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-01 之后的一个版本中移除。 对 EC2_REGION 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
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_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 字符串	用于临时凭证的 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 之后的一个版本中移除。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
vpc_ids 别名：vpcs, vpc_id 列表 / 元素=字符串	要为其检索防火墙的 VPC 列表。 与 name 和 arn 互斥。

注释

注意

• 警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。更多信息请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Describe all firewalls in an account
- community.aws.networkfirewall_info: {}

# Describe a firewall by ARN
- community.aws.networkfirewall_info:
    arn: arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall

# Describe a firewall by name
- community.aws.networkfirewall_info:
    name: ExampleFirewall

返回值

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

键	描述
firewall_list 列表 / 元素=字符串	匹配防火墙的 ARN 列表。 返回：未指定防火墙名称时 示例：["arn:aws:network-firewall:us-east-1:123456789012:firewall/Example1", "arn:aws:network-firewall:us-east-1:123456789012:firewall/Example2"]
firewalls 列表 / 元素=字典	防火墙的详细信息 返回：成功
firewall 字典	防火墙的详细信息 返回：成功
delete_protection 字符串	指示是否可以删除防火墙的标志。 返回：成功 示例："True"
description 字符串	防火墙的描述。 返回：成功 示例："Description"
firewall_arn 字符串	防火墙的 ARN。 返回：成功 示例："arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall"
firewall_id 字符串	防火墙的唯一 ID。 返回：成功 示例："12345678-abcd-1234-abcd-123456789abc"
firewall_name 字符串	防火墙的名称。 返回：成功 示例："ExampleFirewall"
firewall_policy_arn 字符串	防火墙使用的防火墙策略的 ARN。 返回：成功 示例："arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy"
firewall_policy_change_protection 布尔值	指示是否可以更改防火墙使用的防火墙策略的标志。 返回：成功 示例：false
subnet_change_protection 布尔值	指示是否可以更改防火墙端点所在的子网的标志。 返回：成功 示例：true
subnet_mappings 列表 / 元素=字典	防火墙端点所在的子网列表。 返回：成功
subnet_id 字符串	子网的 ID。 返回：成功 示例："subnet-12345678"
tags 字典	与防火墙关联的标签。 返回：成功 示例：{"SomeTag": "SomeValue"}
vpc_id 字符串	防火墙使用的 VPC 的 ID。 返回：成功 示例："vpc-0123456789abcdef0"
firewall_metadata 字典	关于防火墙的元数据 返回：成功
configuration_sync_state_summary 字符串	策略和规则组同步状态的简短摘要。 返回：成功 示例："IN_SYNC"
status 字符串	防火墙端点状态的简短摘要。 返回：成功 示例："READY"
sync_states 字典	按可用区细分的防火墙端点状态以及策略和规则组同步状态的描述。 返回：成功 示例：{"us-east-1a": {"attachment": {"endpoint_id": "vpce-123456789abcdef01", "status": "READY", "subnet_id": "subnet-12345678"}, "config": {"arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Ansible-Example": {"sync_status": "IN_SYNC", "update_token": "abcdef01-0000-0000-0000-123456789abc"}, "arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleDomainList": {"sync_status": "IN_SYNC", "update_token": "12345678-0000-0000-0000-abcdef012345"}}}}

作者

• Mark Chappell (@tremble)

集合链接

• 问题追踪器
• 代码库（源代码）
• 沟通