cs_account - Управляет учётными записями в облаках на основе Apache CloudStack.

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account_type	Варианты: user ← root_admin domain_admin	Тип учётной записи.
api_http_method	Варианты: get post	Метод HTTP, используемый для запроса к API-точке входа. Если не указано, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последнего варианта значение берётся из конфигурационного файла ini, см. также примечания. Значение по умолчанию - `get`, если не указано.
api_key		API-ключ CloudStack API. Если не указано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта значение берётся из конфигурационного файла ini, см. также примечания.
api_region	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `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`.
last_name		Фамилия пользователя, который будет создан, если учётная запись не существует. Требуется в `state=present`.
name обязательно		Имя учётной записи.
network_domain		Сетевой домен учётной записи.
password		Пароль пользователя, который будет создан, если учётная запись не существует. Требуется в `state=present`.
poll_async bool	Варианты: no yes ←	Ожидать завершения асинхронных заданий.
state	Варианты: present ← absent enabled disabled locked unlocked	Состояние учётной записи. `unlocked` — псевдоним для `enabled`.
timezone		Временная зона пользователя, который будет создан, если учётная запись не существует.
username		Имя пользователя пользователя, который будет создан, если учётная запись не существует. Требуется в `state=present`.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если данные для авторизации не предоставлены в аргументах api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в указанном ниже порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды CLOUDSTACK_CONFIG, указывающая на файл конфигурации .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких данных для авторизации и точек входа с помощью разделов ini в файле cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Дополнительную информацию можно найти на странице https://github.com/exoscale/cs.
Подробное руководство по модулям Cloudstack можно найти в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

# create an account in domain 'CUSTOMERS'
- local_action:
    module: cs_account
    name: customer_xy
    username: customer_xy
    password: S3Cur3
    last_name: Doe
    first_name: John
    email: john.doe@example.com
    domain: CUSTOMERS

# Lock an existing account in domain 'CUSTOMERS'
- local_action:
    module: cs_account
    name: customer_xy
    domain: CUSTOMERS
    state: locked

# Disable an existing account in domain 'CUSTOMERS'
- local_action:
    module: cs_account
    name: customer_xy
    domain: CUSTOMERS
    state: disabled

# Enable an existing account in domain 'CUSTOMERS'
- local_action:
    module: cs_account
    name: customer_xy
    domain: CUSTOMERS
    state: enabled

# Remove an account in domain 'CUSTOMERS'
- local_action:
    module: cs_account
    name: customer_xy
    domain: CUSTOMERS
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
account_type строка	success	Тип учётной записи. Пример: user
domain строка	success	Домен, к которому относится учётная запись. Пример: ROOT
id строка	success	UUID учётной записи. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name строка	success	Имя учётной записи. Пример: linus@example.com
network_domain строка	success	Сетевой домен учётной записи. Пример: example.local
state строка	success	Состояние учётной записи. Пример: enabled

Статус

Этот модуль помечен как 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_account_module.html