Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр

Комментарии

api_timeout

псевдонимы: timeout

целое число

Тайм-аут HTTP-запроса к API Scaleway в секундах.

По умолчанию: 30

api_token

псевдонимы: oauth_token

строка

Токен OAuth Scaleway.

Обязателен, если не указан profile.

api_url

псевдонимы: base_url

строка

URL API Scaleway.

По умолчанию: "https://api.scaleway.com"

profile

псевдонимы: scw_profile

строка

добавлено в community.general 12.2.0

Профиль конфигурации из файла конфигурации, из которого следует загрузить токен OAuth Scaleway; используется вместо api_token.

Также можно задать SCW_PROFILE, чтобы использовать профиль конфигурации SCW CLI.

query_parameters

словарь

Список параметров, передаваемых в строке запроса.

По умолчанию: {}

region

строка / обязательный

Зона вычислений Scaleway.

Варианты:

  • "ams1"
  • "EMEA-NL-EVS"
  • "ams2"
  • "ams3"
  • "par1"
  • "EMEA-FR-PAR1"
  • "par2"
  • "EMEA-FR-PAR2"
  • "par3"
  • "waw1"
  • "EMEA-PL-WAW1"
  • "waw2"
  • "waw3"

validate_certs

логическое значение

Проверять 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 images information
  community.general.scaleway_image_info:
    region: par1
  register: result

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

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

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

Ключ

Описание

scaleway_image_info

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

Ответ API Scaleway.

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

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

Пример: [{"arch": "x86_64", "creation_date": "2018-07-17T16:18:49.276456+00:00", "default_bootscript": {"architecture": "x86_64", "bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16", "default": false, "dtb": "", "id": "15fbd2f7-a0f9-412b-8502-6a44da8d98b8", "initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz", "kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.9-4.9.93-rev1/vmlinuz-4.9.93", "organization": "11111111-1111-4111-8111-111111111111", "public": true, "title": "x86_64 mainline 4.9.93 rev1"}, "extra_volumes": [], "from_server": null, "id": "00ae4a88-3252-4eda-9feb-5f6b56bf5ef0", "modification_date": "2018-07-17T16:42:06.319315+00:00", "name": "Debian Stretch", "organization": "51b656e3-4865-41e8-adbc-0c45bdd780db", "public": true, "root_volume": {"id": "da32dfbb-c5ff-476d-ae2d-c297dd09b7dd", "name": "snapshot-2a7229dc-d431-4dc5-b66e-95db08b773af-2018-07-17_16:18", "size": 25000000000, "volume_type": "l_ssd"}, "state": "available"}]

Авторы

  • 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_image_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API