cs_account - Управляет учетными записями на облаках Apache CloudStack.
Новое в версии 2.0.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создание, отключение, блокировка, включение и удаление учетных записей.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| account_type | нет | user |
| Тип учетной записи. |
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | Ключ API CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL CloudStack API, например, https://cloud.example.com/client/api. | ||
| domain | нет | ROOT | Домен, к которому относится учетная запись. | |
| email | нет | Электронная почта пользователя, который должен быть создан, если учетная запись не существовала. Требуется в state=present. | ||
| first_name | нет | Имя пользователя, который должен быть создан, если учетная запись не существовала. Требуется в state=present. | ||
| last_name | нет | Фамилия пользователя, который должен быть создан, если учетная запись не существовала. Требуется в state=present. | ||
| name | да | Имя учетной записи. | ||
| network_domain | нет | Сетевой домен учетной записи. | ||
| password | нет | Пароль пользователя, который должен быть создан, если учетная запись не существовала. Требуется в state=present. | ||
| poll_async | нет | True | Ожидать завершения асинхронных задач. | |
| state | нет | present |
| Состояние учетной записи. unlocked - псевдоним для enabled. |
| timezone | нет | Часовой пояс пользователя, который должен быть создан, если учетная запись не существовала. | ||
| username | нет | Имя пользователя пользователя, который должен быть создан, если учетная запись не существовала. Требуется в state=present. |
Примеры
# create an account in domain 'CUSTOMERS' local_action: module: cs_account name: customer_xy username: customer_xy password: S3Cur3 last_name: Doe first_name: John email: john.doe@example.com domain: CUSTOMERS # Lock an existing account in domain 'CUSTOMERS' local_action: module: cs_account name: customer_xy domain: CUSTOMERS state: locked # Disable an existing account in domain 'CUSTOMERS' local_action: module: cs_account name: customer_xy domain: CUSTOMERS state: disabled # Enable an existing account in domain 'CUSTOMERS' local_action: module: cs_account name: customer_xy domain: CUSTOMERS state: enabled # Remove an account in domain 'CUSTOMERS' local_action: module: cs_account name: customer_xy domain: CUSTOMERS state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| account_type | Тип учетной записи. | успех | строка | user |
| domain | Домен, к которому относится учетная запись. | успех | строка | ROOT |
| id | UUID учетной записи. | успех | строка | 87b1e0ce-4e01-11e4-bb66-0050569e64b8 |
| name | Имя учетной записи. | успех | строка | linus@example.com |
| network_domain | Сетевой домен учетной записи. | успех | строка | example.local |
| state | Состояние учетной записи. | успех | строка | enabled |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких источников в следующем порядке. - ФайлыCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. - Переменные окруженияCLOUDSTACK_TIMEOUT. - Переменная окруженияCLOUDSTACK_CONFIG, указывающая на файл.ini. - Файлcloudstack.iniв текущей рабочей директории. - Файл.cloudstack.iniв домашней директории пользователя. Дополнительно, можно указать несколько учетных данных и конечных точек, используя разделы ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используетсяcloudstack. Более подробная информация на https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют отсутствие несовместимых изменений интерфейса.
Для помощи в разработке модулей обратитесь к Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_account_module.html