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 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	По умолчанию: None	Электронная почта пользователя, который будет создан, если учётная запись не существовала. Требуется в `state=present`.
first_name	По умолчанию: None	Имя пользователя, который будет создан, если учётная запись не существовала. Требуется в `state=present`.
last_name	По умолчанию: None	Фамилия пользователя, который будет создан, если учётная запись не существовала. Требуется в `state=present`.
name обязательно		Имя учётной записи.
network_domain	По умолчанию: None	Домен сети учётной записи.
password	По умолчанию: None	Пароль пользователя, который будет создан, если учётная запись не существовала. Требуется в `state=present`.
poll_async	По умолчанию: yes	Проверка асинхронных задач до завершения.
state	Варианты: present ← absent enabled disabled locked unlocked	Состояние учётной записи. `unlocked` — псевдоним для `enabled`.
timezone	По умолчанию: None	Часовой пояс пользователя, который будет создан, если учётная запись не существовала.
username	По умолчанию: None	Имя пользователя пользователя, который будет создан, если учётная запись не существовала. Требуется в `state=present`.

Примечания

Примечание

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

Примеры

# 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, что означает, что разработчики гарантируют отсутствие несовместимых изменений интерфейса.

Автор

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.5/modules/cs_account_module.html