community.aws.wafv2_ip_set_info модуль – Получение информации о наборах IP-адресов wafv2
Примечание
Этот модуль входит в состав коллекции community.aws (версия 8.0.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.aws. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: community.aws.wafv2_ip_set_info.
Новая функция в community.aws 1.5.0
Описание
- Получение информации о существующих наборах IP-адресов wafv2.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | ID ключа доступа AWS. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение файла с набором сертификатов CA для проверки SSL-сертификатов. Также может быть использована переменная среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логический | Использование логгера Также может быть использована переменная среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут быть использованы переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
name строка / обязательно | Имя набора IP-адресов. |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может быть использована переменная среды Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также могут быть использованы переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
scope строка / обязательно | Указывает, предназначен ли он для распределения AWS CloudFront или для регионального приложения. Варианты:
|
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. Также могут быть использованы переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | AWS STS сессионный токен для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры 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. Поддержка переменных среды |
validate_certs boolean | При установке в Установка validate_certs=false категорически не рекомендуется, как альтернативу, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «host», а не «controller». Поэтому файлы могут потребоваться скопировать в «host». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста Ansible «controller», а не «host».
- AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из файлов конфигурации в контексте Ansible «host» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
- name: test ip set
wafv2_ip_set_info:
name: test02
scope: REGIONAL
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
addresses список / элементы=строка | Текущие адреса ip-набора Возвращается: Всегда, если ip-набор существует Пример: |
arn строка | arn ip-набора Возвращается: Всегда, если ip-набор существует Пример: |
description строка | Описание ip-набора Возвращается: Всегда, если ip-набор существует Пример: |
ip_address_version строка | Версия ip-адреса ip-набора Возвращается: Всегда, если ip-набор существует Пример: |
name строка | Имя ip-набора Возвращается: Всегда, если ip-набор существует Пример: |
Ссылки на коллекцию
© 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/wafv2_ip_set_info_module.html