Spec-Zone.ru › Ansible

Модуль vultr.cloud.instance – Управляет серверными экземплярами на Vultr.

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в книге задач укажите: vultr.cloud.instance.

Новая функция в vultr.cloud 1.1.0

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

Обзор

  • Управление серверными экземплярами на Vultr.

Параметры

Параметр

Комментарии

activation_email

boolean

Отправлять ли письмо с подтверждением готовности экземпляра.

Учитывается только при создании.

Варианты:

  • false ← (default)
  • true

api_endpoint

string

URL конечной точки API (без косой черты в конце).

Резервная переменная окружения VULTR_API_ENDPOINT.

По умолчанию: "https://api.vultr.com/v2"

api_key

string / required

API ключ Vultr API.

Резервная переменная окружения VULTR_API_KEY.

api_retries

integer

Количество попыток в случае, если Vultr API возвращает код HTTP ошибки, например - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out

Резервная переменная окружения VULTR_API_RETRIES.

По умолчанию: 5

api_retry_max_delay

integer

Задержка повторной попытки в секундах, экспоненциально возрастает до этого максимального значения, в секундах.

Резервная переменная окружения VULTR_API_RETRY_MAX_DELAY.

По умолчанию: 12

api_timeout

integer

Тайм-аут HTTP для Vultr API.

Резервная переменная окружения VULTR_API_TIMEOUT.

По умолчанию: 180

app

string

Имя развертывания приложения Vultr OneClick.

Взаимоисключающе с image и os.

backups

boolean

Включать ли автоматическое резервное копирование.

Варианты:

  • false
  • true

ddos_protection

boolean

Включать ли защиту от DDoS-атак.

Варианты:

  • false
  • true

enable_ipv6

boolean

Включать ли IPv6.

Варианты:

  • false
  • true

firewall_group

string

Описание группы брандмауэра, к которой будет привязан этот экземпляр.

hostname

string

Имя хоста для этого экземпляра.

image

string

Имя развертывания образа из каталога Vultr Marketplace.

Взаимоисключающе с os и app.

label

aliases: name

string / required

Имя экземпляра.

os

string

Имя операционной системы.

Взаимоисключающе с image и app.

plan

string

Имя плана, который будет использоваться для экземпляра.

Обязательно, если экземпляр еще не существует.

region

string / required

Регион, в котором развернут экземпляр.

reserved_ipv4

string

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

Учитывается только при создании.

skip_wait

boolean

added in vultr.cloud 1.13.0

Пропускать ли ожидание полной готовности экземпляра для доступа.

Варианты:

  • false ← (default)
  • true

snapshot

string

added in vultr.cloud 1.7.0

Описание или ID снимка.

Учитывается только при создании экземпляра.

ssh_keys

list / elements=string

Список имен ключей SSH, передаваемых экземпляру при создании.

startup_script

string

Имя или ID скрипта запуска, который будет выполнен при загрузке.

Учитывается только при создании экземпляра.

состояние

строка

Состояние экземпляра.

Состояние reinstalled было добавлено в версии 1.8.0.

Выбоpы:

  • "present" ← (по умолчанию)
  • "absent"
  • "started"
  • "stopped"
  • "restarted"
  • "reinstalled"

метки

список / элементы=строка

Метки для экземпляра.

данные_пользователя

строка

Данные пользователя, которые необходимо передать экземпляру.

схема_пользователя

строка

добавлено в vultr.cloud 1.11.0

Схема пользователя, используемая в качестве имени пользователя для входа (только Linux).

По умолчанию настроен пользователь root.

Учитывается только при создании экземпляра.

Выбоpы:

  • "root"
  • "limited"

проверять_сертификаты

булево

Проверка SSL-сертификатов API Vultr.

Выбоpы:

  • false
  • true ← (по умолчанию)

vpc

список / элементы=строка

добавлено в vultr.cloud 1.5.0

Список VPC, идентифицированных по их описанию, которые необходимо назначить экземпляру.

Примечания

Примечание

  • См. также документацию API по адресу https://www.vultr.com/api/.

Примеры

---
- name: Create an instance using OS
  vultr.cloud.instance:
    label: my web server
    hostname: my-hostname
    user_data: |
      #cloud-config
      packages:
        - nginx
    firewall_group: my firewall group
    plan: vc2-1c-2gb
    ddos_protection: true
    backups: true
    enable_ipv6: true
    ssh_keys:
      - my ssh key
    vpcs:
      - my vpc description
    tags:
      - web
      - project-genesis
    region: ams
    os: Debian 12 x64 (bookworm)

- name: Deploy an instance of a marketplace app
  vultr.cloud.instance:
    label: git-server
    hostname: git
    firewall_group: my firewall group
    plan: vc2-1c-2gb
    ddos_protection: true
    backups: true
    enable_ipv6: true
    region: ams
    image: Gitea on Ubuntu 20.04

- name: Stop an existing instance
  vultr.cloud.instance:
    label: my web server
    region: ams
    state: stopped

- name: Start an existing instance
  vultr.cloud.instance:
    label: my web server
    region: ams
    state: started

