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 |
| Включить или выключить автоматические резервные копии. |
| firewall_group | Группа правил брандмауэра для присвоения этому серверу. | |
| force | Принудительная остановка/запуск сервера, если необходимо применить изменения. В противном случае работающий сервер не будет изменён. | |
| hostname | Имя хоста, присваиваемое этому серверу. | |
| ipv6_enabled |
| Включить или выключить IPv6. |
| name обязательно | Имя сервера. алиасы: label | |
| notify_activate |
| Отправлять ли электронное письмо об активации, когда сервер готов? Рассматривается только при создании. |
| os | Операционная система. Обязательно, если сервер ещё не существует. | |
| plan | План для сервера. Обязательно, если сервер ещё не существует. | |
| private_network_enabled |
| Включить или выключить частную сеть. |
| region | Регион развертывания сервера. Обязательно, если сервер ещё не существует. | |
| reserved_ip_v4 | IP-адрес плавающего IP-адреса, используемого в качестве основного IP-адреса этого сервера. Рассматривается только при создании. | |
| ssh_keys | Список SSH-ключей, передаваемых серверу при создании. алиасы: ssh_key | |
| startup_script | Имя скрипта запуска, который выполняется при загрузке. Рассматривается только при создании сервера. | |
| state |
| Состояние сервера. |
| tag | Тег для сервера. | |
| user_data | Данные пользователя, которые нужно передать серверу. | |
| validate_certs |
| Проверять 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 сложный тип данных | успех | Ответ от Vultr API с некоторыми добавленными/изменёнными элементами | |
| api_endpoint строка | успех | Точка входа, используемая для запросов API Пример: https://api.vultr.com | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | успех | Максимальное количество попыток повторных запросов API Пример: 5 | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| vultr_server сложный тип данных | успех | Ответ от Vultr API с некоторыми добавленными/изменёнными элементами | |
| status строка | успех | Статус развертывания сервера Пример: active | |
| v6_network_size строка | успех | Размер сети IPv6 | |
| server_state строка | успех | Состояние сервера Пример: ok | |
| ram строка | успех | Информация о размере оперативной памяти Пример: 1024 МБ | |
| tag строка | успех | Должно быть уточнено | |
| allowed_bandwidth_gb целое число | успех | Разрешённая пропускная способность в ГБ Пример: 1000 | |
| default_password строка | успех | Пароль для входа в качестве root на сервер Пример: !p3EWYJm$qDWYaFr | |
| internal_ip строка | успех | Внутренний IP-адрес | |
| auto_backup_enabled логическое значение | успех | Включены ли автоматические резервные копии | |
| pending_charges вещественное число | успех | Ожидаемые платежи Пример: 0.01 | |
| plan строка | успех | Используемый план сервера Пример: 1024 МБ оперативной памяти, 25 ГБ SSD, 1.00 ТБ пропускной способности | |
| v6_network строка | успех | Сеть IPv6 | |
| disk строка | успех | Информация о диске Пример: Виртуальный диск 25 ГБ | |
| v4_netmask строка | успех | Маска сети IPv4 Пример: 255.255.254.0 | |
| id строка | успех | Идентификатор сервера Пример: 10194376 | |
| v6_networks список | успех | Сети IPv6 | |
| vcpu_count целое число | успех | Количество виртуальных процессоров Пример: 1 | |
| name строка | успех | Имя (метка) сервера Пример: ansible-test-vm | |
| kvm_url строка | успех | URL до VNC Пример: https://my.vultr.com/subs/vps/novnc/api.php?data=xyz | |
| os строка | успех | Используемая операционная система сервера Пример: CentOS 6 x64 | |
| v6_main_ip строка | успех | Основной IPv6 | |
| v4_gateway строка | успех | Шлюз IPv4 Пример: 45.32.232.1 | |
| firewall_group строка | успех и доступно | Группа правил брандмауэра, к которой назначен сервер Пример: CentOS 6 x64 | |
| current_bandwidth_gb целое число | успех | Текущая пропускная способность сервера в ГБ | |
| power_status строка | успех | Статус питания сервера Пример: running | |
| date_created строка | успех | Дата создания сервера Пример: 2017-08-26 12:47:48 | |
| v4_main_ip строка | успех | Основной IPv4 Пример: 45.32.233.154 | |
| region строка | успех | Регион развертывания сервера Пример: Амстердам | |
| cost_per_month вещественное число | успех | Стоимость в месяц за сервер Пример: 5.0 | |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Автор
- 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.5/modules/vr_server_module.html
