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_retry_max_delay целое число добавлено в 2.9 | Задержка экспоненциального возврата при повторных попытках в секундах, до максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP запроса к Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 60 секунд, если не указано. | |
| auto_backup_enabled логическое |
| Включить или выключить автоматические резервные копии. |
| firewall_group строка | Описание или идентификатор группы брандмауэра для назначения этому серверу. | |
| force логическое |
| Принудительно остановить/запустить сервер, если необходимо применить изменения. В противном случае работающий сервер не будет изменён. |
| hostname строка | Имя хоста для назначения этому серверу. | |
| ipv6_enabled логическое |
| Включить или выключить IPv6. |
| name строка / обязательно | Имя сервера. Псевдонимы: метка | |
| notify_activate логическое |
| Отправлять ли письмо об активации, когда сервер готов? Учитывается только при создании. |
| os строка | Имя или ID операционной системы. Обязательно, если сервер ещё не существует и не восстанавливается со снимка. | |
| plan строка | Имя или ID плана для сервера. Обязательно, если сервер ещё не существует. | |
| private_network_enabled логическое |
| Включить или выключить частную сеть. |
| region строка | Имя или ID региона, в котором развернут сервер. Обязательно, если сервер ещё не существует. | |
| reserved_ip_v4 строка | IP-адрес плавающего IP-адреса для использования в качестве основного IP-адреса этого сервера. Учитывается только при создании. | |
| snapshot строка добавлено в 2.8 | Имя или 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
delegate_to: localhost
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
delegate_to: localhost
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
delegate_to: localhost
vultr_server:
name: "{{ vultr_server_name }}"
os: "167"
plan: "201"
region: "7"
state: stopped
- name: ensure an existing server is stopped
delegate_to: localhost
vultr_server:
name: "{{ vultr_server_name }}"
state: stopped
- name: ensure an existing server is started
delegate_to: localhost
vultr_server:
name: "{{ vultr_server_name }}"
state: started
- name: ensure a server is absent
delegate_to: localhost
vultr_server:
name: "{{ vultr_server_name }}"
state: absent
Возвращаемые значения
Общие значения возвращаемых данных описаны в разделе здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api complex | success | Ответ от API Vultr с некоторыми дополнениями/изменениями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | success | Эндпоинт, используемый для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | success | Максимальное количество попыток переподключения к API Пример: 5 | |
| api_retry_max_delay целое число добавлен в 2.9 | success | Задержка экспоненциального возвратного отката в секундах между попытками переподключения до максимального значения задержки. Пример: 12 | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_server complex | success | Ответ от API Vultr с некоторыми дополнениями/изменениями | |
| allowed_bandwidth_gb целое число | success | Разрешенная пропускная способность в ГБ Пример: 1000 | |
| auto_backup_enabled логический | success | Включены ли автоматические резервные копии | |
| cost_per_month число с плавающей точкой | success | Стоимость за месяц для сервера Пример: 5.0 | |
| current_bandwidth_gb целое число | success | Текущая пропускная способность, используемая сервером | |
| date_created строка | success | Дата создания сервера Пример: 2017-08-26 12:47:48 | |
| default_password строка | success | Пароль для входа в систему root на сервере Пример: !p3EWYJm$qDWYaFr | |
| disk строка | success | Информация о диске Пример: Виртуальный диск 25 ГБ | |
| firewall_group строка | success and available | Группа правил брандмауэра, к которой прикреплен сервер Пример: CentOS 6 x64 | |
| id строка | success | ID сервера Пример: 10194376 | |
| internal_ip строка | success | Внутренний IP | |
| kvm_url строка | success | URL для VNC Пример: https://my.vultr.com/subs/vps/novnc/api.php?data=xyz | |
| name строка | success | Имя (метка) сервера Пример: ansible-test-vm | |
| os строка | success | Операционная система сервера Пример: CentOS 6 x64 | |
| pending_charges число с плавающей точкой | success | Неоплаченные платежи Пример: 0.01 | |
| plan строка | success | Используемый план для сервера Пример: 1024 МБ ОЗУ, 25 ГБ SSD, 1,00 ТБ трафика | |
| power_status строка | success | Состояние питания сервера Пример: запущен | |
| ram строка | success | Информация о размере ОЗУ Пример: 1024 МБ | |
| region строка | success | Регион развертывания сервера Пример: Амстердам | |
| server_state строка | success | Состояние сервера Пример: ok | |
| status строка | success | Статус развертывания сервера Пример: активный | |
| tag строка | success | В разработке | |
| v4_gateway строка | success | Шлюз IPv4 Пример: 45.32.232.1 | |
| v4_main_ip строка | success | Основной IPv4 Пример: 45.32.233.154 | |
| v4_netmask строка | success | Маска подсети IPv4 Пример: 255.255.254.0 | |
| v6_main_ip строка | success | Основной IPv6 | |
| v6_network строка | success | Сеть IPv6 | |
| v6_network_size строка | success | Размер сети IPv6 | |
| v6_networks список | success | Сети IPv6 | |
| vcpu_count целое число | success | Количество виртуальных процессоров Пример: 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.9/modules/vultr_server_module.html