Spec-Zone.ru › Ansible

hetzner.hcloud.server модуль – Создание и управление облачными серверами на Hetzner Cloud.

Примечание

Этот модуль является частью коллекции hetzner.hcloud (версия 3.1.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: hetzner.hcloud.server.

  • Обзор
  • Требования
  • Параметры
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Создание, обновление и управление облачными серверами на Hetzner Cloud.

Псевдонимы: hcloud_server

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python-dateutil >= 2.7.5
  • requests >=2.20
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

api_endpoint

aliases: endpoint

string

Конечная точка API для Hetzner Cloud.

Вы также можете установить этот параметр, используя переменную среды HCLOUD_ENDPOINT.

Значение по умолчанию: "https://api.hetzner.cloud/v1"

api_token

string / required

Токен API для Hetzner Cloud.

Вы также можете установить этот параметр, используя переменную среды HCLOUD_TOKEN.

backups

boolean

Включить или отключить резервное копирование для данного сервера.

Варианты:

  • false
  • true

datacenter

string

Центр обработки данных Hetzner Cloud (имя или ID) для создания сервера.

Обязательно, если не указан location и сервер не существует.

Используется только при создании сервера.

delete_protection

boolean

Защитить сервер от удаления.

Должно совпадать с rebuild_protection.

Варианты:

  • false
  • true

enable_ipv4

boolean

Включает публичный IPv4 адрес.

Варианты:

  • false
  • true ← (по умолчанию)

enable_ipv6

boolean

Включает публичный IPv6 адрес.

Варианты:

  • false
  • true ← (по умолчанию)

firewalls

list / elements=string

Список брандмауэров Hetzner Cloud (имя или ID), которые должны быть прикреплены к серверу.

force

aliases: force_upgrade

boolean

Принудительно обновить сервер.

Может выключить сервер, если обновление применено.

Варианты:

  • false ← (по умолчанию)
  • true

id

integer

ID сервера Hetzner Cloud для управления.

Требуется только, если не указан name сервера

image

string

Образ Hetzner Cloud (имя или ID) для создания сервера.

Требуется, если сервер не существует или при state=rebuild.

image_allow_deprecated

aliases: allow_deprecated_image

boolean

Разрешает создание серверов с устаревшими образами.

Варианты:

  • false ← (по умолчанию)
  • true

ipv4

string

Основной IPv4 Hetzner Cloud (имя или ID) для использования.

Если пропущено и enable_ipv4=true, новый основной IPv4 будет автоматически создан.

ipv6

string

Основной IPv6 Hetzner Cloud (имя или ID) для использования.

Если пропущено и enable_ipv6=true, новый основной IPv6 будет автоматически создан.

labels

dictionary

Метки, определяемые пользователем (пары ключ-значение).

location

string

Местоположение Hetzner Cloud (имя или ID) для создания сервера.

Обязательно, если не указан datacenter и сервер не существует.

Используется только при создании сервера.

name

string

Имя сервера Hetzner Cloud для управления.

Требуется только, если не указан id сервера или сервер не существует.

placement_group

string

Группа размещения Hetzner Cloud (имя или ID) для создания сервера.

private_networks

list / elements=string

Список сетей Hetzner Cloud (имя или ID), к которым должен быть подключен сервер.

Если None, частные сети остаются такими, какие есть (например, если ранее были добавлены с помощью hcloud_server_network), если у него есть какое-либо другое значение (включая []), к серверу подключаются только эти сети.

rebuild_protection

boolean

Защитить сервер от пересборки.

Должно совпадать с delete_protection.

Варианты:

  • false
  • true

rescue_mode

string

Добавьте тип системы восстановления Hetzner, в которую должен быть загружен сервер.

server_type

string

Тип сервера Hetzner Cloud (название или ID) сервера.

Требуется, если сервер не существует.

ssh_keys

list / elements=string

Список ключей SSH Hetzner Cloud (название или ID), с которыми должен быть создан сервер.

Используется только при создании сервера.

state

string

Состояние сервера.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "restarted"
  • "started"
  • "stopped"
  • "rebuild"

upgrade_disk

boolean

Изменить размер диска при изменении размера сервера.

Если позже вы хотите уменьшить сервер, это значение должно быть False.

Варианты:

  • false ← (по умолчанию)
  • true

user_data

string

Данные пользователя, которые необходимо передать серверу при создании.

Используется только при создании сервера.

volumes

list / elements=string

Список томов Hetzner Cloud (название или ID), которые необходимо подключить к серверу.

Используется только при создании сервера.

См. также

См. также

Документация API Hetzner Cloud

Полная справка по API Hetzner Cloud.

Примеры

- name: Create a basic server
  hetzner.hcloud.server:
    name: my-server
    server_type: cx11
    image: ubuntu-22.04
    state: present

- name: Create a basic server with ssh key
  hetzner.hcloud.server:
    name: my-server
    server_type: cx11
    image: ubuntu-22.04
    location: fsn1
    ssh_keys:
      - me@myorganisation
    state: present

- name: Resize an existing server
  hetzner.hcloud.server:
    name: my-server
    server_type: cx21
    upgrade_disk: true
    state: present

- name: Ensure the server is absent (remove if needed)
  hetzner.hcloud.server:
    name: my-server
    state: absent

- name: Ensure the server is started
  hetzner.hcloud.server:
    name: my-server
    state: started

- name: Ensure the server is stopped
  hetzner.hcloud.server:
    name: my-server
    state: stopped

- name: Ensure the server is restarted
  hetzner.hcloud.server:
    name: my-server
    state: restarted

- name: Ensure the server is will be booted in rescue mode and therefore restarted
  hetzner.hcloud.server:
    name: my-server
    rescue_mode: linux64
    state: restarted

- name: Ensure the server is rebuild
  hetzner.hcloud.server:
    name: my-server
    image: ubuntu-22.04
    state: rebuild

- name: Add server to placement group
  hetzner.hcloud.server:
    name: my-server
    placement_group: my-placement-group
    force: true
    state: present

- name: Remove server from placement group
  hetzner.hcloud.server:
    name: my-server
    placement_group:
    state: present

- name: Add server with private network only
  hetzner.hcloud.server:
    name: my-server
    enable_ipv4: false
    enable_ipv6: false
    private_networks:
      - my-network
      - 4711
    state: present

Значения возврата

Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:

Ключ

Описание

hcloud_server

сложный

Экземпляр сервера

Возвращается: Всегда

backup_window

логическое

Временной интервал (UTC), в котором будет выполняться резервное копирование, или null, если резервное копирование не включено

Возвращается: всегда

Пример: "22-02"

created

строка

Время создания сервера (в формате ISO-8601)

Возвращается: всегда

Пример: "2023-11-06T13:36:56+00:00"

datacenter

строка

Название ЦОД сервера

Возвращается: всегда

Пример: "fsn1-dc14"

delete_protection

логическое

добавлен в hetzner.hcloud 0.1.0

Истина, если сервер защищен от удаления

Возвращается: всегда

Пример: false

id

целое число

Числовой идентификатор сервера

Возвращается: всегда

Пример: 1937415

ipv4_address

строка

Публичный IPv4-адрес сервера

Возвращается: всегда

Пример: "116.203.104.109"

ipv6

строка

IPv6 сеть сервера

Возвращается: всегда

Пример: "2a01:4f8:1c1c:c140::/64"

labels

словарь

Пользовательские метки (пары ключ-значение)

Возвращается: всегда

location

строка

Название местоположения сервера

Возвращается: всегда

Пример: "fsn1"

name

строка

Имя сервера

Возвращается: всегда

Пример: "my-server"

placement_group

строка

добавлен в hetzner.hcloud 1.5.0

Группа размещения сервера

Возвращается: всегда

Пример: "4711"

private_networks

список / элементы=строка

Список частных сетей, к которым подключен сервер (имя или идентификатор)

Возвращается: всегда

Пример: ["my-network", "another-network", "4711"]

private_networks_info

список / элементы=словарь

Список частных сетей, к которым подключен сервер (словарь с именем и IP)

Возвращается: всегда

Пример: [{"ip": "192.168.1.1", "name": "my-network"}, {"ip": "10.185.50.40", "name": "another-network"}]

rebuild_protection

логическое

добавлен в hetzner.hcloud 0.1.0

Истина, если сервер защищен от переустановки

Возвращается: всегда

Пример: false

rescue_enabled

логическое

Истина, если режим восстановления включен. Сервер загрузится в систему восстановления при следующем перезапуске

Возвращается: всегда

Пример: false

server_type

строка

Название типа сервера

Возвращается: всегда

Пример: "cx11"
END_OF_DOCUMENT_MARKER

статус

строка

Состояние сервера

Возвращается: всегда

Пример: "running"

Авторы

  • Lukas Kaemmerling (@LKaemmerling)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (источники)
  • Справочник API Hetzner Cloud
  • Журнал изменений API Hetzner Cloud

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/server_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API