Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.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

логическое значение

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

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

Варианты:

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

api_endpoint

строка

URL конечной точки API (без завершающей косой черты).

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

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

api_key

строка / обязательный

Ключ API Vultr.

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

api_results_per_page

целое число

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

При получении большого количества ресурсов укажите, сколько результатов должно возвращаться при каждом вызове API.

Этот параметр не определяет количество возвращаемых результатов: все ресурсы возвращаются с учётом других фильтров.

Максимальное значение для API Vultr — 500.

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

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

api_retries

целое число

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

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

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

api_retry_max_delay

целое число

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

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

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

api_timeout

целое число

Тайм-аут HTTP-запроса к API Vultr.

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

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

app

строка

Имя приложения для развёртывания из каталога приложений Vultr OneClick.

Не может использоваться одновременно с image и os.

backups

логическое значение

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

Варианты:

  • false
  • true

ddos_protection

логическое значение

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

Варианты:

  • false
  • true

enable_ipv6

логическое значение

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

Варианты:

  • false
  • true

firewall_group

строка

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

hostname

строка

Имя узла, назначаемое этому экземпляру.

image

строка

Имя образа для развёртывания приложений из Vultr Marketplace.

Не может использоваться одновременно с os и app.

label

псевдонимы: name

строка / обязательный

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

os

строка

Название операционной системы.

Не может использоваться одновременно с image и app.

plan

строка

Название тарифного плана для экземпляра.

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

region

строка / обязательный

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

reserved_ipv4

строка

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

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

skip_wait

логическое значение

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

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

Варианты:

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

snapshot

строка

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

Описание или идентификатор моментального снимка.

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

ssh_keys

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

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

startup_script

строка

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

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

state

строка

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

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

Варианты:

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

tags

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

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

user_data

строка

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

user_scheme

строка

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

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

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

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

Варианты:

  • "root"
  • "limited"

validate_certs

логическое значение

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

Варианты:

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

vpcs

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

добавлено в 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

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

Возвращается: при успешном выполнении

api_endpoint

string

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

Возвращается: при успешном выполнении

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

api_results_per_page

integer

Количество результатов, возвращаемых за один вызов API.

Возвращается: при успешном выполнении

Пример: 100

api_retries

integer

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

Возвращается: при успешном выполнении

Пример: 5

api_retry_max_delay

integer

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

Возвращается: при успешном выполнении

Пример: 12

api_timeout

integer

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

Возвращается: при успешном выполнении

Пример: 60

vultr_instance

dictionary

Ответ API Vultr.

Возвращается: при успешном выполнении

allowed_bandwidth

integer

Разрешённая пропускная способность экземпляра.

Возвращается: при успешном выполнении

Пример: 1000

app_id

integer

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

Возвращается: при успешном выполнении

Пример: 37

backups

string

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

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

Возвращается: при успешном выполнении

Пример: "enabled"

date_created

string

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

Возвращается: при успешном выполнении

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

ddos_protection

boolean

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

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

Возвращается: при успешном выполнении

Пример: true

disk

integer

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

Возвращается: при успешном выполнении

Пример: 25

enable_ipv6

boolean

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

Включён ли IPv6.

Возвращается: при успешном выполнении

Пример: true

features

list / elements=string

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

Возвращается: при успешном выполнении

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

firewall_group_id

string

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

Возвращается: при успешном выполнении

Пример: ""

gateway_v4

string

Шлюз IPv4.

Возвращается: при успешном выполнении

Пример: "95.179.188.1"

hostname

string

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

Возвращается: при успешном выполнении

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

id

string

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

Возвращается: при успешном выполнении

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

image_id

string

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

Возвращается: при успешном выполнении

Пример: ""

internal_ip

string

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

Возвращается: при успешном выполнении

Пример: ""

kvm

string

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

Возвращается: при успешном выполнении

Пример: "https://my.vultr.com/subs/vps/novnc/api.php?data=..."

label

string

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

Возвращается: при успешном выполнении

Пример: "my instance"

main_ip

string

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

Возвращается: при успешном выполнении

Пример: "95.179.189.95"

netmask_v4

string

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

Возвращается: при успешном выполнении

Пример: "255.255.254.0"

os

string

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

Возвращается: при успешном выполнении

Пример: "Application"

os_id

integer

ID операционной системы экземпляра.

Возвращается: при успешном выполнении

Пример: 186

plan

string

Тарифный план экземпляра.

Возвращается: при успешном выполнении

Пример: "vc2-1c-1gb"

power_status

string

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

Возвращается: при успешном выполнении

Пример: "running"

ram

integer

Объём оперативной памяти экземпляра в МБ.

Возвращается: при успешном выполнении

Пример: 1024

region

string

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

Возвращается: при успешном выполнении

Пример: "ews"

server_status

string

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

Возвращается: при успешном выполнении

Пример: "installingbooting"

status

string

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

Возвращается: при успешном выполнении

Пример: "active"

tags

list / elements=string

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

Возвращается: при успешном выполнении

Пример: ["my-tag"]

user_data

string

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

Возвращается: при успешном выполнении

Пример: "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIGh0b3AK"

user_scheme

string

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

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

Возвращается: при успешном выполнении

Пример: "root"

v6_main_ip

string

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

Возвращается: при успешном выполнении

Пример: ""

v6_network

string

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

Возвращается: при успешном выполнении

Пример: ""

v6_network_size

integer

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

Возвращается: при успешном выполнении

Пример: 0

vcpu_count

integer

Количество vCPU экземпляра.

Возвращается: при успешном выполнении

Пример: 1

vpcs

list / elements=string

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

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

Возвращается: при успешном выполнении

description

string

Описание VPC.

Возвращается: при успешном выполнении

Пример: "my vpc"

id

string

ID VPC.

Возвращается: при успешном выполнении

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

ip_address

string

IP-адрес, назначенный из VPC.

Возвращается: при успешном выполнении

Пример: "192.168.23.3"

mac_address

string

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

Возвращается: при успешном выполнении

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

Авторы

  • René Moser (@resmo)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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