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 для API Vultr. Переменная среды `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 логическое значение	Варианты: нет да	Включить автоматические резервные копии или нет.
firewall_group -		Группа брандмауэра, которой нужно назначить этот сервер.
force логическое значение	Варианты: нет да	Принудительно остановить/запустить сервер, если необходимо применить изменения В противном случае работающий сервер не будет изменён.
hostname -		Имя хоста, которое нужно назначить этому серверу.
ipv6_enabled логическое значение	Варианты: нет да	Включить IPv6 или нет.
name - / обязательно		Имя сервера. Псевдонимы: метка
notify_activate логическое значение	Варианты: нет да	Отправлять электронное письмо об активации, когда сервер готов или нет. Рассматривается только при создании.
os -		Операционная система. Требуется, если сервер ещё не существует и не восстанавливается из снимка.
plan -		План, который нужно использовать для сервера. Требуется, если сервер ещё не существует.
private_network_enabled логическое значение	Варианты: нет да	Включить частную сеть или нет.
region -		Регион, в котором развертывается сервер. Требуется, если сервер ещё не существует.
reserved_ip_v4 -		IP-адрес плавающего IP, который нужно использовать в качестве основного IP этого сервера. Рассматривается только при создании.
snapshot - добавлено в 2.8		Имя снимка, с которого нужно восстановить сервер.
ssh_keys -		Список ключей SSH, переданных серверу при создании. Псевдонимы: ssh_key
startup_script -		Имя скрипта запуска, который нужно выполнить при загрузке. Рассматривается только при создании сервера.
state -	Варианты: present ← absent restarted reinstalled started stopped	Состояние сервера.
tag -		Тег для сервера.
user_data -		Данные пользователя, которые нужно передать серверу.
validate_certs логическое значение	Варианты: нет да ←	Проверять 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 строка	успех	Состояние сервера Пример: ok
	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

Статус

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

Авторы

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.8/modules/vultr_server_module.html