Модуль community.general.scaleway_organization_info — сбор информации о доступных организациях Scaleway

Примечание

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

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

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

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

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

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

Собирает информацию о доступных организациях 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://account.scaleway.com"`
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого нужно загрузить токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
query_parameters dictionary	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
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	Поддержка: full Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз состояния changed, не изменяя целевой объект.
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 organizations information
  community.general.scaleway_organization_info:
  register: result

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

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

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

Ключ	Описание
scaleway_organization_info list / elements=dictionary	Ответ API Scaleway. Возвращается: success Пример: [{"address_city_name": "Paris", "address_country_code": "FR", "address_line1": "42 Rue de l'univers", "address_line2": null, "address_postal_code": "75042", "address_subdivision_code": "FR-75", "creation_date": "2018-08-06T13:43:28.508575+00:00", "currency": "EUR", "customer_class": "individual", "id": "3f709602-5e6c-4619-b80c-e8432ferewtr", "locale": "fr_FR", "modification_date": "2018-08-06T14:56:41.401685+00:00", "name": "James Bond", "support_id": "694324", "support_level": "basic", "support_pin": "9324", "users": [], "vat_number": null, "warnings": []}]

Ключ

Описание

scaleway_organization_info

list / elements=dictionary

Ответ API Scaleway.

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

Пример: [{"address_city_name": "Paris", "address_country_code": "FR", "address_line1": "42 Rue de l'univers", "address_line2": null, "address_postal_code": "75042", "address_subdivision_code": "FR-75", "creation_date": "2018-08-06T13:43:28.508575+00:00", "currency": "EUR", "customer_class": "individual", "id": "3f709602-5e6c-4619-b80c-e8432ferewtr", "locale": "fr_FR", "modification_date": "2018-08-06T14:56:41.401685+00:00", "name": "James Bond", "support_id": "694324", "support_level": "basic", "support_pin": "9324", "users": [], "vat_number": null, "warnings": []}]

Авторы

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_organization_info_module.html