Модуль community.aws.networkfirewall_rule_group_info — описание правил AWS Network Firewall

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробной информации.

Для использования в книге задач укажите: community.aws.networkfirewall_rule_group_info.

Новая функция в community.aws 4.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Модуль для описания правил AWS Network Firewall.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа AWS. Дополнительную информацию об маркерах доступа см. в документации 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 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
arn строка	ARN группы правил брандмауэра Network Firewall. На момент написания AWS не поддерживает описание управляемых правил.
aws_ca_bundle путь	Расположение пакета CA для проверки сертификатов SSL. Также можно использовать переменную среды `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`
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 строка	Имя группы правил брандмауэра Network Firewall.
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.
rule_type псевдонимы: type строка	Указывает, является ли группа правил бессостоятельной или состоятельной. Требуется, если указано name. Варианты: `"stateful"` `"stateless"`
scope строка	Область применения запроса. При scope=’account’ возвращается описание всех групп правил в учетной записи. При scope=’managed’ возвращается список доступных управляемых групп правил arn. По умолчанию поиск выполняется только в области учетной записи. Варианты: `"managed"` `"account"`
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 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: 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, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в значение false, сертификаты SSL для связи с API AWS не будут проверяться.

Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы, можно установить aws_ca_bundle вместо этого.

Выбор:

false
true ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), который использует Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из файлов конфигурации в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Describe all Rule Groups in an account (excludes managed groups)
- community.aws.networkfirewall_rule_group_info: {}

# List the available Managed Rule groups (AWS doesn't support describing the
# groups)
- community.aws.networkfirewall_rule_group_info:
    scope: managed

# Describe a Rule Group by ARN
- community.aws.networkfirewall_rule_group_info:
    arn: arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleRuleGroup

# Describe a Rule Group by name
- community.aws.networkfirewall_rule_group_info:
    name: ExampleRuleGroup
    type: stateful

Значения возврата

Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
rule_groups list / elements=dictionary	Подробная информация о группах правил Возвращается: success
rule_group dictionary	Подробная информация о правилах в группе правил Возвращается: success
rule_variables complex	Параметры, доступные для использования в правилах группы правил. Возвращается: Когда переменные правил прикреплены к группе правил.
ip_sets dictionary	Словарь, сопоставляющий имена переменных с IP-адресами в формате CIDR. Возвращается: success Пример: `["192.0.2.0/24"]`
port_sets dictionary	Словарь, сопоставляющий имена переменных с портами Возвращается: success Пример: `["42"]`
rules_source dictionary	DEFAULT_ACTION_ORDER Возвращается: success
rules_source_list dictionary	Описание критериев для группы правил списка доменов. Возвращается: Когда группа правил основана на «списке доменов».
generated_rules_type string	Разрешает ли группа правил доступ к доменам в списке или запрещает его. Возвращается: success Пример: `"ALLOWLIST"`
target_types list / elements=string	Протоколы, которые должны быть проверены группой правил. Возвращается: success Пример: `["TLS_SNI", "HTTP_HOST"]`
targets list / elements=string	Список имен доменов, которые необходимо проверить. Возвращается: success Пример: `["abc.example.com", ".example.net"]`
rules_string string	Строка, описывающая правила, из которых состоит группа правил. Возвращается: Когда группа правил основана на «строке правил».
stateful_rules list / elements=dictionary	Список словарей, описывающих правила, из которых состоит группа правил. Возвращается: Когда группа правил основана на «списке правил».
action string	Какое действие выполнить, когда поток соответствует критериям правила. Возвращается: success Пример: `"PASS"`
header dictionary	Описание критериев, используемых для правила. Возвращается: success
destination string	Целевой адрес или диапазон адресов для проверки. Возвращается: success Пример: `"198.51.100.0/24"`
destination_port string	Целевой порт для проверки. Возвращается: success Пример: `"6666:6667"`
direction string	Направление потока трафика для проверки. Возвращается: success Пример: `"FORWARD"`

