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-ключ API CloudStack. Если не указано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из конфигурационного файла ini, см. также примечания.
api_region строка	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не указано, используется переменная среды `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ API CloudStack. Если не задано, используется переменная среды `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из конфигурационного файла ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не указано, используется переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из конфигурационного файла ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано.
api_url строка		URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из конфигурационного файла ini, см. также примечания.
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 булево	Варианты: нет да ←	Проверять асинхронные задачи до завершения.
state строка	Варианты: present ← absent enabled disabled locked unlocked	Состояние пользователя. `unlocked` — псевдоним для `enabled`.
timezone строка		Часовой пояс пользователя.
username строка / обязательно		Имя пользователя.

Примечания

Примечание

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 см. в Руководстве по облакам CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create an user in domain 'CUSTOMERS'
  cs_user:
    account: developers
    username: johndoe
    password: S3Cur3
    last_name: Doe
    first_name: John
    email: john.doe@example.com
    domain: CUSTOMERS
  delegate_to: localhost

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

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

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

- name: Remove an user in domain 'CUSTOMERS'
  cs_user:
    name: customer_xy
    domain: CUSTOMERS
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
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]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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