Модуль community.digitalocean.digital_ocean_floating_ip – Управление плавающими IP-адресами DigitalOcean

Примечание

Этот модуль является частью коллекции community.digitalocean (версия 1.27.0).

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

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

Чтобы использовать его в плейбуке, укажите: community.digitalocean.digital_ocean_floating_ip.

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

Обзор

Создание/удаление/назначение плавающего IP-адреса.

Требования

Ниже приведены требования, необходимые на хосте, выполняющем этот модуль.

python >= 2.6

Параметры

Параметр	Комментарии
droplet_id строка	Виртуальная машина (Droplet), к которой назначен плавающий IP-адрес.
ip алиасы: id строка	Общедоступный IP-адрес плавающего IP-адреса. Используется для удаления IP-адреса.
oauth_token строка / обязательный	Токен DigitalOcean OAuth.
project_name алиасы: project строка	Проект, которому нужно назначить ресурс (название проекта, а не UUID). По умолчанию используется по умолчанию проект учетной записи (пустая строка). В настоящее время поддерживается только при создании. По умолчанию: `""`
region строка	Регион, в котором зарезервирован плавающий IP-адрес.
state строка	Указывает желаемое состояние целевого объекта. Если `state=present` Создание (и, необязательно, прикрепление) плавающего IP-адреса Если `state=absent` Удаление плавающего IP-адреса Если `state=attached` Прикрепление плавающего IP-адреса к виртуальной машине Если `state=detached` Отсоединение плавающего IP-адреса от виртуальной машины Варианты: `"present"` ← (по умолчанию) `"absent"` `"attached"` `"detached"`
timeout целое число	Таймаут создания плавающего IP-адреса. По умолчанию: `30`
validate_certs логический	Если установлено `no`, сертификаты SSL не будут проверены. Это следует установить только на сайтах под собственным контролем, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используется версия 2 API DigitalOcean.

Примеры

- name: "Create a Floating IP in region lon1"
  community.digitalocean.digital_ocean_floating_ip:
    state: present
    region: lon1

- name: Create a Floating IP in region lon1 (and assign to Project "test")
  community.digitalocean.digital_ocean_floating_ip:
    state: present
    region: lon1
    project: test

- name: "Create a Floating IP assigned to Droplet ID 123456"
  community.digitalocean.digital_ocean_floating_ip:
    state: present
    droplet_id: 123456

- name: "Attach an existing Floating IP of 1.2.3.4 to Droplet ID 123456"
  community.digitalocean.digital_ocean_floating_ip:
    state: attached
    ip: "1.2.3.4"
    droplet_id: 123456

- name: "Detach an existing Floating IP of 1.2.3.4 from its Droplet"
  community.digitalocean.digital_ocean_floating_ip:
    state: detached
    ip: "1.2.3.4"

- name: "Delete a Floating IP with ip 1.2.3.4"
  community.digitalocean.digital_ocean_floating_ip:
    state: absent
    ip: "1.2.3.4"

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

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

Ключ	Описание
assign_status строка	Статус назначения (ok, not_found, assigned, already_assigned, service_down) Возвращается: changed Пример: `"assigned"`
data словарь	ресурс DigitalOcean Floating IP Возвращается: успех и отсутствие ограничений по ресурсам Пример: `{"action": {"completed_at": null, "id": 68212728, "region": {"available": true, "features": ["private_networking", "backups", "ipv6", "metadata"], "name": "New York 3", "sizes": ["512mb,", "1gb,", "2gb,", "4gb,", "8gb,", "16gb,", "32gb,", "48gb,", "64gb"], "slug": "nyc3"}, "region_slug": "nyc3", "resource_id": 758603823, "resource_type": "floating_ip", "started_at": "2015-10-15T17:45:44Z", "status": "in-progress", "type": "assign_ip"}}`
msg строка	Информационное или сообщение об ошибке, возникшее во время выполнения Возвращается: changed Пример: `"No project named test2 found"`
resources словарь	Ресурс назначения, участвующий в назначении проекта Возвращается: changed Пример: `{"assigned_at": "2021-10-25T17:39:38Z", "links": {"self": "https://api.digitalocean.com/v2/floating_ips/157.230.64.107"}, "status": "assigned", "urn": "do:floatingip:157.230.64.107"}`

Авторы

Patrick Marques (@pmarques)
Daniel George (@danxg87)

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

© 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/community/digitalocean/digital_ocean_floating_ip_module.html