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

Примечание

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

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

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

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

Новое в cloudscale_ch.cloud 1.0.0

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

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

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

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

Параметры

Параметр	Комментарии
api_timeout integer	Тайм-аут в секундах для вызовов API cloudscale.ch. Это значение также может быть передано в переменной окружения `CLOUDSCALE_API_TIMEOUT`. Значение по умолчанию: `45`
api_token string / required	Токен 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-адреса для идемпотентности. Один из параметров network или name необходим для идентификации плавающего IP-адреса. Требуется для назначения нового плавающего IP-адреса.
network псевдонимы: ip string	Плавающий IP-адрес для изменения. Один из параметров network или name необходим для идентификации плавающего IP-адреса.
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 версии 1.
Для получения подробной информации обратитесь к полной документации по 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 строка	URL API для получения подробностей об этом плавающем IP-адресе. Возвращается: успех, когда состояние == присутствует Пример: `"https://api.cloudscale.ch/v1/floating-ips/2001:db8::cafe"`
ip строка	Адрес плавающего IP-адреса. Возвращается: успех, когда состояние == присутствует Пример: `"185.98.122.176"`
name строка добавлено в cloudscale_ch.cloud 1.3.0	Имя плавающего IP-адреса. Возвращается: успех Пример: `"my floating ip"`
network строка	Нотация CIDR сети, которая маршрутизируется на ваш сервер. Возвращается: успех Пример: `"2001:db8::cafe/128"`
next_hop строка	Ваш плавающий IP-адрес маршрутизируется на этот IP-адрес. Возвращается: успех, когда состояние == присутствует Пример: `"2001:db8:dead:beef::42"`
region словарь	Регион плавающего IP-адреса. Возвращается: успех, когда состояние == присутствует Пример: `{"slug": "lpg"}`
reverse_ptr строка	Обратный указатель для этого плавающего IP-адреса. Возвращается: успех, когда состояние == присутствует Пример: `"185-98-122-176.cust.cloudscale.ch"`
server строка	Плавающий IP-адрес маршрутизируется на этот сервер. Возвращается: успех, когда состояние == присутствует Пример: `"47cec963-fcd2-482f-bdb6-24461b2d47b1"`
state строка	Текущее состояние плавающего IP-адреса. Возвращается: успех Пример: `"present"`
tags словарь добавлено в 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cloudscale_ch/cloud/floating_ip_module.html