Модуль ngine_io.cloudstack.user — управление пользователями в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.user.

Добавлено в ngine_io.cloudstack 0.1.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Псевдонимы: cs_user

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

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

Примечания

Примечание

Подробное руководство по модулям CloudStack можно найти в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create an user in domain 'CUSTOMERS'
  ngine_io.cloudstack.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'
  ngine_io.cloudstack.user:
    username: johndoe
    domain: CUSTOMERS
    state: locked

- name: Disable an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.user:
    username: johndoe
    domain: CUSTOMERS
    state: disabled

- name: Enable/unlock an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.user:
    username: johndoe
    domain: CUSTOMERS
    state: enabled

- name: Remove an user in domain 'CUSTOMERS'
  ngine_io.cloudstack.user:
    name: customer_xy
    domain: CUSTOMERS
    state: absent

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

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

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

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/user_module.html