Spec-Zone.ru › Ansible

Модуль community.aws.networkfirewall_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_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 и vpc_ids.

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 и vpc_ids.

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 ← (по умолчанию)

vpc_ids

псевдонимы: vpcs, vpc_id

список / элементы=строки

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

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

Примечания

Примечание

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

Примеры

# Describe all firewalls in an account
- community.aws.networkfirewall_info: {}

# Describe a firewall by ARN
- community.aws.networkfirewall_info:
    arn: arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall

# Describe a firewall by name
- community.aws.networkfirewall_info:
    name: ExampleFirewall

Возвращаемые значения

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

Ключ

Описание

firewall_list

список / элементы=строки

Список ARN соответствующих брандмауэров.

Возвращается: если имя брандмауэра не указано

Пример: ["arn:aws:network-firewall:us-east-1:123456789012:firewall/Example1", "arn:aws:network-firewall:us-east-1:123456789012:firewall/Example2"]

firewalls

список / элементы=словарь

Сведения о брандмауэрах

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

firewall

словарь

Сведения о брандмауэре

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

delete_protection

строка

Флаг, указывающий, можно ли удалить брандмауэр.

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

Пример: "True"

description

строка

Описание брандмауэра.

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

Пример: "Description"

firewall_arn

строка

ARN брандмауэра.

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

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

firewall_id

строка

Уникальный идентификатор брандмауэра.

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

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

firewall_name

строка

Имя брандмауэра.

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

Пример: "ExampleFirewall"

firewall_policy_arn

строка

ARN политики брандмауэра, используемой брандмауэром.

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

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

firewall_policy_change_protection

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

Флаг, указывающий, можно ли изменить политику брандмауэра.

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

Пример: false

subnet_change_protection

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

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

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

Пример: true

subnet_mappings

список / элементы=словарь

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

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

subnet_id

строка

Идентификатор подсети.

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

Пример: "subnet-12345678"

tags

словарь

Теги, связанные с брандмауэром.

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

Пример: {"SomeTag": "SomeValue"}

vpc_id

строка

Идентификатор VPC, для которой используется брандмауэр.

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

Пример: "vpc-0123456789abcdef0"

firewall_metadata

словарь

Метаданные о брандмауэре

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

configuration_sync_state_summary

строка

Краткая сводка о состоянии синхронизации политик и групп правил.

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

Пример: "IN_SYNC"

status

строка

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

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

Пример: "READY"

sync_states

словарь

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

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

Пример: {"us-east-1a": {"attachment": {"endpoint_id": "vpce-123456789abcdef01", "status": "READY", "subnet_id": "subnet-12345678"}, "config": {"arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Ansible-Example": {"sync_status": "IN_SYNC", "update_token": "abcdef01-0000-0000-0000-123456789abc"}, "arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleDomainList": {"sync_status": "IN_SYNC", "update_token": "12345678-0000-0000-0000-abcdef012345"}}}}

Авторы

  • 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_info_module.html

Spec-Zone.ru

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