elb_instance - Дерегистрация или регистрация экземпляров из EC2 ELB
Обзор
- Этот модуль дерегистрирует или регистрирует экземпляр 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. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | нет | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| ec2_elbs | нет | None | Список имен ELB, необходимых для регистрации. Факт ec2_elbs следует использовать, если ранее выполнялась дерегистрация. | |
| ec2_url | нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть. | ||
| enable_availability_zone | нет | True |
| Включить зону доступности экземпляра в целевом ELB, если зона доступности еще не включена. Если установлено значение "нет", задача завершится неудачей, если зона доступности не включена в ELB. |
| instance_id | да | ID экземпляра EC2 | ||
| profile (добавлен в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region | нет | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_token (добавлен в 1.6)
| нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state | да |
| зарегистрировать или дерегистрировать экземпляр | |
| validate_certs (добавлен в 1.5)
| нет | да |
| Если установлено значение "нет", сертификаты SSL для boto версии >= 2.6.0 не будут проверены. |
| wait | нет | True |
| Дождаться успешного завершения регистрации или дерегистрации экземпляра перед возвратом. |
| wait_timeout (добавлен в 1.6)
| нет | Количество секунд ожидания изменения состояния экземпляра. Если 0, этот модуль может вернуть ошибку, если произойдет временная ошибка. Если ненулевое, любые временные ошибки игнорируются до достижения таймаута. Игнорируется, когда wait=no. |
Примеры
# basic pre_task and post_task example
pre_tasks:
- name: Gathering ec2 facts
action: ec2_facts
- name: Instance De-register
elb_instance:
instance_id: "{{ ansible_ec2_instance_id }}"
state: absent
delegate_to: localhost
roles:
- myrole
post_tasks:
- name: Instance Register
elb_instance:
instance_id: "{{ ansible_ec2_instance_id }}"
ec2_elbs: "{{ item }}"
state: present
delegate_to: localhost
with_items: "{{ ec2_elbs }}"
Примечания
Примечание
- Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Для помощи в разработке модулей, если у вас есть такое желание, прочтите Информацию о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/elb_instance_module.html