Spec-Zone.ru › Ansible 2.8

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
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
- / обязательно
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
- / обязательно
    Варианты:
  • present
  • absent
регистрация или дерегистрация экземпляра
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
    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
    loop: "{{ ec2_elbs }}"

Статус

  • Этот модуль гарантированно не будет содержать обратной совместимости в будущем. [stableinterface]
  • Этот модуль поддерживается сообществом 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.8/modules/ec2_elb_module.html

Spec-Zone.ru

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