Spec-Zone.ru › Ansible 2.5

lightsail - Создание или удаление виртуальной машины в AWS Lightsail

Новая версия 2.4.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Обзор

  • Создаёт или экземпляры в AWS Lightsail и, по желанию, ожидает, пока он не станет «запущенным».

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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
blueprint_id Значение по умолчанию:
None
Идентификатор образа шаблона экземпляра. Требуется, когда state='present'
bundle_id Значение по умолчанию:
None
Набор данных о спецификации экземпляра. Требуется, когда state='present'
ec2_url Значение по умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если она задана.
key_pair_name Значение по умолчанию:
None
Имя пары ключей для использования с экземпляром
name
обязательно
Значение по умолчанию:
None
Имя экземпляра
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
    Варианты:
  • present ←
  • absent
  • running
  • restarted
  • stopped
Указывает желаемое состояние целевого объекта.
user_data Значение по умолчанию:
None
Сценарий запуска, который может настроить экземпляр с дополнительными данными
validate_certs
(добавлено в 1.5)
    Варианты:
  • no
  • yes ←
При значении "no", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
wait
    Варианты:
  • yes ←
  • no
Ожидать, пока экземпляр не перейдёт в состояние 'running' перед возвратом. Если wait = "no", адрес IP может не быть возвращён
wait_timeout Значение по умолчанию:
300
Сколько времени ожидать, прежде чем wait прекратит ожидание (в секундах).
zone Значение по умолчанию:
None
Зона доступности AWS, в которой должен быть запущен экземпляр. Требуется, когда state='present'

Примечания

Примечание

  • Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета 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

Примеры

# Create a new Lightsail instance, register the instance details
- lightsail:
    state: present
    name: myinstance
    region: us-east-1
    zone: us-east-1a
    blueprint_id: ubuntu_16_04
    bundle_id: nano_1_0
    key_pair_name: id_rsa
    user_data: " echo 'hello world' > /home/ubuntu/test.txt"
    wait_timeout: 500
  register: my_instance

- debug:
    msg: "Name is {{ my_instance.instance.name }}"

- debug:
    msg: "IP is {{ my_instance.instance.public_ip_address }}"

# Delete an instance if present
- lightsail:
    state: absent
    region: us-east-1
    name: myinstance

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
changed
bool
всегда
если снимок был изменён/создан

Пример:
{'changed': True}
instance
dict
всегда
данные экземпляра

Пример:
{'username': 'ubuntu', 'blueprint_name': 'Ubuntu', 'public_ip_address': '34.207.152.202', 'blueprint_id': 'ubuntu_16_04', 'hardware': {'cpu_count': 1, 'ram_size_in_gb': 0.5}, 'bundle_id': 'nano_1_0', 'arn': 'arn:aws:lightsail:us-east-1:448830907657:Instance/1fef0175-d6c8-480e-84fa-214f969cda87', 'support_code': '588307843083/i-0997c97831ee21e33', 'networking': {'ports': [{'access_direction': 'inbound', 'common_name': '', 'access_from': 'Anywhere (0.0.0.0/0)', 'from_port': 80, 'protocol': 'tcp', 'to_port': 80, 'access_type': 'public'}, {'access_direction': 'inbound', 'common_name': '', 'access_from': 'Anywhere (0.0.0.0/0)', 'from_port': 22, 'protocol': 'tcp', 'to_port': 22, 'access_type': 'public'}], 'monthly_transfer': {'gb_per_month_allocated': 1024}}, 'name': 'my_instance', 'created_at': '2017-03-27T08:38:59.714000-04:00', 'state': {'code': 16, 'name': 'running'}, 'is_static_ip': False, 'ssh_key_name': 'keypair', 'location': {'region_name': 'us-east-1', 'availability_zone': 'us-east-1a'}, 'private_ip_address': '172.26.8.14', 'resource_type': 'Instance'}


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратный.

Автор

  • Nick Ball (@nickball)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.

© 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/lightsail_module.html

Spec-Zone.ru

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