Модуль community.general.scaleway_server_info — сбор информации о доступных серверах Scaleway
Примечание
Этот модуль входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.general.scaleway_server_info.
Краткое описание
- Сбор информации о доступных серверах Scaleway.
Требования
Следующие требования должны быть выполнены на узле, где выполняется этот модуль.
- PyYAML (если используется
profile)
Параметры
Параметр | Комментарии |
|---|---|
api_timeout псевдонимы: timeout целое число | Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: |
api_token псевдонимы: oauth_token строка | Токен OAuth Scaleway. Этот параметр обязателен, если не указан |
api_url псевдонимы: base_url строка | URL API Scaleway. По умолчанию: |
profile псевдонимы: scw_profile строка добавлено в community.general 12.2.0 | Профиль конфигурации в файле настроек, из которого следует загрузить токен OAuth Scaleway; используется вместо Также можно задать |
query_parameters словарь | Список параметров, передаваемых в строке запроса. По умолчанию: |
region строка / обязательный параметр | Используемый регион Scaleway (например, Варианты:
|
validate_certs логическое значение | Проверять SSL-сертификаты API Scaleway. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.general.scaleway добавлено в community.general 11.3.0 | Используйте |
check_mode | Поддержка: полная Это действие не изменяет состояние. | Может выполняться в |
diff_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 servers information
community.general.scaleway_server_info:
region: par1
register: result
- ansible.builtin.debug:
msg: "{{ result.scaleway_server_info }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
scaleway_server_info список / элементы=словарь | Ответ API Scaleway. Подробную информацию см. в документации: https://developers.scaleway.com/en/products/instance/api/. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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_server_info_module.html