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"	Имя раздела в файле конфигурации `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 boolean	Варианты: 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_TIMEOUT, указывающая на файл CLOUDSTACK_CONFIG. Файл .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 строка	успех	Тип учетной записи. Пример: user
domain строка	успех	Домен, к которому относится учетная запись. Пример: ROOT
id строка	успех	UUID учетной записи. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name строка	успех	Имя учетной записи. Пример: linus@example.com
network_domain строка	успех	Сетевой домен учетной записи. Пример: example.local
state строка	успех	Состояние учетной записи. Пример: enabled

Статус

Этот модуль гарантирует отсутствие обратной несовместимости в будущем. [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.7/modules/cs_account_module.html