Spec-Zone.ru › Ansible

Модуль cloudscale_ch.cloud.objects_user — Управление пользователями объектов на службе cloudscale.ch IaaS

Примечание

Этот модуль является частью коллекции cloudscale_ch.cloud (версия 2.4.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install cloudscale_ch.cloud.

Для использования в плейбуке укажите: cloudscale_ch.cloud.objects_user.

Новинка в cloudscale_ch.cloud 1.1.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

  • Создание, обновление и удаление пользователей объектов службы cloudscale.ch IaaS.

Параметры

Параметр

Комментарии

api_timeout

целое число

Время ожидания в секундах для вызовов API cloudscale.ch.

Также может быть передано в переменной среды CLOUDSCALE_API_TIMEOUT.

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

api_token

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

Токен API cloudscale.ch.

Также может быть передан в переменной среды CLOUDSCALE_API_TOKEN.

api_url

строка

добавлено в cloudscale_ch.cloud 1.3.0

URL API cloudscale.ch.

Также может быть передан в переменной среды CLOUDSCALE_API_URL.

По умолчанию: "https://api.cloudscale.ch/v1"

display_name

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

строка

Имя отображения пользователя объекта.

Требуется либо display_name, либо id.

id

строка

Имя пользователя объекта.

Требуется либо display_name, либо id.

state

строка

Состояние пользователя объекта.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

словарь

Теги, связанные с пользователем объекта. Установите значение {} для удаления всех тегов.

Примечания

Примечание

  • Все операции выполняются с использованием публичного API v1 cloudscale.ch.
  • Полную документацию API см. по адресу: https://www.cloudscale.ch/en/api/v1.
  • Для всех операций требуется действительный токен API. Вы можете создать любое количество токенов с помощью панели управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

- name: Create an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    tags:
      project: luna
    api_token: xxxxxx
  register: object_user

- name: print keys
  debug:
    var: object_user.keys

- name: Update an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    tags:
      project: gemini
    api_token: xxxxxx

- name: Remove an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    state: absent
    api_token: xxxxxx

Значения возврата

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

Ключ

Описание

display_name

строка

Имя пользователя объекта для отображения.

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

Пример: "alan"

href

строка

URL API для получения подробностей об этом ресурсе.

Возвращается: успешно, когда state == present

Пример: "https://api.cloudscale.ch/v1/objects-users/6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15"

id

строка

Идентификатор пользователя объекта.

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

Пример: "6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15"

keys

сложное

Список объектов ключей.

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

access_key

строка

Ключ доступа.

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

Пример: "0ZTAIBKSGYBRHQ09G11W"

secret_key

строка

Секретный ключ.

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

Пример: "bn2ufcwbIa0ARLc5CLRSlVaCfFxPHOpHmjKiH34T"

state

строка

Текущий статус пользователя объекта.

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

Пример: "present"

tags

словарь

Теги, связанные с пользователем объекта.

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

Пример: {"project": "my project"}

Авторы

  • Rene Moser (@resmo)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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/cloudscale_ch/cloud/objects_user_module.html

Spec-Zone.ru

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