community.aws.networkfirewall модуль — управление брандмауэрами AWS Network Firewall

Примечание

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

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

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

Для использования в playbook, укажите: community.aws.networkfirewall.

Новая функция в 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 псевдонимы: firewall_arn строка	ARN брандмауэра. Должен быть указан ровно один из параметров arn или 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`
delete_protection булево	При delete_protection=True брандмауэр защищен от удаления. По умолчанию `false` при создании, если не указано иначе. Варианты: `false` `true`
description строка	Описание брандмауэра.
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 псевдонимы: firewall_name строка	Имя брандмауэра. Не может быть обновлено после создания. Должен быть указан ровно один из параметров arn или name.
policy псевдонимы: firewall_policy_arn строка	ARN политики Network Firewall, которая будет использоваться для брандмауэра. Требуется при создании нового брандмауэра.
policy_change_protection псевдонимы: firewall_policy_change_protection булево	При policy_change_protection=True брандмауэр защищен от изменения политики, привязанной к нему. По умолчанию `false` при создании, если не указано иначе. Варианты: `false` `true`
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.
purge_subnets булево	Если purge_subnets=true, существующие подсети будут удалены из брандмауэра, чтобы точно соответствовать тому, что определено параметром subnets. Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

purge_tags boolean	Если purge_tags=true и tags задано, существующие теги будут удалены из ресурса, чтобы точно соответствовать тем, что определены параметром tags. Если параметр tags не задан, то теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с `aws:` зарезервированы Amazon и не могут быть изменены. Поэтому они будут проигнорированы для параметра purge_tags. Дополнительную информацию см. в документации Amazon https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
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.
state строка	Создание или удаление брандмауэра. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet_change_protection boolean	При subnet_change_protection=True брандмауэр защищен от изменений подсетей, к которым он подключен. По умолчанию `false` при создании. Варианты: `false` `true`
subnets список / элементы=строка	ID подсетей, к которым будет подключен брандмауэр. Требуется при создании нового брандмауэра.
tags псевдонимы: resource_tags словарь	Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, то теги не будут изменены.
validate_certs boolean	При установке в `false`, сертификаты SSL не будут проверены для связи с API AWS. Установка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, установите aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait boolean	При создании, ждать, пока брандмауэр достигнет состояния `READY`. При удалении, ждать, пока брандмауэр достигнет состояния `DELETED`. При обновлении, ждать, пока брандмауэр достигнет состояния синхронизации конфигурации `IN_SYNC`. Варианты: `false` `true` ← (по умолчанию)
wait_timeout целое число	Максимальное время ожидания в секундах, пока брандмауэр достигнет ожидаемого состояния. По умолчанию 600 секунд.

Примечания

Примечание

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

Примеры

# Create an AWS Network Firewall
- community.aws.networkfirewall:
    name: 'ExampleFirewall'
    state: present
    policy: 'ExamplePolicy'
    subnets:
      - 'subnet-123456789abcdef01'

# Create an AWS Network Firewall with various options, don't wait for creation
# to finish.
- community.aws.networkfirewall:
    name: 'ExampleFirewall'
    state: present
    delete_protection: true
    description: "An example Description"
    policy: 'ExamplePolicy'
    policy_change_protection: true
    subnets:
      - 'subnet-123456789abcdef01'
      - 'subnet-abcdef0123456789a'
    subnet_change_protection: true
    tags:
      ExampleTag: Example Value
      another_tag: another_example
    wait: false


# Delete an AWS Network Firewall
- community.aws.networkfirewall:
    state: absent
    name: 'ExampleFirewall'

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

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

Ключ	Описание
firewall dictionary	Полные сведения о брандмауэре Возвращается: success
firewall dictionary	Сведения о брандмауэре Возвращается: success
delete_protection string	Флаг, указывающий на возможность удаления брандмауэра. Возвращается: success Пример: `"True"`
description string	Описание брандмауэра. Возвращается: success Пример: `"Description"`
firewall_arn string	ARN брандмауэра. Возвращается: success Пример: `"arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall"`
firewall_id string	Уникальный ID брандмауэра. Возвращается: success Пример: `"12345678-abcd-1234-abcd-123456789abc"`
firewall_name string	Имя брандмауэра. Возвращается: success Пример: `"ExampleFirewall"`
firewall_policy_arn string	ARN политики брандмауэра, используемой брандмауэром. Возвращается: success Пример: `"arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy"`
firewall_policy_change_protection boolean	Флаг, указывающий на возможность изменения политики брандмауэра, используемой брандмауэром. Возвращается: success Пример: `false`
subnet_change_protection boolean	Флаг, указывающий на возможность изменения подсетей, в которых находятся конечные точки брандмауэра. Возвращается: success Пример: `true`
subnet_mappings list / elements=dictionary	Список, представляющий подсети, в которых находятся конечные точки брандмауэра. Возвращается: success
subnet_id string	ID подсети. Возвращается: success Пример: `"subnet-12345678"`
subnets list / elements=string	Список подсетей, в которых находятся конечные точки брандмауэра. Возвращается: success Пример: `["subnet-12345678", "subnet-87654321"]`
tags dictionary	Теги, связанные с брандмауэром. Возвращается: success Пример: `{"SomeTag": "SomeValue"}`
vpc_id string	ID VPC, используемого брандмауэром. Возвращается: success Пример: `"vpc-0123456789abcdef0"`
firewall_metadata dictionary	Метаданные о брандмауэре Возвращается: success
configuration_sync_state_summary string	Краткое описание состояния синхронизации политик и групп правил. Возвращается: success Пример: `"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_module.html