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 | |
| debug_botocore_endpoint_logs логический тип добавлен в 2.8 |
| Использует логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводия набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, созданный во время выполнения playbook. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_elbs - | Список имен ELB, необходимых для регистрации. Факт ec2_elbs следует использовать, если ранее была произведена дерегистрация. | |
| ec2_url строка | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | |
| enable_availability_zone логический тип |
| Включить зону доступности экземпляра в целевом ELB, если зона доступности еще не включена. Если установлено значение «нет», задача завершится ошибкой, если зона доступности не включена в ELB. |
| instance_id - / обязательно | Идентификатор экземпляра EC2 | |
| profile строка | Использует профиль 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 строка | AWS STS-токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. алиасы: access_token | |
| state - / обязательно |
| регистрация или дерегистрация экземпляра |
| validate_certs логический тип |
| Если установлено значение «нет», сертификаты SSL для версий boto >= 2.6.0 не будут проверены. |
| wait логический тип |
| Ожидать завершения регистрации или дерегистрации экземпляра до возврата. |
| wait_timeout - | Значение по умолчанию: 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), если учетные данные не предоставлены. См. 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: 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
loop: "{{ ec2_elbs }}"
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/elb_instance_module.html