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

Примечание

Этот плагин входит в коллекцию cloudscale_ch.cloud (версия 1.3.0).

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

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

Введено в версии 1.0.0: из cloudscale_ch.cloud

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

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

Примечания

Примечание

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

Авторы

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

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