Spec-Zone.ru › Ansible 2.6

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

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

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Требования

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

  • python >= 2.6

Параметры

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

псевдонимы: label
notify_activate
bool
    Варианты:
  • no
  • yes
Отправлять ли письмо об активации, когда сервер готов или нет.
Рассматривается только при создании.
os
Операционная система.
Требуется, если сервер ещё не существует.
plan
План, который будет использоваться для сервера.
Требуется, если сервер ещё не существует.
private_network_enabled
bool
    Варианты:
  • 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
bool
    Варианты:
  • no
  • yes ←
Проверять сертификаты SSL Vultr API.

Примечания

Примечание

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

Примеры

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

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

- name: ensure a server is present and stopped
  local_action:
    module: vr_server
    name: "{{ vr_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: vr_server
    name: "{{ vr_server_name }}"
    state: stopped

- name: ensure an existing server is started
  local_action:
    module: vr_server
    name: "{{ vr_server_name }}"
    state: started

- name: ensure a server is absent
  local_action:
    module: vr_server
    name: "{{ vr_server_name }}"
    state: absent

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

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

Ключ Возвращаемое значение Описание
vultr_api
complex
success
Ответ от API Vultr с некоторыми дополнениями/изменениями

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

Пример:
default
api_timeout
int
success
Таймаут, используемый для запросов API

Пример:
60
api_retries
int
success
Количество максимальных попыток повтора для запросов API

Пример:
5
api_endpoint
string
success
Эндпоинт, используемый для запросов API

Пример:
https://api.vultr.com
vultr_server
complex
success
Ответ от API Vultr с некоторыми дополнениями/изменениями

id
string
success
ID сервера

Пример:
10194376
name
string
success
Название (метка) сервера

Пример:
ansible-test-vm
plan
string
success
Используемый план сервера

Пример:
1024 МБ ОЗУ,25 ГБ SSD,1,00 ТБ пропускная способность
allowed_bandwidth_gb
int
success
Разрешённая пропускная способность в ГБ

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

cost_per_month
float
success
Стоимость сервера в месяц

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

date_created
string
success
Дата создания сервера

Пример:
2017-08-26 12:47:48
default_password
string
success
Пароль для входа в сервер как root

Пример:
!p3EWYJm$qDWYaFr
disk
string
success
Информация о диске

Пример:
Виртуальные 25 ГБ
v4_gateway
string
success
IPv4 шлюз

Пример:
45.32.232.1
internal_ip
string
success
Внутренний IP-адрес

kvm_url
string
success
URL до VNC

Пример:
https://my.vultr.com/subs/vps/novnc/api.php?data=xyz
region
string
success
Регион развертывания сервера

Пример:
Амстердам
v4_main_ip
string
success
Основной IPv4

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

Пример:
255.255.254.0
os
string
success
Используемая операционная система для сервера

Пример:
CentOS 6 x64
firewall_group
string
success and available
Группа правил брандмауэра, назначенная серверу

Пример:
CentOS 6 x64
pending_charges
float
success
Неоплаченные платежи

Пример:
0.01
power_status
string
success
Статус питания сервера

Пример:
работает
ram
string
success
Информация о размере оперативной памяти

Пример:
1024 МБ
server_state
string
success
Статус сервера

Пример:
ok
status
string
success
Статус развертывания сервера

Пример:
активный
tag
string
success
XXX

v6_main_ip
string
success
Основной IPv6

v6_network
string
success
Сеть IPv6

v6_network_size
string
success
Размер сети IPv6

v6_networks
list
success
Сетевые подключения IPv6

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

Пример:
1


Статус

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

Техническое обслуживание

Этот модуль помечен как общественный, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом 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.6/modules/vr_server_module.html

Spec-Zone.ru

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