Spec-Zone.ru › Ansible

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

Новый в community.aws 4.0.0

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

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

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 сетевого файрволла.

Взаимоисключающие с name и vpc_ids.

aws_ca_bundle

путь

Расположение файла 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 логгер для анализа уникальных (а не общих) "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

строка

Имя сетевого файрволла.

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

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 взаимоисключающие.

Псевдонимы 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 ← (по умолчанию)

vpc_ids

aliases: vpcs, vpc_id

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

Список VPC для получения информации о брандмауэрах.

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост» а не «контроллер». В связи с этим, файлы, возможно, потребуется явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

string

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

Возвращаемое значение: success

Пример: "READY"

sync_states

dictionary

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

Возвращаемое значение: success

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

Spec-Zone.ru

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