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

Примечание

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

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

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

Для использования в плейбуке укажите: community.general.scaleway_organization_info.

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

Обзор

Сбор информации о доступных организациях Scaleway.

Параметры

Параметр	Комментарии
api_timeout алиасы: timeout целое число	Таймаут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token алиасы: oauth_token строка / обязательно	Токен Scaleway OAuth.
api_url алиасы: base_url строка	URL API Scaleway. По умолчанию: `"https://account.scaleway.com"`
query_parameters словарь	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
validate_certs логический тип	Проверка SSL-сертификатов Scaleway API. Варианты: `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 organizations information
  community.general.scaleway_organization_info:
  register: result

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

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

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

Ключ	Описание
scaleway_organization_info список / элементы=словарь	Ответ от API Scaleway. Возвращается: успех Пример: {"scaleway_organization_info": [{"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

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

Ответ от API Scaleway.

Возвращается: успех

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