Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: ngine_io.cloudstack.cs_account.

Новое в ngine_io.cloudstack 0.1.0

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

Описание

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

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account_type

string

Тип учётной записи.

Варианты:

  • "user" ← (default)
  • "root_admin"
  • "domain_admin"

api_http_method

string

HTTP-метод, используемый для запроса к конечной точке API.

Если не указан, используется переменная окружения CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (default)
  • "post"

api_key

string / required

API ключ CloudStack API.

Если не указан, используется переменная окружения CLOUDSTACK_KEY.

api_secret

string / required

Секретный ключ CloudStack API.

Если не задан, используется переменная окружения CLOUDSTACK_SECRET.

api_timeout

integer

Таймаут HTTP в секундах.

Если не указан, используется переменная окружения CLOUDSTACK_TIMEOUT.

По умолчанию: 10

api_url

string / required

URL CloudStack API, например 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" ← (default)
  • "OU"

name

string / required

Имя учётной записи.

network_domain

string

Сетевой домен учётной записи.

password

string

Пароль пользователя, который будет создан, если учётная запись не существовала.

Обязательно для state=present, если ldap_domain не установлен.

poll_async

boolean

Опрашивать асинхронные задания до завершения задания.

Варианты:

  • false
  • true ← (default)

role

string

Создаёт учётную запись под указанным именем или идентификатором роли.

state

string

Состояние учётной записи.

unlocked является псевдонимом для enabled.

Варианты:

  • "present" ← (default)
  • "absent"
  • "enabled"
  • "disabled"
  • "locked"
  • "unlocked"

timezone

string

Часовой пояс пользователя, который будет создан, если учётная запись не существовала.

username

string

Имя пользователя, который будет создан, если учётная запись не существовала.

Обязательно для state=present.

validate_certs

boolean

added in 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.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

строка

Имя роли учетной записи

Возвращаемое значение: успех

Пример: "Domain Admin"

state

строка

Состояние учетной записи.

Возвращаемое значение: успех

Пример: "enabled"

Авторы

  • René Moser (@resmo)

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API