Spec-Zone.ru › Ansible

community.aws.networkfirewall_policy_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_policy_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.

Взаимоисключительно с name.

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.

Взаимоисключительно с 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_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

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

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 ‘контроллер’, а не из контекста ‘хост’.
  • Используемый Ansible 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

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

Возвращено: success

policy

dictionary

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

Возвращено: success

stateful_engine_options

dictionary

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

Возвращено: success

rule_order

string

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

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

Возвращено: success

Пример: "DEFAULT_ACTION_ORDER"

stateful_rule_group_references

list / elements=dictionary

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

Возвращено: success

priority

integer

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

Это применимо только к политикам, которые указывают порядок правил STRICT_ORDER в настройках параметров механизма stateful.

Возвращено: success

Пример: 1234

resource_arn

string

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

Возвращено: success

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

stateless_custom_actions

list / elements=dictionary

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

Возвращено: success

action_definition

dictionary

Выполняемое действие.

Возвращено: success

publish_metric_action

dictionary

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

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

Возвращено: success

dimensions

list / elements=dictionary

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

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

Возвращено: success

value

string

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

Возвращено: success

Пример: "ExampleRule"

action_name

string

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

Возвращено: success

Пример: "ExampleAction"

stateless_default_actions

list / elements=string

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

Возвращено: success

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

stateless_fragment_default_actions

list / elements=string

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

Возвращено: success

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

stateless_rule_group_references

list / elements=dictionary

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

Возвращено: success

priority

string

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

Возвращается: success

Пример: "12345"

resource_arn

string

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

Возвращается: success

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

policy_metadata

dictionary

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

Возвращается: success

consumed_stateful_rule_capacity

integer

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

Возвращается: success

Пример: 165

consumed_stateless_rule_capacity

integer

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

Возвращается: success

Пример: 2010

firewall_policy_arn

string

ARN политики.

Возвращается: success

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

firewall_policy_id

string

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

Возвращается: success

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

firewall_policy_name

string

Название политики.

Возвращается: success

Пример: "ExamplePolicy"

firewall_policy_status

string

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

Возвращается: success

Пример: "ACTIVE"

number_of_associations

integer

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

Возвращается: success

Пример: 1

tags

dictionary

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

Возвращается: success

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/networkfirewall_policy_info_module.html

Spec-Zone.ru

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