community.aws.ec2_elb – Дерегистрация или регистрация экземпляров из EC2 ELB
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.ec2_elb.
Новое в версии 1.0.0: of community.aws
Обзор
- Этот модуль дерегистрирует или регистрирует экземпляр AWS EC2 в ELB, к которому он принадлежит.
- Возвращает факт «ec2_elbs», который представляет собой список ELB, прикрепленных к экземпляру, если в качестве аргумента передано state=absent.
- Отмечен как изменённый только в том случае, если найдены ELB для обработки.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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'. Подробнее о конфигурации boto см. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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:action», выполняемых во время задачи, вывода набора в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения книги задач. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_elbs список / элементы=строка | Список имен ELB, необходимый для регистрации. Для регистрации следует использовать факт ec2_elbs, если ранее была дерегистрация. | |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной среды EC2_URL, если таковое имеется. псевдонимы: aws_endpoint_url, endpoint_url | |
| enable_availability_zone логический тип |
| Включает ли доступ к зоне доступности экземпляра в целевом ELB, если зона доступности ещё не включена. Если установлено в «нет», задача завершится неудачей, если зона доступности не включена в ELB. |
| instance_id строка / обязательный | Идентификатор экземпляра EC2 | |
| 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 строка / обязательный |
| регистрация или дерегистрация экземпляра |
| validate_certs логический тип |
| При значении «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. |
| wait логический тип |
| Ожидание завершения успешной регистрации или дерегистрации экземпляра перед возвратом. |
| wait_timeout целое число | Значение по умолчанию: 0 | Количество секунд ожидания изменения состояния экземпляра. Если 0, данный модуль может вернуть ошибку, если произойдёт временная ошибка. Если не нулевое, то любые временные ошибки игнорируются до достижения таймаута. Игнорируется, если wait=no. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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
Примеры
# basic pre_task and post_task example
pre_tasks:
- name: Instance De-register
community.aws.ec2_elb:
instance_id: "{{ ansible_ec2_instance_id }}"
state: absent
roles:
- myrole
post_tasks:
- name: Instance Register
community.aws.ec2_elb:
instance_id: "{{ ansible_ec2_instance_id }}"
ec2_elbs: "{{ item }}"
state: present
loop: "{{ ec2_elbs }}"
Авторы
- John Jarvis (@jarv)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/ec2_elb_module.html
