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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.scaleway_ip_info.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

PyYAML (если используется profile)

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout integer	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token string	Токен OAuth Scaleway. Обязательный параметр, если не указан `profile`.
api_url псевдонимы: base_url string	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации из файла конфигурации, из которого нужно загрузить токен OAuth Scaleway; используйте вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
query_parameters dictionary	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region string / обязательный	Регион Scaleway для использования (например, `par1`). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
validate_certs boolean	Проверять сертификаты SSL API Scaleway. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
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: Gather Scaleway IPs information
  community.general.scaleway_ip_info:
    region: par1
  register: result

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

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

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

Ключ	Описание
scaleway_ip_info list / elements=dictionary	Ответ API Scaleway. Дополнительные сведения см. на странице https://developers.scaleway.com/en/products/instance/api/. Возвращается: при успешном выполнении Пример: `[{"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

list / elements=dictionary

Ответ API Scaleway.

Дополнительные сведения см. на странице https://developers.scaleway.com/en/products/instance/api/.

Возвращается: при успешном выполнении

Пример: [{"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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_ip_info_module.html