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

Примечание

Этот плагин является частью коллекции cloudscale_ch.cloud (версия 2.0.0).

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

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

Новый в версии 1.0.0: of cloudscale_ch.cloud

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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-адреса для идемпотентности. Для идентификации плавающего IP-адреса необходимо указать один из параметров network или name. Обязательно для назначения нового плавающего IP-адреса.
network строка		Плавающий IP-адрес для изменения. Для идентификации плавающего IP-адреса необходимо указать один из параметров network или name. псевдонимы: 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 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 строка	успех, когда 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	Обратная запись PTR для этого плавающего 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cloudscale_ch/cloud/floating_ip_module.html