cs_user — Управляет пользователями на облаках Apache CloudStack.

Новое в версии 2.0.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Создавать, обновлять, отключать, блокировать, активировать и удалять пользователей.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account	По умолчанию: None	Учетная запись, под которой будет создан пользователь. Требуется в `state=present`.
api_http_method	Варианты: get post	HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной окружения `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию `get`, если не указано.
api_key		Ключ API CloudStack API. Если не указано, используется значение переменной окружения `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region	По умолчанию: cloudstack	Имя раздела в файле конфигурации `cloustack.ini`. Если не указано, используется значение переменной окружения `CLOUDSTACK_REGION`.
api_secret		Секретный ключ CloudStack API. Если не указано, используется значение переменной окружения `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout		Таймаут HTTP в секундах. Если не указано, используется значение переменной окружения `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано.
api_url		URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной окружения `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
domain	По умолчанию: ROOT	Домен, к которому относится пользователь.
email	По умолчанию: None	Электронная почта пользователя. Требуется в `state=present`.
first_name	По умолчанию: None	Имя пользователя. Требуется в `state=present`.
keys_registered (добавлено в 2.4)	По умолчанию: None	Если необходимо сгенерировать API-ключи пользователя. Примечание: ключи больше нельзя удалить с помощью API.
last_name	По умолчанию: None	Фамилия пользователя. Требуется в `state=present`.
password	По умолчанию: None	Пароль пользователя для создания. Требуется в `state=present`. Учитывается только при создании и не будет обновляться, если пользователь существует.
poll_async	По умолчанию: yes	Ожидать завершения асинхронных задач.
state	Варианты: present ← absent enabled disabled locked unlocked	Состояние пользователя. `unlocked` — псевдоним для `enabled`.
timezone	По умолчанию: None	Часовой пояс пользователя.
username обязательно		Имя пользователя.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в указанном порядке. Переменные окружения CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная окружения CLOUDSTACK_TIMEOUT, указывающая на файл CLOUDSTACK_CONFIG. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допустимо указать несколько учетных данных и конечных точек, используя разделы ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Дополнительная информация на странице https://github.com/exoscale/cs.
Подробное руководство по модулям CloudStack можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

# create an user in domain 'CUSTOMERS'
- local_action:
    module: cs_user
    account: developers
    username: johndoe
    password: S3Cur3
    last_name: Doe
    first_name: John
    email: john.doe@example.com
    domain: CUSTOMERS

# Lock an existing user in domain 'CUSTOMERS'
- local_action:
    module: cs_user
    username: johndoe
    domain: CUSTOMERS
    state: locked

# Disable an existing user in domain 'CUSTOMERS'
- local_action:
    module: cs_user
    username: johndoe
    domain: CUSTOMERS
    state: disabled

# Enable/unlock an existing user in domain 'CUSTOMERS'
- local_action:
    module: cs_user
    username: johndoe
    domain: CUSTOMERS
    state: enabled

# Remove an user in domain 'CUSTOMERS'
- local_action:
    module: cs_user
    name: customer_xy
    domain: CUSTOMERS
    state: absent

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
account строка	успешно	Имя учетной записи пользователя. Пример: developers
account_type строка	успешно	Тип учетной записи. Пример: user
created строка	успешно	Дата создания пользователя. Пример: Doe
domain строка	успешно	Домен, к которому относится пользователь. Пример: ROOT
email строка	успешно	Электронный адрес пользователя. Пример: john.doe@example.com
fist_name строка	успешно	Имя пользователя. Пример: John
id строка	успешно	UUID пользователя. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
last_name строка	успешно	Фамилия пользователя. Пример: Doe
state строка	успешно	Состояние пользователя. Пример: enabled
timezone строка	успешно	Временная зона пользователя. Пример: enabled
user_api_key строка	успешно	Ключ API пользователя. Пример: JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg
user_api_secret строка	успешно	Секретный ключ API пользователя. Пример: FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g
username строка	успешно	Имя пользователя. Пример: johndoe

Статус

Этот модуль помечен как stableinterface, что означает, что поддерживающие этот модуль гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Автор

René Moser (@resmo)

Подсказка

Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/cs_user_module.html