community.general.scaleway_ip модуль — Модуль управления IP-адресами Scaleway

Примечание

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

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

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

Для использования в книге задач укажите: community.general.scaleway_ip.

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

Обзор

Этот модуль управляет IP-адресами на аккаунте Scaleway https://developer.scaleway.com

Параметры

Параметр	Комментарии
api_timeout алиасы: timeout целое число	Таймаут HTTP-запросов к API Scaleway в секундах. По умолчанию: `30`
api_token алиасы: oauth_token строка / обязательно	Токен Scaleway OAuth.
api_url алиасы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
id строка	id IP-адреса Scaleway (UUID)
organization строка / обязательно	Идентификатор организации Scaleway
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательно	Регион Scaleway для использования (например, par1). Доступные значения: `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
reverse строка	Обратный IP-адрес
server строка	id сервера, к которому необходимо прикрепить IP-адрес. Для отсоединения IP-адреса не указывайте этот параметр
state строка	Укажите желаемое состояние IP-адреса. Доступные значения: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое	Проверять SSL-сертификаты API Scaleway. Доступные значения: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без модификации целевого объекта.
diff_mode	Поддержка: нет	В режиме diff вернет информацию о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примечания

Примечание

Также ознакомьтесь с документацией API на https://developer.scaleway.com/.
Если api_token не задан в модуле, можно использовать следующие переменные среды в порядке убывания приоритета SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Если необходимо использовать другой api_url, можно также установить переменную среды SCW_API_URL.

Примеры

- name: Create an IP
  community.general.scaleway_ip:
    organization: '{{ scw_org }}'
    state: present
    region: par1
  register: ip_creation_task

- name: Make sure IP deleted
  community.general.scaleway_ip:
    id: '{{ ip_creation_task.scaleway_ip.id }}'
    state: absent
    region: par1

Значения возврата

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

Ключ	Описание
данные словарь	Это присутствует только тогда, когда `state=present`. Возвращаемое значение: когда `state=present` Пример: `{"ips": [{"address": "212.47.232.136", "id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477", "organization": "951df375-e094-4d26-97c1-ba548eeb9c42", "reverse": null, "server": {"id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1", "name": "ansible_tuto-1"}}]}`

Ключ

Описание

данные

словарь

Это присутствует только тогда, когда state=present.

Возвращаемое значение: когда state=present

Пример: {"ips": [{"address": "212.47.232.136", "id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477", "organization": "951df375-e094-4d26-97c1-ba548eeb9c42", "reverse": null, "server": {"id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1", "name": "ansible_tuto-1"}}]}

Авторы

Remy Leone (@remyleone)

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

© 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/general/scaleway_ip_module.html