Модуль hetzner.hcloud.primary_ip — создание основных IP-адресов в облаке Hetzner Cloud и управление ими.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.primary_ip.

Добавлено в hetzner.hcloud 1.8.0

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

Краткое описание

Создание основных IP-адресов в облаке Hetzner Cloud и управление ими.
Чтобы управлять DNS-указателем основного IP-адреса, используйте модуль hetzner.hcloud.rdns.

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	Конечная точка API Hetzner Cloud. Этот параметр также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Конечная точка API Hetzner. Этот параметр также можно задать с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен API Hetzner Cloud. Этот параметр также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
auto_delete логический	Удалять основной IP-адрес при удалении ресурса, которому он назначен. Варианты: `false` ← (по умолчанию) `true`
datacenter строка	Устарело: Аргумент `datacenter` устарел и будет удалён после 1 июля 2026 года. Вместо него используйте аргумент `location`. См. https://docs.hetzner.cloud/changelog#2025-12-16-phasing-out-datacenters. Домашнее местоположение основного IP-адреса Hetzner Cloud. Обязателен, если не указан `server` или `location` и основной IP-адрес не существует.
delete_protection логический	Защитить основной IP-адрес от удаления. Варианты: `false` `true`
id целое число	ID основных IP-адресов Hetzner Cloud, которыми нужно управлять. Обязателен, только если не указан `name` основного IP-адреса.
labels словарь	Метки, заданные пользователем (пары ключ-значение).
location строка	ID или название местоположения, к которому будет привязан основной IP-адрес Hetzner Cloud. Обязателен, если не указан `server` или `datacenter` и основной IP-адрес не существует.
name строка	Имя основных IP-адресов Hetzner Cloud, которыми нужно управлять. Обязательно, только если не указано `id` основного IP-адреса или основной IP-адрес не существует.
server строка	Имя или ID сервера Hetzner Cloud, которому следует назначить основной IP-адрес. Нельзя назначить основной IP-адрес работающему серверу. Обязателен, если не указан `datacenter` и основной IP-адрес не существует. Используйте `null`, чтобы отменить назначение основного IP-адреса серверу.
state строка	Состояние основного IP-адреса. Варианты: `"absent"` `"present"` ← (по умолчанию)
type строка	Тип основного IP-адреса. Обязателен, если основной IP-адрес не существует Варианты: `"ipv4"` `"ipv6"`

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Create a IPv4 Primary IP
  hetzner.hcloud.primary_ip:
    name: my-primary-ip
    location: fsn1
    type: ipv4
    state: present

- name: Create a IPv6 Primary IP
  hetzner.hcloud.primary_ip:
    name: my-primary-ip
    location: fsn1
    type: ipv6
    state: present

- name: Delete a Primary IP
  hetzner.hcloud.primary_ip:
    name: my-primary-ip
    state: absent

- name: Ensure the server is stopped
  hetzner.hcloud.server:
    name: my-server
    state: stopped
- name: Create a Primary IP attached to a Server
  hetzner.hcloud.primary_ip:
    name: my-primary-ip
    server: my-server
    type: ipv4
    state: present
- name: Ensure the server is started
  hetzner.hcloud.server:
    name: my-server
    state: started

- name: Unassign a Primary IP from a Server
  hetzner.hcloud.primary_ip:
    name: my-primary-ip
    type: ipv4
    server: null
    state: present

Возвращаемые значения

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

Ключ	Описание
hcloud_primary_ip словарь	Экземпляр основного IP-адреса Возвращается: всегда
assignee_id целое число	ID ресурса, которому назначен основной IP-адрес; значение отсутствует, если адрес никому не назначен. Возвращается: всегда Пример: `19584637`
assignee_type строка	Тип ресурса, которому назначен основной IP-адрес. Возвращается: всегда Пример: `"server"`
auto_delete логический	Удалять основной IP-адрес при удалении ресурса, которому он назначен. Возвращается: всегда Пример: `false`
datacenter строка	Название центра обработки данных, в котором находится основной IP-адрес. Устарело: Значение `hcloud_primary_ip.datacenter` устарело и будет удалено после 1 июля 2026 года. Вместо него используйте значение `hcloud_primary_ip.location`. См. https://docs.hetzner.cloud/changelog#2025-12-16-phasing-out-datacenters. Возвращается: всегда Пример: `"fsn1-dc14"`
delete_protection логический	Значение true, если основной IP-адрес защищён от удаления Возвращается: всегда Пример: `false`
id целое число	ID основного IP-адреса Возвращается: всегда Пример: `12345`
ip строка	IP-адрес основного IP-адреса Возвращается: всегда Пример: `"116.203.104.109"`
labels словарь	Метки, заданные пользователем (пары ключ-значение) Возвращается: всегда Пример: `{"key": "value", "mylabel": 123}`
location строка	Название местоположения основного IP-адреса Возвращается: всегда Пример: `"fsn1"`
name строка	Имя основного IP-адреса Возвращается: всегда Пример: `"my-primary-ip"`
type строка	Тип основного IP-адреса Возвращается: всегда Пример: `"ipv4"`

Авторы

Lukas Kaemmerling (@lkaemmerling)

Ссылки на коллекцию

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