Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

Обзор

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

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

Требования

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

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

Параметры

Параметр

Комментарии

api_endpoint

псевдонимы: endpoint

string

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

Также можно задать этот параметр с помощью переменной окружения HCLOUD_ENDPOINT.

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

api_endpoint_hetzner

string

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

Также можно задать этот параметр с помощью переменной окружения HETZNER_ENDPOINT.

По умолчанию: "https://api.hetzner.com/v1"

api_token

string / обязательный

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

Также можно задать этот параметр с помощью переменной окружения HCLOUD_TOKEN.

delete_protection

boolean

Защитить плавающий IP-адрес от удаления.

Варианты:

  • false
  • true

description

string

Описание плавающего IP-адреса Hetzner Cloud.

force

boolean

Принудительно назначить плавающий IP-адрес или удалить его.

Варианты:

  • false
  • true

home_location

string

Основное местоположение плавающего IP-адреса Hetzner Cloud.

Обязательный параметр, если не указан server и плавающий IP-адрес не существует.

id

integer

Идентификатор плавающего IP-адреса Hetzner Cloud, которым нужно управлять.

Обязательный параметр, если не указано name плавающего IP-адреса.

labels

dictionary

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

name

string

Имя плавающего IP-адреса Hetzner Cloud, которым нужно управлять.

Обязательный параметр, если не указан id плавающего IP-адреса или плавающий IP-адрес не существует.

server

string

Имя сервера, которому следует назначить плавающий IP-адрес.

Обязательный параметр, если не указано home_location и плавающий IP-адрес не существует.

state

string

Состояние плавающего IP-адреса.

Варианты:

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

type

string

Тип плавающего IP-адреса.

Обязательный параметр, если плавающий IP-адрес не существует.

Варианты:

  • "ipv4"
  • "ipv6"

См. также

См. также

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

Полный справочник по API Hetzner.

Примеры

- 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

dictionary

Экземпляр плавающего IP-адреса

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

delete_protection

boolean

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

True, если плавающий IP-адрес защищён от удаления

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

Пример: false

description

string

Описание плавающего IP-адреса

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

Пример: "my-floating-ip"

home_location

string

Название основного местоположения плавающего IP-адреса

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

Пример: "fsn1"

id

integer

Идентификатор плавающего IP-адреса

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

Пример: 12345

ip

string

IP-адрес плавающего IP-адреса

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

Пример: "116.203.104.109"

labels

dictionary

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

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

Пример: {"key": "value", "mylabel": 123}

name

string

Имя плавающего IP-адреса

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

Пример: "my-floating-ip"

server

string

Имя сервера, которому назначен плавающий IP-адрес.

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

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

type

string

Тип плавающего IP-адреса

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

Пример: "ipv4"

Авторы

  • Lukas Kaemmerling (@lkaemmerling)

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

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

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

Spec-Zone.ru

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