protocol string	Протокол для проверки. Возвращено: success Пример: `"IP"`
source string	Исходный адрес или диапазон адресов для проверки. Возвращено: success Пример: `"203.0.113.98"`
source_port string	Исходный порт для проверки. Возвращено: success Пример: `"42"`
rule_options list / elements=dictionary	Дополнительные настройки Suricata RuleOptions для правила. Возвращено: success
keyword string	Ключевое слово для настройки. Возвращено: success Пример: `"sid:1"`
settings list / elements=string	Список значений, переданных в настройку. Возвращено: Когда значения доступны
stateless_rules_and_custom_actions dictionary	Описание критериев для группы правил без состояния. Возвращено: Когда группа правил является группой правил без состояния.
custom_actions list / elements=dictionary	Список отдельных определений пользовательских действий, которые доступны для использования в правилах без состояния. Возвращено: success
action_definition dictionary	Пользовательское действие, связанное с именем действия. Возвращено: success
publish_metric_action dictionary	Описание действия, которое публикует в CloudWatch. Возвращено: Когда действие публикуется в CloudWatch.
dimensions list / elements=dictionary	Значение для использования в измерении пользовательского метрика Amazon CloudWatch. Возвращено: success
value string	Значение для использования в пользовательском измерении метрики. Возвращено: success
action_name string	Имя для пользовательского действия. Возвращено: success
stateless_rules list / elements=dictionary	Список правил без состояния для использования в группе правил без состояния. Возвращено: success
priority integer	Указывает порядок выполнения этого правила относительно всех правил, определенных для группы правил без состояния. Возвращено: success
rule_definition dictionary	Описывает критерии проверки 5-кортежей без состояния и действия для правила. Возвращено: success
actions list / elements=string	Действия, которые необходимо выполнить, когда поток соответствует правилу. Возвращено: success Пример: `["aws:pass", "CustomActionName"]`

match_attributes dictionary	Описывает критерии проверки 5-кортежа без сохранения состояния для правила. Возвращается: success
destination_ports list / elements=dictionary	Диапазоны портов назначения для проверки. Возвращается: success
from_port integer	Нижний предел диапазона портов. Возвращается: success
to_port integer	Верхний предел диапазона портов. Возвращается: success
destinations list / elements=dictionary	IP-адреса и диапазоны адресов назначения для проверки. Возвращается: success
address_definition string	IP-адрес или блок IP-адресов в нотации CIDR. Возвращается: success Пример: `"192.0.2.3"`
protocols list / elements=integer	Номера протоколов IANA, которые необходимо проверить. Возвращается: success Пример: `[6]`
source_ports list / elements=dictionary	Диапазоны исходных портов для проверки. Возвращается: success
from_port integer	Нижний предел диапазона портов. Возвращается: success
to_port integer	Верхний предел диапазона портов. Возвращается: success
sources list / elements=dictionary	Исходные IP-адреса и диапазоны адресов для проверки. Возвращается: success
address_definition string	IP-адрес или блок IP-адресов в нотации CIDR. Возвращается: success Пример: `"192.0.2.3"`
tcp_flags list / elements=dictionary	Флаги и маски TCP для проверки. Возвращается: success
flags list / elements=string	Используется с масками для определения флагов TCP, для которых проверяются потоки. Возвращается: success
masks list / elements=string	Набор флагов, учитываемых при проверке. Возвращается: success
stateful_rule_options dictionary	Дополнительные параметры, определяющие, как Network Firewall обрабатывает правила с сохранением состояния. Возвращается: Когда группа правил основана на «строке правил» или «списке правил».

rule_order строка	Порядок, в котором будут оцениваться правила. Возвращаемое значение: успех Пример: `"DEFAULT_ACTION_ORDER"`
rule_group_metadata словарь	Подробная информация о правилах в группе правил. Возвращаемое значение: успех
capacity целое число	Максимальные вычислительные ресурсы, которые может использовать эта группа правил. Возвращаемое значение: успех
consumed_capacity целое число	Количество единиц ресурсов, в настоящее время используемых правилами группы правил. Возвращаемое значение: успех
description строка	Описание группы правил. Возвращаемое значение: успех
number_of_associations целое число	Количество политик брандмауэра, использующих эту группу правил. Возвращаемое значение: успех
rule_group_arn целое число	ARN группы правил. Возвращаемое значение: успех Пример: `"arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleGroup"`
rule_group_id целое число	Уникальный идентификатор группы правил. Возвращаемое значение: успех Пример: `"12345678-abcd-1234-abcd-123456789abc"`
rule_group_name строка	Имя группы правил. Возвращаемое значение: успех
rule_group_status строка	Текущий статус группы правил. Возвращаемое значение: успех Пример: `"DELETING"`
tags словарь	Словарь, представляющий теги, связанные с группой правил. Возвращаемое значение: успех
type строка	Является ли группа правил бессостоятельной или состоятельной. Возвращаемое значение: успех Пример: `"STATEFUL"`
rule_list список / элементы=строка	Список ARN соответствующих групп правил. Возвращаемое значение: Когда имя правила не указано

Авторы

Mark Chappell (@tremble)

Ссылки на сборки

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/networkfirewall_rule_group_info_module.html