Spec-Zone.ru › Ansible

Модуль community.aws.networkfirewall_policy_info — описание политик AWS Network Firewall

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.aws.networkfirewall_policy_info.

Новое в community.aws 4.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Модуль для описания политик AWS Network Firewall.

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_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 (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

arn

строка

ARN политики Network Firewall.

Взаимоисключающий параметр с name.

aws_ca_bundle

путь

Путь к пакету сертификатов центра сертификации, используемому для проверки сертификатов 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 для разбора уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и выводить полученный набор в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных в плейбуке.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

name

строка

Имя политики Network Firewall.

Взаимоисключающий параметр с 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 и session_token.

region

псевдонимы: aws_region

строка

Регион AWS, который следует использовать.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_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 (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

session_token

псевдонимы: aws_session_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.

Параметры session_token и profile являются взаимоисключающими.

validate_certs

логическое значение

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

Настоятельно не рекомендуется устанавливать 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

list / elements=dictionary

Подробная информация о политиках

Возвращается: при успешном выполнении

policy

dictionary

Подробная информация о политике

Возвращается: при успешном выполнении

stateful_engine_options

dictionary

Дополнительные параметры, описывающие обработку правил с отслеживанием состояния.

Возвращается: при успешном выполнении

rule_order

string

Порядок проверки групп правил.

Дополнительные сведения о порядке проверки правил см. в документации AWS: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html.

Возвращается: при успешном выполнении

Пример: "DEFAULT_ACTION_ORDER"

stateful_rule_group_references

list / elements=dictionary

Информация о группах правил с отслеживанием состояния, связанных с политикой.

Возвращается: при успешном выполнении

priority

integer

Целое число, указывающее порядок выполнения групп правил с отслеживанием состояния в рамках одной политики.

Применяется только к политикам, в параметрах механизма с отслеживанием состояния которых указан порядок правил STRICT_ORDER.

Возвращается: при успешном выполнении

Пример: 1234

resource_arn

string

ARN группы правил.

Возвращается: при успешном выполнении

Пример: "arn:aws:network-firewall:us-east-1:aws-managed:stateful-rulegroup/AbusedLegitMalwareDomainsActionOrder"

stateless_custom_actions

list / elements=dictionary

Описание дополнительных пользовательских действий, доступных для использования в качестве правил по умолчанию, применяемых к пакетам без отслеживания состояния.

Возвращается: при успешном выполнении

action_definition

dictionary

Действие, которое необходимо выполнить.

Возвращается: при успешном выполнении

publish_metric_action

dictionary

Определение пользовательской метрики для публикации в CloudWatch.

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

Возвращается: при успешном выполнении

dimensions

list / elements=dictionary

Значения измерения CustomAction, задаваемые для метрик.

Измерения метрики используются для идентификации уникальных потоков данных.

Возвращается: при успешном выполнении

value

string

Значение измерения CustomAction, задаваемое для метрик.

Возвращается: при успешном выполнении

Пример: "ExampleRule"

action_name

string

Имя действия.

Возвращается: при успешном выполнении

Пример: "ExampleAction"

stateless_default_actions

list / elements=string

Действия по умолчанию для пакета, не соответствующего ни одному правилу с отслеживанием состояния.

Возвращается: при успешном выполнении

Пример: ["aws:alert_strict"]

stateless_fragment_default_actions

list / elements=string

Действия для пакета, не соответствующего ни одному из правил без отслеживания состояния в политике.

Возвращается: при успешном выполнении

Пример: ["aws:pass"]

stateless_rule_group_references

list / elements=dictionary

Информация о группах правил с отслеживанием состояния, связанных с политикой.

Возвращается: при успешном выполнении

priority

string

Целое число, указывающее порядок выполнения групп правил без отслеживания состояния в рамках одной политики.

Возвращается: при успешном выполнении

Пример: "12345"

resource_arn

string

ARN группы правил.

Возвращается: при успешном выполнении

Пример: "arn:aws:network-firewall:us-east-1:123456789012:stateless-rulegroup/ExampleGroup"

policy_metadata

dictionary

Метаданные политики

Возвращается: при успешном выполнении

consumed_stateful_rule_capacity

integer

Общее количество единиц ёмкости, используемых группами правил с отслеживанием состояния.

Возвращается: при успешном выполнении

Пример: 165

consumed_stateless_rule_capacity

integer

Общее количество единиц ёмкости, используемых группами правил без отслеживания состояния.

Возвращается: при успешном выполнении

Пример: 2010

firewall_policy_arn

string

ARN политики.

Возвращается: при успешном выполнении

Пример: "arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy"

firewall_policy_id

string

Уникальный идентификатор политики.

Возвращается: при успешном выполнении

Пример: "12345678-abcd-1234-5678-123456789abc"

firewall_policy_name

string

Имя политики.

Возвращается: при успешном выполнении

Пример: "ExamplePolicy"

firewall_policy_status

string

Текущий статус политики.

Возвращается: при успешном выполнении

Пример: "ACTIVE"

number_of_associations

integer

Количество брандмауэров, связанных с политикой.

Возвращается: при успешном выполнении

Пример: 1

tags

dictionary

Словарь с тегами, связанными с политикой.

Возвращается: при успешном выполнении

Пример: {"tagName": "Some Value"}

policy_list

list / elements=string

Список 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)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API