cloudscale_ch.cloud.objects_user – Управляет пользователями объектов на услуге cloudscale.ch IaaS
Примечание
Этот плагин входит в коллекцию cloudscale_ch.cloud (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install cloudscale_ch.cloud.
Для использования в плейбуке укажите: cloudscale_ch.cloud.objects_user.
Новое в версии 1.1.0: of cloudscale_ch.cloud
Обзор
- Создание, обновление и удаление пользователей объектов службы cloudscale.ch IaaS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Значение по умолчанию: 30 | Время ожидания в секундах для вызовов API cloudscale.ch. |
| api_token строка / обязательно | Токен API cloudscale.ch. Также можно передать через переменную среды CLOUDSCALE_API_TOKEN. | |
| api_url строка добавлен в 1.3.0 cloudscale_ch.cloud | Значение по умолчанию: "https://api.cloudscale.ch/v1" | URL API cloudscale.ch. Также можно передать через переменную среды CLOUDSCALE_API_URL. |
| display_name строка | Имя отображения пользователя объекта. Требуется либо display_name, либо id. псевдонимы: name | |
| id строка | Имя пользователя объекта. Требуется либо display_name, либо id. | |
| state строка |
| Состояние пользователя объекта. |
| 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 строка | success | Имя отображения пользователя объекта. Пример: alan | |
| href строка | success когда state == present | URL API для получения подробностей об этом ресурсе. Пример: https://api.cloudscale.ch/v1/objects-users/6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15 | |
| id строка | success | Идентификатор пользователя объекта. Пример: 6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15 | |
| keys сложный | success | Список объектов ключей. | |
| access_key строка | success | Ключ доступа. Пример: 0ZTAIBKSGYBRHQ09G11W | |
| secret_key строка | success | Секретный ключ. Пример: bn2ufcwbIa0ARLc5CLRSlVaCfFxPHOpHmjKiH34T | |
| state строка | success | Текущий статус пользователя объекта. Пример: present | |
| tags словарь | success | Теги, связанные с пользователем объекта. Пример: {'project': 'my project'} | |
Авторы
- Rene Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cloudscale_ch/cloud/objects_user_module.html