Spec-Zone.ru › Ansible

Модуль community.general.scaleway_user_data — модуль управления user_data в Scaleway

Примечание

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

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

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

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

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

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

  • Этот модуль управляет user_data на вычислительных экземплярах Scaleway.
  • Его можно использовать для настройки cloud-init для экземпляра.

Требования

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

  • 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"

server_id

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

ID вычислительного экземпляра Scaleway для сервера.

user_data

словарь

Данные, определяемые пользователем. Обычно используются с cloud-init.

Передайте сюда свой сценарий cloud-init в виде строки.

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: Update the cloud-init
  community.general.scaleway_user_data:
    server_id: '5a33b4ab-57dd-4eb6-8b0a-d95eb63492ce'
    region: ams1
    user_data:
      cloud-init: 'final_message: "Hello World!"'

Авторы

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

Spec-Zone.ru

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