community.aws.networkfirewall_policy 模块 – 管理 AWS 网络防火墙策略

注意

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

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

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

要在剧本中使用它，请指定： community.aws.networkfirewall_policy。

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。 必须提供 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 回调将输出到剧本期间进行的总数列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description 字符串	网络防火墙策略的描述。
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 或 name 中的一个。
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 选项互斥。
purge_stateless_custom_actions 别名：purge_custom_stateless_actions 布尔值	如果 purge_stateless_custom_actions=true，则将从资源中清除现有的自定义操作，以完全匹配 stateless_custom_actions 参数定义的内容。 选项 false true ← (默认)
purge_tags 布尔值	如果 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 字符串	要使用的 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 之后的发行版本中删除。
state 字符串	创建或删除网络防火墙策略。 选项 "present" ← (默认) "absent"
stateful_default_actions 列表 / 元素=字符串	如果数据包与策略中任何状态规则都不匹配，则要采取的操作。 常见操作包括 aws:drop_strict、aws:drop_established、aws:alert_strict 和 aws:alert_established。 仅适用于 strict_rule_order=true 的策略。 创建新策略时，默认为 aws:drop_strict。
stateful_rule_groups 别名：stateful_groups 列表 / 元素=字符串	状态防火墙规则组的名称或 ARN 列表。
stateful_rule_order 别名：rule_order 字符串	指示如何管理策略的状态规则评估顺序。 当 strict_rule_order=’strict’ 时，将按定义的顺序评估规则和规则组。 创建后无法更新。 选项 "default" "strict"
stateless_custom_actions 别名：custom_stateless_actions 列表 / 元素=字典	定义自定义操作的字典列表，这些自定义操作可在 stateless_default_actions 和 stateless_fragment_default_actions 中使用。
name 字符串 / 必需	自定义操作的名称。
publish_metric_dimension_value 别名：publish_metric_dimension_values 字符串	使用自定义操作时，指标将具有 CustomAction 维度，其值设置为 publish_metric_dimension_value。
stateless_default_actions 列表 / 元素=字符串	如果数据包与策略中任何无状态规则都不匹配，则要采取的操作。 常见操作包括 aws:pass、aws:drop 和 aws:forward_to_sfe。 创建新策略时，默认为 aws:forward_to_sfe。
stateless_fragment_default_actions 列表 / 元素=字符串	如果分段 UDP 数据包与策略中任何无状态规则都不匹配，则要采取的操作。 常见操作包括 aws:pass、aws:drop 和 aws:forward_to_sfe。 创建新策略时，默认为 aws:forward_to_sfe。
stateless_rule_groups 别名：stateless_groups 列表 / 元素=字符串	无状态防火墙规则组的名称或 ARN 列表。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	模块返回之前，是否等待防火墙策略达到 ACTIVE 或 DELETED 状态。 选项 false true ← (默认)
wait_timeout 整数	等待防火墙策略达到预期状态的最大时间（以秒为单位）。 默认为 600 秒。

注释

注意

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

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

示例

# Create an AWS Network Firewall Policy with default rule order
- community.aws.networkfirewall_policy:
    stateful_rule_order: 'default'
    state: present
    name: 'ExamplePolicy'

# Create an AWS Network Firewall Policy with strict rule order
- community.aws.networkfirewall_policy:
    stateful_rule_order: 'strict'
    state: present
    name: 'ExampleStrictPolicy'


# Create an AWS Network Firewall Policy that defaults to dropping all packets
- community.aws.networkfirewall_policy:
    stateful_rule_order: 'strict'
    state: present
    name: 'ExampleDropPolicy'
    stateful_default_actions:
      - 'aws:drop_strict'
    stateful_rule_groups:
      - 'ExampleStrictRuleGroup'
      - 'arn:aws:network-firewall:us-east-1:aws-managed:stateful-rulegroup/BotNetCommandAndControlDomainsStrictOrder'

# Delete an AWS Network Firewall Policy
- community.aws.networkfirewall_policy:
    state: absent
    name: 'ExampleDropPolicy'

返回值

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

键	描述
policy 字典	策略的详细信息 返回：成功
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"}

作者

• Mark Chappell (@tremble)

资源链接

• 问题跟踪器
• 代码仓库
• 沟通