- name: Reinstall an instance
  vultr.cloud.instance:
    label: my web server
    region: ams
    state: reinstalled

- name: Delete an instance
  vultr.cloud.instance:
    label: my web server
    region: ams
    state: absent

Значения возврата

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

Ключ

Описание

vultr_api

dictionary

Ответ от Vultr API с некоторыми дополнениями/изменениями.

Возвращается: success

api_endpoint

string

Конечная точка, используемая для API-запросов.

Возвращается: success

Пример: "https://api.vultr.com/v2"

api_retries

integer

Максимальное количество повторных попыток для API-запросов.

Возвращается: success

Пример: 5

api_retry_max_delay

integer

Экспоненциальная задержка отката в секундах между повторными попытками до этого максимального значения задержки.

Возвращается: success

Пример: 12

api_timeout

integer

Тайм-аут, используемый для API-запросов.

Возвращается: success

Пример: 60

vultr_instance

dictionary

Ответ от Vultr API.

Возвращается: success

allowed_bandwidth

integer

Допустимая пропускная способность экземпляра.

Возвращается: success

Пример: 1000

app_id

integer

ID приложения экземпляра.

Возвращается: success

Пример: 37

backups

string

added in vultr.cloud 1.3.0

Включено или выключено резервное копирование.

Возвращается: success

Пример: "enabled"

date_created

string

Дата создания экземпляра.

Возвращается: success

Пример: "2020-10-10T01:56:20+00:00"

ddos_protection

boolean

added in vultr.cloud 1.3.0

Включена или нет защита от DDoS.

Возвращается: success

Пример: true

disk

integer

Размер диска экземпляра.

Возвращается: success

Пример: 25

enable_ipv6

boolean

added in vultr.cloud 1.3.0

Включен или нет IPv6.

Возвращается: success

Пример: true

features

list / elements=string

Функции экземпляра.

Возвращается: success

Пример: ["ddos_protection", "ipv6", "auto_backups"]

firewall_group_id

string

ID группы брандмауэра экземпляра.

Возвращается: success

Пример: ""

gateway_v4

string

Шлюз IPv4.

Возвращается: success

Пример: "95.179.188.1"

hostname

string

Имя хоста экземпляра.

Возвращается: success

Пример: "vultr.guest"

id

string

ID экземпляра.

Возвращается: success

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

image_id

string

Идентификатор образа экземпляра.

Returned: success

Sample: ""

internal_ip

string

Внутренний IP-адрес экземпляра.

Returned: success

Sample: ""

kvm

string

KVM экземпляра.

Returned: success

Sample: "https://my.vultr.com/subs/vps/novnc/api.php?data=..."

label

string

Метка экземпляра.

Returned: success

Sample: "my instance"

main_ip

string

IPv4 экземпляра.

Returned: success

Sample: "95.179.189.95"

netmask_v4

string

Netmask IPv4 экземпляра.

Returned: success

Sample: "255.255.254.0"

os

string

ОС экземпляра.

Returned: success

Sample: "Application"

os_id

integer

Идентификатор ОС экземпляра.

Returned: success

Sample: 186

plan

string

План экземпляра.

Returned: success

Sample: "vc2-1c-1gb"

power_status

string

Состояние питания экземпляра.

Returned: success

Sample: "running"

ram

integer

ОЗУ в МБ экземпляра.

Returned: success

Sample: 1024

region

string

Регион, в котором был развернут экземпляр.

Returned: success

Sample: "ews"

server_status

string

Состояние сервера экземпляра.

Returned: success

Sample: "installingbooting"

status

string

Статус развертывания экземпляра.

Returned: success

Sample: "active"

tags

list / elements=string

Теги экземпляра.

Returned: success

Sample: ["my-tag"]

user_data

string

Закодированные в Base64 пользовательские данные (cloud init) экземпляра.

Returned: success

Sample: "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIGh0b3AK"

user_scheme

string

added in vultr.cloud 1.11.0

Схема пользователя для входа в этот экземпляр

Returned: success

Sample: "root"

v6_main_ip

string

IPv6 экземпляра.

Returned: success

Sample: ""

v6_network

string

IPv6 сеть экземпляра.

Возвращаемое значение: success

Пример: ""

v6_network_size

integer

Размер IPv6 сети экземпляра.

Возвращаемое значение: success

Пример: 0

vcpu_count

integer

vCPUs экземпляра.

Возвращаемое значение: success

Пример: 1

vpcs

list / elements=string

added in vultr.cloud 1.5.0

Список подключенных VPC.

Возвращаемое значение: success

description

string

Описание VPC.

Возвращаемое значение: success

Пример: "my vpc"

id

string

ID VPC.

Возвращаемое значение: success

Пример: "5536d2a4-66fd-4dfb-b839-7672fd5bc116"

ip_address

string

IP, назначенный из VPC.

Возвращаемое значение: success

Пример: "192.168.23.3"

mac_address

string

MAC-адрес сетевого интерфейса.

Возвращаемое значение: success

Пример: "5a:01:04:3d:5e:72"

Авторы

  • René Moser (@resmo)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (Исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/instance_module.html

Spec-Zone.ru

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