community.aws.elb_target – Управление целевым узлом в группе целевых узлов
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в playbook, укажите: community.aws.elb_target.
Новое в версии 1.0.0: из community.aws
Описание
- Используется для регистрации или от регистрации целевого узла в группе целевых узлов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и эти параметры станут взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла с сертификатами CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл CA Bundle читается на стороне модуля и может потребоваться его явное копирование с контроллера, если он не запускается локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и эти параметры станут взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API "ресурс:действие" во время задачи, вы выводящий набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время playbook. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| deregister_unused логический тип |
| По умолчанию, целевые узлы, которые не используются, остаются зарегистрированными. Если вы хотите их удалить, установите deregister_unused=true. |
| ec2_url строка | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она присутствует. псевдонимы: aws_endpoint_url, endpoint_url | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их одновременного указания вместе с profile устарела. aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она присутствует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и эти параметры станут взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка / обязательно |
| Регистрация или отрегистрация целевого узла. |
| target_az строка | Зона доступности или all. Это определяет, получает ли целевой узел трафик от узлов балансировщика нагрузки в указанной зоне доступности или от всех включенных зон доступности балансировщика нагрузки. Этот параметр не поддерживается, если тип целевого узла группы целевых узлов — экземпляр. | |
| target_group_arn строка | Amazon Resource Name (ARN) группы целевых узлов. Взаимоисключающий с target_group_name. | |
| target_group_name строка | Имя группы целевых узлов. Взаимоисключающий с target_group_arn. | |
| target_id строка / обязательно | Идентификатор целевого узла. | |
| target_port целое число | Порт, на котором слушает целевой узел. Можно указать переопределение порта. Если целевой узел уже зарегистрирован, можно зарегистрировать его снова с использованием другого порта. По умолчанию для целевого узла используется порт группы целевых узлов. | |
| target_status строка |
| Блокирует и ждет, пока статус целевого узла не станет равным заданному значению. Более подробную информацию о статусе целевого узла см. по адресу https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#target-health-states
|
| target_status_timeout целое число | По умолчанию: 60 | Максимальное время в секундах ожидания изменения target_status. |
| validate_certs логический тип |
| При значении "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если при регистрации целевого узла было указано переопределение порта, необходимо указать и идентификатор целевого узла, и порт при его от регистрации.
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION,AWS_CA_BUNDLE - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONмогут использоваться для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Register an IP address target to a target group
community.aws.elb_target:
target_group_name: myiptargetgroup
target_id: i-1234567
state: present
- name: Register an instance target to a target group
community.aws.elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
state: present
- name: Deregister a target from a target group
community.aws.elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
state: absent
# Modify a target to use a different port
- name: Register a target to a target group
community.aws.elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
target_port: 8080
state: present
Авторы
- Rob White (@wimnat)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/elb_target_module.html