ngine_io.vultr.vultr_server – Управляет виртуальными серверами на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr
Для использования в плейбуке укажите: ngine_io.vultr.vultr_server
Новое в версии 0.1.0: модуля ngine_io.vultr
Описание
- Развёртывание, запуск, остановка, обновление, перезапуск, переустановка серверов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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_retry_max_delay целое число | Задержка экспоненциального возврата при повторной попытке в секундах, до этого максимального значения. Переменная окружения VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для Vultr API. Переменная окружения VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 60 секунд, если не указано. | |
| auto_backup_enabled логическое значение |
| Включить автоматические резервные копии или нет. |
| firewall_group строка | Описание или ID группы брандмауэра, которому должен быть назначен этот сервер. | |
| force логическое значение |
| Принудительно остановить/запустить сервер, если требуется применить изменения. В противном случае работающий сервер не будет изменён. |
| hostname строка | Имя хоста, которое нужно назначить этому серверу. | |
| ipv6_enabled логическое значение |
| Включить IPv6 или нет. |
| name строка / обязательно | Имя сервера. псевдонимы: метка | |
| notify_activate логическое значение |
| Отправлять ли электронное письмо об активации, когда сервер готов или нет. Учитывается только при создании. |
| os строка | Имя или ID операционной системы. Требуется, если сервер ещё не существует и не восстанавливается из снимка. | |
| plan строка | Имя или ID плана для использования для сервера. Требуется, если сервер ещё не существует. | |
| private_network_enabled логическое значение |
| Включить частную сеть или нет. |
| region строка | Имя или ID региона, в котором развернут сервер. Требуется, если сервер ещё не существует. | |
| reserved_ip_v4 строка | IP-адрес плавающего IP-адреса для использования в качестве основного IP-адреса этого сервера. Учитывается только при создании. | |
| snapshot строка | Имя или ID снимка для восстановления сервера. | |
| ssh_keys список / элементы=строка | Список имён или идентификаторов SSH-ключей, передаваемых серверу при создании. псевдонимы: ssh_key | |
| startup_script строка | Имя или ID скрипта запуска для выполнения при загрузке. Учитывается только при создании сервера. | |
| state строка |
| Состояние сервера. |
| tag строка | Тег для сервера. | |
| user_data строка | Данные пользователя, которые нужно передать серверу. | |
| validate_certs логическое значение |
| Проверять сертификаты SSL Vultr API. |
Примечания
Примечание
- Также см. документацию API на https://www.vultr.com/api/.
Примеры
- name: create server
ngine_io.vultr.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
ngine_io.vultr.vultr_server:
name: "{{ vultr_server_name }}"
os: CentOS 7 x64
plan: 1024 MB RAM,25 GB SSD,1.00 TB BW
firewall_group: my_group
ssh_key: my_key
region: Amsterdam
state: started
- name: ensure a server is present and stopped provisioned using IDs
ngine_io.vultr.vultr_server:
name: "{{ vultr_server_name }}"
os: "167"
plan: "201"
region: "7"
state: stopped
- name: ensure an existing server is stopped
ngine_io.vultr.vultr_server:
name: "{{ vultr_server_name }}"
state: stopped
- name: ensure an existing server is started
ngine_io.vultr.vultr_server:
name: "{{ vultr_server_name }}"
state: started
- name: ensure a server is absent
ngine_io.vultr.vultr_server:
name: "{{ vultr_server_name }}"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| vultr_api complex | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Эндпоинт, используемый для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Количество максимальных попыток повторных запросов API Пример: 5 | |
| api_retry_max_delay целое число | успех | Экспоненциальная задержка в секундах между повторами запросов до этого максимального значения задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_server complex | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| 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 строка | успех | TBD | |
| 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 | |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_server_module.html
