Spec-Zone.ru › Ansible 2.7

ec2_elb – Дерегистрация или регистрация экземпляров из 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
-
Список имён ELB, необходимых для регистрации. Факт ec2_elbs должен использоваться, если ранее производилась дерегистрация.
ec2_url
-
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
enable_availability_zone
boolean
    Варианты:
  • no
  • yes ←
Включить зону доступности экземпляра на целевом ELB, если зона доступности ещё не включена. Если установлено в no, задача завершится неудачей, если зона доступности не включена на 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
- / обязательно
    Варианты:
  • present
  • absent
регистрация или дерегистрация экземпляра
validate_certs
boolean
добавлен в 1.5
    Варианты:
  • no
  • yes ←
При установке в «no», сертификаты SSL не будут проверены для версий boto >= 2.6.0.
wait
boolean
    Варианты:
  • no
  • yes ←
Дождаться успешного завершения регистрации или дерегистрации экземпляра перед возвратом.
wait_timeout
-
добавлен в 1.6
По умолчанию:
0
Количество секунд ожидания изменения состояния экземпляра. Если 0, модуль может вернуть ошибку, если произойдет временная ошибка. Если ненулевое, любые временные ошибки игнорируются до достижения таймаута. Игнорируется, когда wait=no.

Примечания

Примечание

  • Если параметры не заданы в модуле, следующие переменные окружения могут использоваться в порядке убывания приоритета 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
    local_action:
      module: ec2_elb
      instance_id: "{{ ansible_ec2_instance_id }}"
      state: absent
roles:
  - myrole
post_tasks:
  - name: Instance Register
    local_action:
      module: ec2_elb
      instance_id: "{{ ansible_ec2_instance_id }}"
      ec2_elbs: "{{ item }}"
      state: present
    with_items: "{{ ec2_elbs }}"

Статус

  • Этот модуль гарантирует отсутствие изменений интерфейса, несовместимых с предыдущими версиями. [stableinterface]
  • Этот модуль поддерживается партнером Ansible. [certified]

Авторы

  • 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.7/modules/ec2_elb_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API