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

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

Описание

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

Требования

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

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