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

Примечание

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

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

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

Для использования в playbook, укажите: hetzner.hcloud.floating_ip.

Новое в hetzner.hcloud 0.1.0

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

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

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

Псевдонимы: hcloud_floating_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`.
delete_protection логическое	Защитить плавающий IP от удаления. Варианты: `false` `true`
description строка	Описание плавающих IP-адресов Hetzner Cloud.
force логическое	Принудительно назначить или удалить плавающий IP-адрес. Варианты: `false` `true`
home_location строка	Местоположение плавающего IP-адреса Hetzner Cloud. Обязательно, если не указан сервер и плавающий IP-адрес не существует.
id целое число	ID плавающих IP-адресов Hetzner Cloud для управления. Требуется только, если не указано имя плавающего IP-адреса name.
labels словарь	Метки, определяемые пользователем (пары ключ-значение).
name строка	Имя плавающих IP-адресов Hetzner Cloud для управления. Требуется только, если не указан ID плавающего IP-адреса id или плавающий IP-адрес не существует.
server строка	Имя сервера, которому должен быть назначен плавающий IP-адрес. Обязательно, если не указано home_location и плавающий IP-адрес не существует.
state строка	Состояние плавающего IP-адреса. Варианты: `"absent"` `"present"` ← (по умолчанию)
type строка	Тип плавающего IP-адреса. Обязательно, если плавающий IP-адрес не существует Варианты: `"ipv4"` `"ipv6"`

См. также

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

Примеры

- name: Create a basic IPv4 Floating IP
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    home_location: fsn1
    type: ipv4
    state: present
- name: Create a basic IPv6 Floating IP
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    home_location: fsn1
    type: ipv6
    state: present
- name: Assign a Floating IP to a server
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    server: 1234
    state: present
- name: Assign a Floating IP to another server
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    server: 1234
    force: true
    state: present
- name: Floating IP should be absent
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    state: absent

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

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

Ключ	Описание
hcloud_floating_ip сложное	Экземпляр плавающего IP-адреса Возвращается: Всегда
delete_protection логическое добавлено в hetzner.hcloud 0.1.0	Истинно, если плавающий IP-адрес защищён от удаления Возвращается: всегда Пример: `false`
description строка	Описание плавающего IP-адреса Возвращается: Всегда Пример: `"my-floating-ip"`
home_location строка	Имя расположения плавающего IP-адреса Возвращается: Всегда Пример: `"fsn1"`
id целое число	Идентификатор плавающего IP-адреса Возвращается: Всегда Пример: `12345`
ip строка	IP-адрес плавающего IP-адреса Возвращается: Всегда Пример: `"116.203.104.109"`
labels словарь	Пользовательские метки (пары ключ-значение) Возвращается: Всегда Пример: `{"key": "value", "mylabel": 123}`
name строка	Имя плавающего IP-адреса Возвращается: Всегда Пример: `"my-floating-ip"`
server строка	Имя сервера, к которому прикреплён плавающий IP-адрес. Возвращается: Всегда Пример: `"my-server"`
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/floating_ip_module.html