community.aws.networkfirewall_policy_info 模块 – 描述 AWS 网络防火墙策略

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.networkfirewall_policy_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 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已弃用，将在 2024-12-01 之后的一个版本中删除。

EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中删除。

arn

字符串

网络防火墙策略的 ARN。

与 name 互斥。

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

字符串

连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

还可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。

ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中删除。

EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中删除。

name

字符串

网络防火墙策略的名称。

与 arn 互斥。

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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。

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 选项互斥。

在 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 之后的一个版本中移除。

对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。

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。

示例

# Describe all Firewall policies in an account
- community.aws.networkfirewall_policy_info: {}

# Describe a Firewall policy by ARN
- community.aws.networkfirewall_policy_info:
    arn: arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy

# Describe a Firewall policy by name
- community.aws.networkfirewall_policy_info:
    name: ExamplePolicy

返回值

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

键

描述

policies

列表 / 元素=字典

策略的详细信息

返回：成功

policy

字典

策略的详细信息

返回：成功

stateful_engine_options

字典

描述如何处理有状态规则的额外选项。

返回：成功

rule_order

字符串

规则组评估的排序方式。

有关规则评估顺序的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html。

返回：成功

示例："DEFAULT_ACTION_ORDER"

stateful_rule_group_references

列表 / 元素=字典

有关附加到策略的有状态规则组的信息。

返回：成功

priority

整数

一个整数，指示在单个策略中运行有状态规则组的顺序。

这仅适用于在有状态引擎选项设置中指定 STRICT_ORDER 规则顺序的策略。

返回：成功

示例：1234

resource_arn

字符串

规则组的 ARN。

返回：成功

示例："arn:aws:network-firewall:us-east-1:aws-managed:stateful-rulegroup/AbusedLegitMalwareDomainsActionOrder"

stateless_custom_actions

列表 / 元素=字典

对可用作默认规则以应用于无状态数据包的额外自定义操作的描述。

返回：成功

action_definition

字典

要执行的操作。

返回：成功

publish_metric_action

字典

要发布到 CloudWatch 的自定义指标的定义。

https://docs.aws.amazon.com/network-firewall/latest/developerguide/monitoring-cloudwatch.html

返回：成功

dimensions

列表 / 元素=字典

要在指标上设置的 CustomAction 维度的值。

指标的维度用于标识唯一的数据流。

返回：成功

value

字符串

要在指标上设置的 CustomAction 维度的值。

返回：成功

示例："ExampleRule"

action_name

字符串

操作的名称。

返回：成功

示例："ExampleAction"

stateless_default_actions

列表 / 元素=字符串

对与任何有状态规则都不匹配的数据包采取的默认操作。

返回：成功

示例：["aws:alert_strict"]

stateless_fragment_default_actions

列表 / 元素=字符串

如果数据包与策略中任何无状态规则都不匹配，则要采取的操作。

返回：成功

示例：["aws:pass"]

stateless_rule_group_references

列表 / 元素=字典

有关附加到策略的有状态规则组的信息。

返回：成功

priority

字符串

一个整数，指示在单个策略中运行无状态规则组的顺序。

返回：成功

示例："12345"

resource_arn

字符串

规则组的 ARN。

返回：成功

示例："arn:aws:network-firewall:us-east-1:123456789012:stateless-rulegroup/ExampleGroup"

policy_metadata

字典

关于策略的元数据

返回：成功

consumed_stateful_rule_capacity

整数

有状态规则组使用的容量单位总数。

返回：成功

示例：165

consumed_stateless_rule_capacity

整数

无状态规则组使用的容量单位总数。

返回：成功

示例：2010

firewall_policy_arn

字符串

策略的 ARN。

返回：成功

示例："arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy"

firewall_policy_id

字符串

策略的唯一 ID。

返回：成功

示例："12345678-abcd-1234-5678-123456789abc"

firewall_policy_name

字符串

策略的名称。

返回：成功

示例："ExamplePolicy"

firewall_policy_status

字符串

策略的当前状态。

返回：成功

示例："ACTIVE"

number_of_associations

整数

策略关联到的防火墙数量。

返回：成功

示例：1

tags

字典

表示与策略关联的标签的字典。

返回：成功

示例：{"tagName": "Some Value"}

policy_list

列表 / 元素=字符串

匹配策略的 ARN 列表。

返回：未指定策略名称时

示例： ["arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Example1", "arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Example2"]

作者

  • Mark Chappell (@tremble)