ngine_io.cloudstack.cs_user – Управляет пользователями в облаках на базе Apache CloudStack.
Примечание
Этот плагин является частью коллекции ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Чтобы использовать его в книге задач, укажите: ngine_io.cloudstack.cs_user.
Новое в версии 0.1.0: плагина ngine_io.cloudstack
Описание
- Создание, обновление, отключение, блокировка, включение и удаление пользователей.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Учетная запись, под которой будет создан пользователь. Требуется при state=present. | |
| api_http_method строка |
| Метод HTTP, используемый для запроса к API-точке. Если не указано, рассматривается переменная среды CLOUDSTACK_METHOD. |
| api_key строка / обязательно | API-ключ API CloudStack. Если не указано, рассматривается переменная среды CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ API CloudStack. Если не задано, используется переменная среды CLOUDSTACK_SECRET. | |
| api_timeout целое число | Значение по умолчанию: 10 | Тайм-аут HTTP в секундах. Если не указано, используется переменная среды CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL API CloudStack, например https://cloud.example.com/client/api. Если не указано, используется переменная среды CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверять сертификат авторизации CA. Если не указано, используется переменная среды CLOUDSTACK_VERIFY. | |
| domain строка | Значение по умолчанию: "ROOT" | Домен, к которому относится пользователь. |
| email строка | Электронная почта пользователя. Требуется при state=present. | |
| first_name строка | Имя пользователя. Требуется при state=present. | |
| keys_registered булево |
| Если должны быть сгенерированы API-ключи пользователя. Примечание: ключи больше нельзя удалить с помощью API. |
| last_name строка | Фамилия пользователя. Требуется при state=present. | |
| password строка | Пароль пользователя, который нужно создать. Требуется при state=present. Учитывается только при создании и не будет обновляться, если пользователь существует. | |
| poll_async булево |
| Проверить асинхронные задания до завершения. |
| state строка |
| Состояние пользователя. unlocked — псевдоним для enabled. |
| timezone строка | Временная зона пользователя. | |
| username строка / обязательно | Имя пользователя. |
Примечания
Примечание
- Подробное руководство по модулям CloudStack можно найти в Руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create an user in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_user:
account: developers
username: johndoe
password: S3Cur3
last_name: Doe
first_name: John
email: john.doe@example.com
domain: CUSTOMERS
- name: Lock an existing user in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_user:
username: johndoe
domain: CUSTOMERS
state: locked
- name: Disable an existing user in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_user:
username: johndoe
domain: CUSTOMERS
state: disabled
- name: Enable/unlock an existing user in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_user:
username: johndoe
domain: CUSTOMERS
state: enabled
- name: Remove an user in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_user:
name: customer_xy
domain: CUSTOMERS
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Имя учетной записи пользователя. Пример: developers |
| account_type строка | успех | Тип учетной записи. Пример: user |
| created строка | успех | Дата создания пользователя. Пример: Иванов |
| domain строка | успех | Домен, к которому относится пользователь. Пример: ROOT |
| email строка | успех | Электронная почта пользователя. Пример: john.doe@example.com |
| fist_name строка | успех | Имя пользователя. Пример: Иван |
| id строка | успех | UUID пользователя. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 |
| last_name строка | успех | Фамилия пользователя. Пример: Иванов |
| state строка | успех | Состояние пользователя. Пример: enabled |
| timezone строка | успех | Временная зона пользователя. Пример: enabled |
| user_api_key строка | успех | API-ключ пользователя. Пример: JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg |
| user_api_secret строка | успех | Секретный ключ API пользователя. Пример: FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g |
| username строка | успех | Имя пользователя. Пример: johndoe |
Авторы
- René 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/ngine_io/cloudstack/cs_user_module.html
