Spec-Zone.ru › Ansible 2.11

community.digitalocean.digital_ocean_droplet – Создание и удаление дроплетов DigitalOcean

Примечание

Этот плагин входит в коллекцию community.digitalocean (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.digitalocean.

Для использования в книге задач укажите: community.digitalocean.digital_ocean_droplet.

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

Описание

  • Создание и удаление дроплетов в DigitalOcean и, по желанию, ожидание их активации.

Требования

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

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
backups
boolean
    Варианты:
  • нет ←
  • да
указывает, следует ли включить автоматические резервные копии.
id
string
Числовое значение, идентификатор дроплету, над которым необходимо произвести операцию.

псевдонимы: droplet_id
image
string
Это имя образа, с которым необходимо создать дроплет.

псевдонимы: image_id
ipv6
boolean
    Варианты:
  • нет ←
  • да
включить IPv6 для вашего дроплету.
monitoring
boolean
    Варианты:
  • нет ←
  • да
указывает, следует ли установить агент DigitalOcean для мониторинга.
name
string
Строка, это имя дроплету — должно соответствовать правилам именования хостов.
oauth_token
string / required
Токен DigitalOcean OAuth. Можно указать в DO_API_KEY, DO_API_TOKEN, или DO_OAUTH_TOKEN переменных окружения

псевдонимы: API_TOKEN
private_networking
boolean
    Варианты:
  • нет ←
  • да
добавить дополнительный частный сетевой интерфейс к дроплету для междроплетовой связи.
region
string
Это имя региона, в котором вы хотите создать свой сервер.

псевдонимы: region_id
size
string
Это имя размера, с которым вы хотите создать дроплет.

псевдонимы: size_id
ssh_keys
string
массив отпечатков ключей SSH, которые вы хотите добавить к серверу.
state
string
    Варианты:
  • present ←
  • absent
Указывает желаемое состояние целевого объекта.
tags
string
Список, список имён тегов в виде строк для применения к дроплету после его создания. Имена тегов могут быть существующими или новыми.
unique_name
boolean
    Варианты:
  • нет ←
  • да
требуются уникальные имена хостов. По умолчанию DigitalOcean разрешает несколько хостов с одинаковыми именами. Установка в «да» позволяет только одному хосту на имя. Полезно для идемпотентности.
user_data
string
неструктурированные данные, доступные дроплету
volumes
string
Список, список уникальных идентификаторов каждой точки хранения, которая должна быть подключена к дроплету.
vpc_uuid
string
добавлен в 0.1.0 community.digitalocean
Строка, определяющая UUID VPC, к которому будет назначен дроплет. Если опустить, дроплет будет назначен на стандартную VPC учётной записи в регионе.
wait
boolean
    Варианты:
  • нет
  • да ←
Подождать, пока дроплет активируется, перед возвратом. Если wait — «нет», адрес IP может не быть возвращён.
wait_timeout
string
По умолчанию:
120
Время ожидания, в секундах, до отмены ожидания при создании дроплету.

Примеры

- name: Create a new droplet
  community.digitalocean.digital_ocean_droplet:
    state: present
    name: mydroplet
    oauth_token: XXX
    size: 2gb
    region: sfo1
    image: ubuntu-16-04-x64
    wait_timeout: 500
    ssh_keys: [ .... ]
  register: my_droplet

- debug:
    msg: "ID is {{ my_droplet.data.droplet.id }}, IP is {{ my_droplet.data.ip_address }}"

- name: Ensure a droplet is present
  community.digitalocean.digital_ocean_droplet:
    state: present
    id: 123
    name: mydroplet
    oauth_token: XXX
    size: 2gb
    region: sfo1
    image: ubuntu-16-04-x64
    wait_timeout: 500

- name: Ensure a droplet is present with SSH keys installed
  community.digitalocean.digital_ocean_droplet:
    state: present
    id: 123
    name: mydroplet
    oauth_token: XXX
    size: 2gb
    region: sfo1
    ssh_keys: ['1534404', '1784768']
    image: ubuntu-16-04-x64
    wait_timeout: 500

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

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

Ключ Возвращаемое значение Описание
data
dictionary
changed
Объект DigitalOcean Droplet

Пример:
{'droplet': {'backup_ids': [], 'created_at': '2014-11-14T16:36:31Z', 'disk': 20, 'features': ['virtio'], 'id': 3164494, 'image': {}, 'kernel': {'id': 2233, 'name': 'Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic', 'version': '3.13.0-37-generic'}, 'locked': True, 'memory': 512, 'name': 'example.com', 'networks': {}, 'region': {}, 'size': {}, 'size_slug': '512mb', 'snapshot_ids': [], 'status': 'new', 'tags': ['web'], 'vcpus': 1, 'volume_ids': []}, 'ip_address': '104.248.118.172', 'ipv6_address': '2604:a880:400:d1::90a:6001', 'private_ipv4_address': '10.136.122.141'}


Авторы

  • Gurchet Rai (@gurch101)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/digitalocean/digital_ocean_droplet_module.html

Spec-Zone.ru

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