hetzner.hcloud.hcloud_server – Создание и управление виртуальными серверами на Hetzner Cloud.
Примечание
Этот плагин является частью коллекции hetzner.hcloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install hetzner.hcloud.
Для использования в книге задач укажите: hetzner.hcloud.hcloud_server.
Обзор
- Создание, обновление и управление виртуальными серверами на Hetzner Cloud.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- hcloud-python >= 1.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_token строка / обязательно | Токен API для Hetzner Cloud. | |
| backups логическое значение |
| Включить или отключить резервное копирование для данного сервера. |
| datacenter строка | ЦОД сервера. Требуется, если не указано значение location и сервер не существует. | |
| delete_protection логическое значение |
| Защитить сервер от удаления. Должно совпадать с rebuild_protection. |
| endpoint строка | Значение по умолчанию: "https://api.hetzner.cloud/v1" | Конечная точка API для Hetzner Cloud. |
| force_upgrade логическое значение |
| Принудительно выполнить обновление сервера. Выключить сервер, если он работает во время обновления. |
| id целое число | Идентификатор сервера Hetzner Cloud для управления. Требуется только если не указано значение name сервера. | |
| image строка | Изображение, с которого должен быть создан сервер. Требуется, если сервер не существует. | |
| labels словарь | Пользовательские метки (пары ключ-значение). | |
| location строка | Расположение сервера. Требуется, если не указано значение datacenter и сервер не существует. | |
| name строка | Имя сервера Hetzner Cloud для управления. Требуется только если не указан идентификатор сервера id или сервер не существует. | |
| rebuild_protection логическое значение |
| Защитить сервер от перестройки. Должно совпадать с delete_protection. |
| rescue_mode строка | Тип системы восстановления Hetzner, в который должен загружаться сервер. | |
| server_type строка | Тип сервера Hetzner Cloud для управления. Требуется, если сервер не существует. | |
| ssh_keys список / элементы=строка | Список имен SSH-ключей. Имена ключей соответствуют SSH-ключам, настроенным для доступа к вашей учетной записи Hetzner Cloud. | |
| state строка |
| Состояние сервера. |
| upgrade_disk логическое значение |
| Изменить размер диска при изменении размера сервера. Если вы хотите в дальнейшем понизить версию сервера, это значение должно быть False. |
| user_data строка | Данные пользователя, которые необходимо передать серверу при создании. Используется только если сервер не существует. | |
| volumes список / элементы=строка | Список идентификаторов томов, которые необходимо прикрепить к серверу при создании. |
См. также
См. также
- Документация API Hetzner Cloud
-
Полное руководство по API Hetzner Cloud.
Примеры
- name: Create a basic server
hcloud_server:
name: my-server
server_type: cx11
image: ubuntu-18.04
state: present
- name: Create a basic server with ssh key
hcloud_server:
name: my-server
server_type: cx11
image: ubuntu-18.04
location: fsn1
ssh_keys:
- me@myorganisation
state: present
- name: Resize an existing server
hcloud_server:
name: my-server
server_type: cx21
upgrade_disk: yes
state: present
- name: Ensure the server is absent (remove if needed)
hcloud_server:
name: my-server
state: absent
- name: Ensure the server is started
hcloud_server:
name: my-server
state: started
- name: Ensure the server is stopped
hcloud_server:
name: my-server
state: stopped
- name: Ensure the server is restarted
hcloud_server:
name: my-server
state: restarted
- name: Ensure the server is will be booted in rescue mode and therefore restarted
hcloud_server:
name: my-server
rescue_mode: linux64
state: restarted
- name: Ensure the server is rebuild
hcloud_server:
name: my-server
image: ubuntu-18.04
state: rebuild
Возвращаемые значения
Общие возвращаемые значения описаны в данном разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| hcloud_server сложное | Всегда | Экземпляр сервера | |
| backup_window логическое значение | всегда | Временной интервал (UTC), в течение которого будет выполнено резервное копирование, или null, если резервное копирование отключено. Пример: 22-02 | |
| datacenter строка | всегда | Имя ЦОД сервера. Пример: fsn1-dc14 | |
| delete_protection логическое значение добавлен в 0.1.0 hetzner.hcloud | всегда | True, если сервер защищен от удаления | |
| id целое число | всегда | Числовой идентификатор сервера Пример: 1937415 | |
| ipv4_address строка | всегда | Публичный IPv4-адрес сервера. Пример: 116.203.104.109 | |
| ipv6 строка | всегда | IPv6-сеть сервера. Пример: 2a01:4f8:1c1c:c140::/64 | |
| labels словарь | всегда | Пользовательские метки (пары ключ-значение) | |
| location строка | всегда | Название местоположения сервера Пример: fsn1 | |
| name строка | всегда | Имя сервера Пример: my-server | |
| rebuild_protection логическое значение добавлен в 0.1.0 hetzner.hcloud | всегда | True, если сервер защищен от перестройки. | |
| rescue_enabled логическое значение | всегда | True, если режим восстановления включен. Сервер затем загрузится в систему восстановления при следующем перезапуске. | |
| server_type строка | всегда | Название типа сервера Пример: cx11 | |
| status строка | всегда | Статус сервера Пример: running | |
Авторы
- Lukas Kaemmerling (@LKaemmerling)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/hetzner/hcloud/hcloud_server_module.html