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

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account		Учетная запись, под которой будет создан пользователь. Обязательно для `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		Электронная почта пользователя. Обязательно для `state=present`.
first_name		Имя пользователя. Обязательно для `state=present`.
keys_registered bool (добавлено в 2.4)	Варианты: нет ← да	Если необходимо сгенерировать API-ключи пользователя. Примечание: ключи нельзя удалить с помощью API.
last_name		Фамилия пользователя. Обязательно для `state=present`.
password		Пароль пользователя, который нужно создать. Обязательно для `state=present`. Используется только при создании и не будет обновляться, если пользователь уже существует.
poll_async bool	Варианты: нет да ←	Проверяет асинхронные задачи до завершения.
state	Варианты: присутствует ← отсутствует активен выключен заблокирован разблокирован	Состояние пользователя. `unlocked` — псевдоним для `enabled`.
timezone		Временная зона пользователя.
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: Руководство по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: 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

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

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

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

- name: 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, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые с предыдущими версиями изменения интерфейса.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/cs_user_module.html