Spec-Zone.ru › Ansible 2.7

vultr_server – Управляет виртуальными серверами на Vultr.

Новое в версии 2.5.

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

Краткое описание

  • Развёртывание, запуск, остановка, обновление, перезапуск, переустановка серверов.

Псевдонимы: vr_server

Требования

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

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_account
-
По умолчанию:
"default"
Имя раздела ini в файле vultr.ini.
Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если она определена.
api_endpoint
-
URL конечной точки API (без конечного слэша).
Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если она определена.
Значение по умолчанию – https://api.vultr.com, если не указано.
api_key
-
Ключ API Vultr API.
Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена.
api_retries
-
Количество попыток повтора, в случае, если Vultr API возвращает код HTTP 503.
Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.
Значение по умолчанию – 5 попыток, если не указано.
api_timeout
-
Таймаут HTTP для Vultr API.
Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.
Значение по умолчанию – 60 секунд, если не указано.
auto_backup_enabled
boolean
    Варианты:
  • no
  • yes
Включить автоматические резервные копии или нет.
firewall_group
-
Группа брандмауэра, которой нужно назначить этот сервер.
force
boolean
    Варианты:
  • no
  • yes
Принудительно остановить/запустить сервер, если необходимо применить изменения.
В противном случае работающий сервер не будет изменён.
hostname
-
Имя хоста для назначения этому серверу.
ipv6_enabled
boolean
    Варианты:
  • no
  • yes
Включить IPv6 или нет.
name
- / обязательно
Имя сервера.

псевдонимы: label
notify_activate
boolean
    Варианты:
  • no
  • yes
Отправить ли электронное письмо об активации, когда сервер готов?
Рассматривается только при создании.
os
-
Операционная система.
Обязательно, если сервер ещё не существует.
plan
-
Используемый план для сервера.
Обязательно, если сервер ещё не существует.
private_network_enabled
boolean
    Варианты:
  • no
  • yes
Включить ли частную сеть?
region
-
Регион для развёртывания сервера.
Обязательно, если сервер ещё не существует.
reserved_ip_v4
-
IP-адрес плавающего IP-адреса для использования в качестве основного IP-адреса этого сервера.
Рассматривается только при создании.
ssh_keys
-
Список SSH-ключей, передаваемых серверу при создании.

псевдонимы: ssh_key
startup_script
-
Имя скрипта запуска для выполнения при запуске.
Рассматривается только при создании сервера.
state
-
    Варианты:
  • present ←
  • absent
  • restarted
  • reinstalled
  • started
  • stopped
Состояние сервера.
tag
-
Тег для сервера.
user_data
-
Данные пользователя, которые будут переданы серверу.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Проверять SSL-сертификаты Vultr API.

Примечания

Примечание

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

Примеры

- name: create server
  local_action:
    module: vultr_server
    name: "{{ vultr_server_name }}"
    os: CentOS 7 x64
    plan: 1024 MB RAM,25 GB SSD,1.00 TB BW
    ssh_keys:
      - my_key
      - your_key
    region: Amsterdam
    state: present

- name: ensure a server is present and started
  local_action:
    module: vultr_server
    name: "{{ vultr_server_name }}"
    os: CentOS 7 x64
    plan: 1024 MB RAM,25 GB SSD,1.00 TB BW
    ssh_key: my_key
    region: Amsterdam
    state: started

- name: ensure a server is present and stopped
  local_action:
    module: vultr_server
    name: "{{ vultr_server_name }}"
    os: CentOS 7 x64
    plan: 1024 MB RAM,25 GB SSD,1.00 TB BW
    region: Amsterdam
    state: stopped

- name: ensure an existing server is stopped
  local_action:
    module: vultr_server
    name: "{{ vultr_server_name }}"
    state: stopped

- name: ensure an existing server is started
  local_action:
    module: vultr_server
    name: "{{ vultr_server_name }}"
    state: started

- name: ensure a server is absent
  local_action:
    module: vultr_server
    name: "{{ vultr_server_name }}"
    state: absent

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

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

Ключ Возвращено Описание
vultr_api
сложный
успех
Ответ от API Vultr с несколькими дополнениями/изменениями

api_account
строка
успех
Аккаунт, используемый в файле ini для выбора ключа

Пример:
default
api_endpoint
строка
успех
Точка входа, используемая для запросов API

Пример:
https://api.vultr.com
api_retries
целое число
успех
Количество максимальных попыток повторных запросов API

Пример:
5
api_timeout
целое число
успех
Таймаут, используемый для запросов API

Пример:
60
vultr_server
сложный
успех
Ответ от API Vultr с несколькими дополнениями/изменениями

allowed_bandwidth_gb
целое число
успех
Разрешённая пропускная способность в ГБ

Пример:
1000
auto_backup_enabled
булево
успех
Включены ли автоматические резервные копии

cost_per_month
вещественное число
успех
Стоимость в месяц за сервер

Пример:
5.0
current_bandwidth_gb
целое число
успех
Текущая пропускная способность, используемая сервером

date_created
строка
успех
Дата создания сервера

Пример:
2017-08-26 12:47:48
default_password
строка
успех
Пароль для входа в качестве root на сервер

Пример:
!p3EWYJm$qDWYaFr
disk
строка
успех
Информация о диске

Пример:
Виртуальный 25 ГБ
firewall_group
строка
успех и доступно
Группа межсетевых экранов, к которой назначен сервер

Пример:
CentOS 6 x64
id
строка
успех
Идентификатор сервера

Пример:
10194376
internal_ip
строка
успех
Внутренний IP

kvm_url
строка
успех
URL для VNC

Пример:
https://my.vultr.com/subs/vps/novnc/api.php?data=xyz
name
строка
успех
Имя (метка) сервера

Пример:
ansible-test-vm
os
строка
успех
Операционная система, используемая на сервере

Пример:
CentOS 6 x64
pending_charges
вещественное число
успех
Неоплаченные счета

Пример:
0.01
plan
строка
успех
Используемый план для сервера

Пример:
1024 МБ ОЗУ, 25 ГБ SSD, 1,00 ТБ пропускной способности
power_status
строка
успех
Состояние питания сервера

Пример:
работает
ram
строка
успех
Информация о размере ОЗУ

Пример:
1024 МБ
region
строка
успех
Регион развертывания сервера

Пример:
Амстердам
server_state
строка
успех
Состояние сервера

Пример:
в порядке
status
строка
успех
Состояние развертывания сервера

Пример:
активный
tag
строка
успех
В процессе определения

v4_gateway
строка
успех
Шлюз IPv4

Пример:
45.32.232.1
v4_main_ip
строка
успех
Основной IPv4

Пример:
45.32.233.154
v4_netmask
строка
успех
Маска подсети IPv4

Пример:
255.255.254.0
v6_main_ip
строка
успех
Основной IPv6

v6_network
строка
успех
Сеть IPv6

v6_network_size
строка
успех
Размер сети IPv6

v6_networks
список
успех
Сети IPv6

vcpu_count
целое число
успех
Количество виртуальных процессоров

Пример:
1


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [предварительный просмотр]
  • Этот модуль поддерживается Сообществом Ansible. [сообщество]

Авторы

  • René Moser (@resmo)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vultr_server_module.html

Spec-Zone.ru

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