vultr_user – Управляет пользователями на Vultr

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

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

Описание

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

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

Требования

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

python >= 2.6

Параметры

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

Примечания

Примечание

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

Примеры

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

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

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом 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.9/modules/vultr_user_module.html