Модуль cloudscale_ch.cloud.floating_ip — управление плавающими IP-адресами в сервисе cloudscale.ch IaaS

Примечание

Этот модуль входит в коллекцию cloudscale_ch.cloud (версия 2.5.3).

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

Чтобы установить её, используйте: ansible-galaxy collection install cloudscale_ch.cloud.

Чтобы использовать её в плейбуке, укажите: cloudscale_ch.cloud.floating_ip.

Добавлено в cloudscale_ch.cloud 1.0.0

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

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

Создание, назначение и удаление плавающих IP-адресов в сервисе cloudscale.ch IaaS.

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

Параметры

Параметр	Описание
api_timeout integer	Тайм-аут в секундах для вызовов API cloudscale.ch. Также можно передать через переменную окружения `CLOUDSCALE_API_TIMEOUT`. По умолчанию: `45`
api_token string / обязательный	Токен API cloudscale.ch. Также можно передать через переменную окружения `CLOUDSCALE_API_TOKEN`.
api_url string добавлено в cloudscale_ch.cloud 1.3.0	URL API cloudscale.ch. Также можно передать через переменную окружения `CLOUDSCALE_API_URL`. По умолчанию: `"https://api.cloudscale.ch/v1"`
ip_version integer	Версия протокола IP для плавающего IP-адреса. Обязательный параметр при назначении нового плавающего IP-адреса. Варианты: `4` `6`
name string добавлено в cloudscale_ch.cloud 1.3.0	Имя для идентификации плавающего IP-адреса при обеспечении идемпотентности. Для идентификации плавающего IP-адреса требуется указать network или name. Обязательный параметр при назначении нового плавающего IP-адреса.
network псевдонимы: ip string	Изменяемый плавающий IP-адрес. Для идентификации плавающего IP-адреса требуется указать network или name.
prefix_length integer	Допустимо только при значении ip_version 6. Длина префикса сети IPv6. В настоящее время можно запросить только префикс /56. Если параметр prefix_length не указан, создаётся один адрес. Варианты: `56`
region string	Регион, в котором находится плавающий IP-адрес (например, `lpg` или `rma`). Если параметр не указан, используется регион зоны проекта по умолчанию. Этот параметр необходимо опустить, если для type задано значение `global`.
reverse_ptr string	Обратная запись PTR для этого адреса. Нельзя задать обратную запись PTR для плавающих сетей IPv6. Обратные записи PTR разрешены только для отдельных адресов.
server string	UUID сервера, которому назначен этот плавающий IP-адрес.
state string	Состояние плавающего IP-адреса. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags dictionary добавлено в cloudscale_ch.cloud 1.1.0	Теги, связанные с плавающим IP-адресом. Укажите `{}`, чтобы удалить все теги.
type string	Тип плавающего IP-адреса. Варианты: `"regional"` ← (по умолчанию) `"global"`

Примечания

Примечание

После создания floating_ip все параметры, кроме server, reverse_ptr и tags, доступны только для чтения.
Все операции выполняются с помощью публичного API cloudscale.ch v1.
Подробную информацию см. в полной документации API: https://www.cloudscale.ch/en/api/v1.
Для всех операций требуется действительный токен API. Вы можете создать любое количество токенов в панели управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

# Request a new floating IP without assignment to a server
- name: Request a floating IP
  cloudscale_ch.cloud.floating_ip:
    name: IP to my server
    ip_version: 4
    reverse_ptr: my-server.example.com
    api_token: xxxxxx

# Request a new floating IP with assignment
- name: Request a floating IP
  cloudscale_ch.cloud.floating_ip:
    name: web
    ip_version: 4
    server: 47cec963-fcd2-482f-bdb6-24461b2d47b1
    reverse_ptr: my-server.example.com
    api_token: xxxxxx

# Assign an existing floating IP to a different server by its IP address
- name: Move floating IP to backup server
  cloudscale_ch.cloud.floating_ip:
    ip: 192.0.2.123
    server: ea3b39a3-77a8-4d0b-881d-0bb00a1e7f48
    api_token: xxxxxx

# Assign an existing floating IP to a different server by name
- name: Move floating IP to backup server
  cloudscale_ch.cloud.floating_ip:
    name: IP to my server
    server: ea3b39a3-77a8-4d0b-881d-0bb00a1e7f48
    api_token: xxxxxx

# Request a new floating IPv6 network
- name: Request a floating IP
  cloudscale_ch.cloud.floating_ip:
    name: IPv6 to my server
    ip_version: 6
    prefix_length: 56
    server: 47cec963-fcd2-482f-bdb6-24461b2d47b1
    api_token: xxxxxx
    region: lpg1

# Assign an existing floating network to a different server
- name: Move floating IP to backup server
  cloudscale_ch.cloud.floating_ip:
    ip: '{{ floating_ip.ip }}'
    server: ea3b39a3-77a8-4d0b-881d-0bb00a1e7f48
    api_token: xxxxxx

# Remove a floating IP
- name: Release floating IP
  cloudscale_ch.cloud.floating_ip:
    ip: 192.0.2.123
    state: absent
    api_token: xxxxxx

# Remove a floating IP by name
- name: Release floating IP
  cloudscale_ch.cloud.floating_ip:
    name: IP to my server
    state: absent
    api_token: xxxxxx

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

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

Ключ	Описание
href string	URL API для получения сведений об этом плавающем IP-адресе. Возвращается: при успехе, если state == present Пример: `"https://api.cloudscale.ch/v1/floating-ips/2001:db8::cafe"`
ip string	Плавающий IP-адрес. Возвращается: при успехе, если state == present Пример: `"185.98.122.176"`
name string добавлено в cloudscale_ch.cloud 1.3.0	Имя плавающего IP-адреса. Возвращается: при успехе Пример: `"my floating ip"`
network string	Сеть в нотации CIDR, маршрутизируемая на ваш сервер. Возвращается: при успехе Пример: `"2001:db8::cafe/128"`
next_hop string	Плавающий IP-адрес маршрутизируется на этот IP-адрес. Возвращается: при успехе, если state == present Пример: `"2001:db8:dead:beef::42"`
region dictionary	Регион плавающего IP-адреса. Возвращается: при успехе, если state == present Пример: `{"slug": "lpg"}`
reverse_ptr string	Обратная запись указателя для этого плавающего IP-адреса. Возвращается: при успехе, если state == present Пример: `"185-98-122-176.cust.cloudscale.ch"`
server string	Плавающий IP-адрес маршрутизируется на этот сервер. Возвращается: при успехе, если state == present Пример: `"47cec963-fcd2-482f-bdb6-24461b2d47b1"`
state string	Текущий статус плавающего IP-адреса. Возвращается: при успехе Пример: `"present"`
tags dictionary добавлено в cloudscale_ch.cloud 1.1.0	Теги, связанные с плавающим IP-адресом. Возвращается: при успехе Пример: `{"project": "my project"}`

Авторы

Gaudenz Steinlin (@gaudenz)
Denis Krienbühl (@href)
René Moser (@resmo)

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

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