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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.

Псевдонимы: 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_token строка / обязательный	API-токен для Hetzner Cloud. Вы также можете установить этот параметр, используя переменную среды `HCLOUD_TOKEN`.
auto_delete логическое значение	Удалить первичный IP-адрес при удалении ресурса, к которому он назначен. Варианты: `false` ← (по умолчанию) `true`
datacenter строка	Местоположение на Hetzner Cloud для первичного IP-адреса. Требуется, если не задан параметр сервер и первичный IP-адрес не существует.
delete_protection логическое значение	Защитить первичный IP-адрес от удаления. Варианты: `false` `true`
id целое число	Идентификатор первичных IP-адресов Hetzner Cloud для управления. Требуется только если не задано имя первичного IP-адреса.
...	...

См. также

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

Примеры

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

- name: Create a IPv6 Primary IP
  hetzner.hcloud.primary_ip:
    name: my-primary-ip
    datacenter: fsn1-dc14
    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

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

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

Ключ	Описание
hcloud_primary_ip complex	Экземпляр основного IP-адреса Возвращается: Всегда
assignee_id целое число	ID ресурса, которому назначен основной IP-адрес; null, если он не назначен. Возвращается: всегда Пример: `1937415`
assignee_type строка	Тип ресурса, которому можно назначить основной IP-адрес. Возвращается: всегда Пример: `"server"`
auto_delete логическое	Удалить основной IP-адрес при удалении ресурса, которому он назначен. Возвращается: всегда Пример: `false`
datacenter строка	Название ЦОД основного IP-адреса Возвращается: Всегда Пример: `"fsn1-dc14"`
delete_protection логическое	True, если основной IP-адрес защищен от удаления Возвращается: всегда Пример: `false`
id целое число	ID основного IP-адреса Возвращается: Всегда Пример: `12345`
ip строка	IP-адрес основного IP-адреса Возвращается: Всегда Пример: `"116.203.104.109"`
labels словарь	Пользовательские метки (пары ключ-значение) Возвращается: Всегда Пример: `{"key": "value", "mylabel": 123}`
name строка	Имя основного IP-адреса Возвращается: Всегда Пример: `"my-primary-ip"`
type строка	Тип основного IP-адреса Возвращается: Всегда Пример: `"ipv4"`

Авторы

Lukas Kaemmerling (@lkaemmerling)

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

© 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/primary_ip_module.html