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

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.account.

Добавлено в ngine_io.cloudstack 0.1.0

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

Обзор

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

Псевдонимы: cs_account

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Описание
account_type string	Тип учетной записи. Варианты: `"user"` ← (по умолчанию) `"root_admin"` `"domain_admin"`
api_http_method string	Метод HTTP, используемый для обращения к конечной точке API. Если параметр не задан, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательный	Ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательный	Секретный ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Тайм-аут HTTP в секундах. Если параметр не задан, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если параметр не задан, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверять файл сертификата центра сертификации. Если параметр не задан, используется переменная окружения `CLOUDSTACK_VERIFY`.
domain string	Домен, к которому относится учетная запись. По умолчанию: `"ROOT"`
email string	Адрес электронной почты пользователя, создаваемого, если учетная запись еще не существует. Обязателен при state=present, если не задан ldap_domain.
first_name string	Имя пользователя, создаваемого, если учетная запись еще не существует. Обязателен при state=present, если не задан ldap_domain.
last_name string	Фамилия пользователя, создаваемого, если учетная запись еще не существует. Обязателен при state=present, если не задан ldap_domain.
ldap_domain string	Имя группы LDAP или OU, с которой нужно связать учетную запись. Если параметр задан, учетная запись будет связана с LDAP.
ldap_type string	Тип имени LDAP: GROUP или OU; по умолчанию GROUP. Варианты: `"GROUP"` ← (по умолчанию) `"OU"`
name string / обязательный	Имя учетной записи.
network_domain string	Сетевой домен учетной записи.
password string	Пароль пользователя, создаваемого, если учетная запись еще не существует. Обязателен при state=present, если не задан ldap_domain.
poll_async boolean	Ожидать завершения асинхронных заданий, периодически проверяя их состояние. Варианты: `false` `true` ← (по умолчанию)
role string	Создает учетную запись с указанным именем или идентификатором роли.
state string	Состояние учетной записи. `unlocked` — псевдоним для `enabled`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"enabled"` `"disabled"` `"locked"` `"unlocked"`
timezone string	Часовой пояс пользователя, создаваемого, если учетная запись еще не существует.
username string	Имя пользователя, создаваемого, если учетная запись еще не существует. Обязателен при state=present.
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если `false`, SSL-сертификаты проверяться не будут. Если параметр не задан, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Подробное руководство по модулям CloudStack см. в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: create an account in domain 'CUSTOMERS'
  ngine_io.cloudstack.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.account:
    name: customer_xy
    domain: CUSTOMERS
    state: locked

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

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

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

- name: Create a single user LDAP account in domain 'CUSTOMERS'
  ngine_io.cloudstack.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.account:
    name: team_xy
    username: customer_xy
    domain: CUSTOMERS
    ldap_domain: cn=team_xy,ou=People,dc=domain,dc=local

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

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

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

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/account_module.html