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

Примечание

Этот плагин входит в коллекцию hetzner.hcloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install hetzner.hcloud.

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

Новое в версии 0.1.0: модуля hetzner.hcloud

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

Описание

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

Требования

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

hcloud-python >= 1.0.0
hcloud-python >= 1.6.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_token строка / обязательно		Токен API для Hetzner Cloud.
delete_protection логическое значение	Варианты: нет да	Защита виртуального IP-адреса от удаления.
description строка		Описание виртуального IP-адреса Hetzner Cloud.
endpoint строка	Значение по умолчанию: "https://api.hetzner.cloud/v1"	API-адрес Hetzner Cloud.
force логическое значение	Варианты: нет да	Принудительное назначение или удаление виртуального IP-адреса.
home_location строка		Местоположение виртуального IP-адреса Hetzner Cloud. Необходимо, если не указан параметр server и виртуальный IP-адрес не существует.
id целое число		ID виртуального IP-адреса Hetzner Cloud для управления. Требуется только если не указано имя виртуального IP-адреса.
labels словарь		Пользовательские метки (пары ключ-значение).
name строка		Имя виртуального IP-адреса Hetzner Cloud для управления. Требуется только если не указан параметр id или виртуальный IP-адрес не существует.
server строка		Имя сервера, к которому должен быть назначен виртуальный IP-адрес. Необходимо, если не указано home_location и виртуальный IP-адрес не существует.
state строка	Варианты: absent present ←	Состояние виртуального IP-адреса.
type строка	Варианты: ipv4 ipv6	Тип виртуального IP-адреса. Требуется, если виртуальный IP-адрес не существует.

См. также

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

Примеры

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

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

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

Ключ		Возвращаемое значение	Описание
hcloud_floating_ip сложный тип		Всегда	Экземпляр виртуального IP-адреса
	delete_protection логическое значение Добавлен в версии 0.1.0 hetzner.hcloud	всегда	True, если виртуальный IP-адрес защищен от удаления
	description строка	Всегда	Описание виртуального IP-адреса Пример: my-floating-ip
	home_location строка	Всегда	Название места расположения виртуального IP-адреса Пример: fsn1
	id целое число	Всегда	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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/hetzner/hcloud/hcloud_floating_ip_module.html