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

Примечание

Этот плагин является частью коллекции ngine_io.cloudstack (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.

Для использования в книге задач укажите: ngine_io.cloudstack.cs_account.

Новое в версии 0.1.0: из ngine_io.cloudstack

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

Описание

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

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, см. также примечания.
api_verify_ssl_cert строка		Файл сертификата авторитета CA. Если не задано, рассматривается переменная среды `CLOUDSTACK_VERIFY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию `null`, если не указано.
domain строка	По умолчанию: "ROOT"	Домен, к которому относится учетная запись.
email строка		Электронная почта пользователя, который должен быть создан, если учетная запись не существовала. Требуется в состоянии state=present, если ldap_domain не задан.
first_name строка		Имя пользователя, который должен быть создан, если учетная запись не существовала. Требуется в состоянии state=present, если ldap_domain не задан.
last_name строка		Фамилия пользователя, который должен быть создан, если учетная запись не существовала. Требуется в состоянии state=present, если ldap_domain не задан.
ldap_domain строка		Имя группы LDAP или OU для привязки. Если задано, учетная запись будет связана с LDAP.
ldap_type строка	Варианты: GROUP ← OU	Тип имени ldap. GROUP или OU, по умолчанию GROUP.
name строка / обязательно		Имя учетной записи.
network_domain строка		Домен сети учетной записи.
password строка		Пароль пользователя, который должен быть создан, если учетная запись не существовала. Требуется в состоянии state=present, если ldap_domain не задан.
poll_async булево	Варианты: нет да ←	Отслеживать асинхронные задачи до завершения работы.
role строка		Создает учетную запись под указанным именем или идентификатором роли.
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 в текущем рабочем каталоге. Файл .cloudstack.ini в домашнем каталоге пользователя. Допускается указание нескольких учетных данных и точек входа с помощью разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию раздел cloudstack. Подробную информацию см. на https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: create an account in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_account:
    name: customer_xy
    username: customer_xy
    password: S3Cur3
    last_name: Doe
    first_name: John
    email: john.doe@example.com
    domain: CUSTOMERS
    role: Domain Admin

- name: Lock an existing account in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: locked

- name: Disable an existing account in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: disabled

- name: Enable an existing account in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: enabled

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

- name: Create a single user LDAP account in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_account:
    name: customer_xy
    username: customer_xy
    domain: CUSTOMERS
    ldap_domain: cn=customer_xy,cn=team_xy,ou=People,dc=domain,dc=local

- name: Create a LDAP account in domain 'CUSTOMERS' and bind it to a LDAP group
  ngine_io.cloudstack.cs_account:
    name: team_xy
    username: customer_xy
    domain: CUSTOMERS
    ldap_domain: cn=team_xy,ou=People,dc=domain,dc=local

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

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

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

Авторы

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.10/collections/ngine_io/cloudstack/cs_account_module.html