vr_user — Управляет пользователями на Vultr.

Новая версия 2.5.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Создание, обновление и удаление пользователей.

Требования

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

python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
acls	Варианты: manage_users subscriptions provisioning billing support abuse dns upgrade	Список разрешений ACL, которые должен иметь этот пользователь, см. https://www.vultr.com/api/#user_user_list. Требуется, если `state=present`. Один или несколько из списка вариантов, некоторые зависят друг от друга.
api_account	По умолчанию: "default"	Имя раздела ini в файле `vultr.ini`. Переменная среды `VULTR_API_ACCOUNT` используется как значение по умолчанию, если она определена.
api_enabled bool	Варианты: нет да ←	Включён или нет API.
api_endpoint	По умолчанию: "https://api.vultr.com"	URL конечной точки API (без конечного слэша). Переменная среды `VULTR_API_ENDPOINT` используется как значение по умолчанию, если она определена.
api_key		Ключ API Vultr API. Переменная среды `VULTR_API_KEY` используется как значение по умолчанию, если она определена.
api_retries	По умолчанию: 5	Количество попыток в случае, если Vultr API возвращает код HTTP 503. Переменная среды `VULTR_API_RETRIES` используется как значение по умолчанию, если она определена.
api_timeout	По умолчанию: 60	Таймаут HTTP для Vultr API. Переменная среды `VULTR_API_TIMEOUT` используется как значение по умолчанию, если она определена.
email		Электронная почта пользователя. Требуется, если `state=present`.
force bool	Варианты: нет ← да	Пароль будет изменён только принудительно.
name обязательно		Имя пользователя
password		Пароль пользователя. Учитывается только при создании пользователя или при `force=yes`.
state	Варианты: present ← absent	Состояние пользователя.
validate_certs bool	Варианты: нет да ←	Проверять SSL-сертификаты Vultr API.

Примечания

Примечание

См. также документацию API по адресу https://www.vultr.com/api/.

Примеры

- name: Ensure a user exists
  local_action:
    module: vr_user
    name: john
    email: john.doe@example.com
    password: s3cr3t
    acls:
      - upgrade
      - dns
      - manage_users
      - subscriptions
      - upgrade

- name: Remove a user
  local_action:
    module: vr_user
    name: john
    state: absent

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

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

Ключ		Возвращается	Описание
vultr_api сложное		успех	Ответ от Vultr API с некоторыми дополнениями/изменениями
	api_account строка	успех	Аккаунт, используемый в файле ini для выбора ключа Пример: default
	api_timeout целое число	успех	Таймаут, используемый для запросов API Пример: 60
	api_retries целое число	успех	Максимальное количество попыток для запросов API Пример: 5
	api_endpoint строка	успех	Конечная точка, используемая для запросов API Пример: https://api.vultr.com
vultr_user сложное		успех	Ответ от Vultr API
	id строка	успех	Идентификатор пользователя. Пример: 5904bc6ed9234
	api_key строка	только после создания ресурса	Ключ API пользователя. Пример: 567E6K567E6K567E6K567E6K567E6K
	name строка	успех	Имя пользователя. Пример: john
	email строка	успех	Электронная почта пользователя. Пример: john@exmaple.com
	api_enabled bool	успех	Включён или нет API. Пример: True
	acls список	успех	Список ACL пользователя. Пример: ['manage_users', 'support', 'upgrade']

Статус

Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и техническое обслуживание модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/vr_user_module.html