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

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

Описание
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Описание

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

Требования (к хосту, на котором выполняется модуль)

python >= 2.6
cs >= 0.6.10

Параметры

параметр	обязателен	значение по умолчанию	выбор	комментарии
account	нет			Аккаунт, под которым будет создан пользователь. Обязательно для `state=present`.
api_http_method	нет	get	get post	Используемый метод HTTP.
api_key	нет			Ключ API CloudStack API.
api_region	нет	cloudstack		Имя раздела ini в файле `cloustack.ini`.
api_secret	нет			Секретный ключ API 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`.
keys_registered (добавлен в 2.4)	нет			Если должны быть сгенерированы ключи API пользователя. Примечание: ключи API больше нельзя удалить через API.
last_name	нет			Фамилия пользователя. Обязательно для `state=present`.
password	нет			Пароль пользователя для создания. Обязательно для `state=present`. Учитывается только при создании и не будет обновляться, если пользователь существует.
poll_async	нет	True		Ожидать завершения асинхронных задач.
state	нет	present	present absent enabled disabled locked unlocked	Состояние пользователя. `unlocked` является псевдонимом для `enabled`.
timezone	нет			Временная зона пользователя.
username	да			Имя пользователя.

Примеры

# 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	Дата создания пользователя.	успех	строка	Иванов
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

Примечания

Примечание

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_user_module.html