Модуль community.general.scaleway_ip_info – Сбор информации о доступных IP-адресах Scaleway

Примечание

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

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

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

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

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

Обзор

Сбор информации о доступных IP-адресах Scaleway.

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	В режиме сравнения вернет информацию о том, что изменилось (или, возможно, нужно изменить в `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: Gather Scaleway ips information
  community.general.scaleway_ip_info:
    region: par1
  register: result

- ansible.builtin.debug:
    msg: "{{ result.scaleway_ip_info }}"

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

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

Ключ	Описание
scaleway_ip_info список / элементы=словарь	Ответ от API Scaleway. Для более подробной информации см.: https://developers.scaleway.com/en/products/instance/api/. Возвращается: success Пример: `{"scaleway_ip_info": [{"address": "163.172.170.243", "id": "ea081794-a581-8899-8451-386ddaf0a451", "organization": "3f709602-5e6c-4619-b80c-e324324324af", "reverse": null, "server": {"id": "12f19bc7-109c-4517-954c-e6b3d0311363", "name": "scw-e0d158"}}]}`

Ключ

Описание

scaleway_ip_info

список / элементы=словарь

Ответ от API Scaleway.

Для более подробной информации см.: https://developers.scaleway.com/en/products/instance/api/.

Возвращается: success

Пример: {"scaleway_ip_info": [{"address": "163.172.170.243", "id": "ea081794-a581-8899-8451-386ddaf0a451", "organization": "3f709602-5e6c-4619-b80c-e324324324af", "reverse": null, "server": {"id": "12f19bc7-109c-4517-954c-e6b3d0311363", "name": "scw-e0d158"}}]}

Авторы

Yanis Guenane (@Spredzy)
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_info_module.html