elb_instance - Дерегистрация или регистрация экземпляров из EC2 ELB
Описание
- Этот модуль дерегистрирует или регистрирует экземпляр AWS EC2 из ELB, к которому он принадлежит.
- Возвращает факт «ec2_elbs», который является списком ELB, присоединённых к экземпляру, если в качестве аргумента передано state=absent.
- Будет помечен как изменённый при вызове только в том случае, если найдены ELB, на которых необходимо произвести операцию.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key |
| ec2_elbs | Значение по умолчанию: None | Список имён ELB, необходимых для регистрации. Факт ec2_elbs следует использовать, если была предыдущая дерегистрация. |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не указан, используется значение переменной окружения EC2_URL, если таковая имеется. |
| enable_availability_zone |
| Включить зону доступности экземпляра в целевом ELB, если зона доступности ещё не включена. Если установлено значение "нет", задача завершится с ошибкой, если зона доступности не включена в ELB. |
| instance_id обязательно | Идентификатор экземпляра EC2 | |
| profile (добавлен в 1.6) | Значение по умолчанию: None | Использует профиль 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) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| state обязательно |
| регистрация или дерегистрация экземпляра |
| validate_certs (добавлен в 1.5) |
| При установке в значение "нет", сертификаты SSL не будут проверены для boto версий >= 2.6.0. |
| wait |
| Подождать завершения успешной регистрации или дерегистрации экземпляра перед возвратом. |
| wait_timeout (добавлен в 1.6) | Значение по умолчанию: 0 | Количество секунд ожидания изменения состояния экземпляра. Если 0, модуль может вернуть ошибку, если произойдёт временная ошибка. Если ненулевое, все временные ошибки игнорируются до истечения таймаута. Игнорируется, когда wait=нет. |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные окружения могут быть использованы в порядке убывания приоритета
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
Примеры
# 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 }}"
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратной совместимости интерфейса.
Автор
- 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.5/modules/elb_instance_module.html