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 строка		Электронная почта пользователя, который будет создан, если учётная запись не существует. Обязательно при state=present, если ldap_domain не задано.
first_name строка		Имя пользователя, который будет создан, если учётная запись не существует. Обязательно при state=present, если ldap_domain не задано.
last_name строка		Фамилия пользователя, который будет создан, если учётная запись не существует. Обязательно при state=present, если ldap_domain не задано.
ldap_domain строка добавлено в 2.8		Имя LDAP-группы или подразделения для связи. Если задано, учётная запись будет связана с LDAP.
ldap_type строка добавлено в 2.8	Варианты: GROUP ← OU	Тип LDAP-имени. GROUP или OU, по умолчанию GROUP.
name строка / обязательно		Имя учётной записи.
network_domain строка		Сетевой домен учётной записи.
password строка		Пароль пользователя, который будет создан, если учётная запись не существует. Обязательно при state=present, если ldap_domain не задано.
poll_async булево	Варианты: no yes ←	Опрашивать асинхронные задачи до завершения.
role строка добавлено в 2.8		Создаёт учётную запись под указанным именем или идентификатором роли.
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'
  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
  delegate_to: localhost

- name: Lock an existing account in domain 'CUSTOMERS'
  cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: locked
  delegate_to: localhost

- name: Disable an existing account in domain 'CUSTOMERS'
  cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: disabled
  delegate_to: localhost

- name: Enable an existing account in domain 'CUSTOMERS'
  cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: enabled
  delegate_to: localhost

- name: Remove an account in domain 'CUSTOMERS'
  cs_account:
    name: customer_xy
    domain: CUSTOMERS
    state: absent
  delegate_to: localhost

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

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

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

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

Ключ	Возвращаемое значение	Описание
account_type строка	успешно	Тип учетной записи. Пример: user
domain строка	успешно	Домен, к которому относится учетная запись. Пример: ROOT
id строка	успешно	UUID учетной записи. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name строка	успешно	Имя учетной записи. Пример: linus@example.com
network_domain строка	успешно	Сеть домен учетной записи. Пример: example.local
role строка	успешно	Имя роли учетной записи Пример: Domain Admin
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.8/modules/cs_account_module.html