Spec-Zone.ru › Ansible 2.10

ngine_io.cloudstack.cs_user – Управляет пользователями в облаках на базе Apache CloudStack.

Примечание

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

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

Для использования в playbook, укажите: ngine_io.cloudstack.cs_user.

Введено в версии 0.1.0: of ngine_io.cloudstack

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

Обзор

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

Требования

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

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account
строка
Учетная запись, под которой будет создан пользователь.
Обязательно для state=present.
api_http_method
строка
    Варианты:
  • get
  • post
Метод HTTP, используемый для запроса к API-точке.
Если не указано, используется значение переменной окружения CLOUDSTACK_METHOD.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
Значение по умолчанию get если не указано.
api_key
строка
Ключ API CloudStack API.
Если не указано, используется значение переменной окружения CLOUDSTACK_KEY.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region
строка
Значение по умолчанию:
"cloudstack"
Имя раздела в файле конфигурации ini cloustack.ini.
Если не указано, используется значение переменной окружения CLOUDSTACK_REGION.
api_secret
строка
Секретный ключ 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, см. также примечания.
api_verify_ssl_cert
строка
Файл сертификата CA.
Если не указано, используется значение переменной окружения CLOUDSTACK_VERIFY.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
Значение по умолчанию null если не указано.
domain
строка
Значение по умолчанию:
"ROOT"
Домен, к которому относится пользователь.
email
строка
Электронная почта пользователя.
Обязательно для state=present.
first_name
строка
Имя пользователя.
Обязательно для state=present.
keys_registered
логическое значение
    Варианты:
  • нет ←
  • да
Если для пользователя должны быть сгенерированы ключи API.
Примечание: ключи не могут быть удалены API повторно.
last_name
строка
Фамилия пользователя.
Обязательно для state=present.
password
строка
Пароль пользователя, подлежащего созданию.
Обязательно для state=present.
Учитывается только при создании и не будет обновляться, если пользователь существует.
poll_async
логическое значение
    Варианты:
  • нет
  • да ←
Ожидать завершения асинхронных задач.
state
строка
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
  • locked
  • unlocked
Состояние пользователя.
unlocked является псевдонимом для enabled.
timezone
строка
Временная зона пользователя.
username
строка / обязательно
Имя пользователя.

Примечания

Примечание

  • Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация читается из нескольких мест в указанном порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды CLOUDSTACK_TIMEOUT, указывающая на файл CLOUDSTACK_CONFIG. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с использованием разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Дополнительная информация находится по адресу https://github.com/exoscale/cs.
  • Подробное руководство по модулям Cloudstack можно найти в Руководстве по облаку CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

- name: Create an user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    account: developers
    username: johndoe
    password: S3Cur3
    last_name: Doe
    first_name: John
    email: john.doe@example.com
    domain: CUSTOMERS

- name: Lock an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    username: johndoe
    domain: CUSTOMERS
    state: locked

- name: Disable an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    username: johndoe
    domain: CUSTOMERS
    state: disabled

- name: Enable/unlock an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    username: johndoe
    domain: CUSTOMERS
    state: enabled

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

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

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

Ключ Возвращаемое значение Описание
account
строка
успех
Имя учетной записи пользователя.

Пример:
developers
account_type
строка
успех
Тип учетной записи.

Пример:
user
created
строка
успех
Дата создания пользователя.

Пример:
Иванов
domain
строка
успех
Домен, к которому относится пользователь.

Пример:
ROOT
email
строка
успех
Электронный адрес пользователя.

Пример:
john.doe@example.com
fist_name
строка
успех
Имя пользователя.

Пример:
Иван
id
строка
успех
UUID пользователя.

Пример:
87b1e0ce-4e01-11e4-bb66-0050569e64b8
last_name
строка
успех
Фамилия пользователя.

Пример:
Иванов
state
строка
успех
Состояние пользователя.

Пример:
включен
timezone
строка
успех
Временная зона пользователя.

Пример:
включен
user_api_key
строка
успех
Ключ API пользователя.

Пример:
JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg
user_api_secret
строка
успех
Секретный ключ API пользователя.

Пример:
FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g
username
строка
успех
Имя пользователя.

Пример:
имяпользователя


Авторы

  • 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_user_module.html

Spec-Zone.ru

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