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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: ngine_io.cloudstack.cs_user.

Новый в ngine_io.cloudstack 0.1.0

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

Описание

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

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

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

Примечания

Примечание

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

Примеры

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

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

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

- name: Remove an user in domain 'CUSTOMERS'
  ngine_io.cloudstack.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"`

Авторы

René Moser (@resmo)

Ссылки на сборку

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