Модуль vultr.cloud.user – управление пользователями в Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).

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

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

Чтобы использовать её в плейбуке, укажите: vultr.cloud.user.

Добавлено в vultr.cloud 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
acls псевдонимы: acl список / элементы=строка	Список ACL, которые должны быть назначены этому пользователю. Обязательно, если `state=present`. Одно или несколько значений из списка; некоторые из них зависят друг от друга. Варианты: `"manage_users"` `"subscriptions_view"` `"subscriptions"` `"provisioning"` `"billing"` `"support"` `"abuse"` `"dns"` `"upgrade"` `"objstore"` `"loadbalancer"`
api_enabled логическое значение	Включён ли API. Варианты: `false` `true` ← (по умолчанию)
api_endpoint строка	URL конечной точки API (без завершающей косой черты). Резервная переменная среды `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательный	Ключ API Vultr. Резервная переменная среды `VULTR_API_KEY`.
api_results_per_page целое число добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться при каждом запросе к API. Этот параметр не определяет общее количество возвращаемых результатов: все ресурсы возвращаются с учётом других фильтров. Максимальное значение для API Vultr — 500. Резервная переменная среды `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries целое число	Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная среды `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Экспоненциальная задержка между повторными попытками (в секундах) увеличивается до этого максимального значения. Резервная переменная среды `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Тайм-аут HTTP-запроса к API Vultr. Резервная переменная среды `VULTR_API_TIMEOUT`. По умолчанию: `180`
email строка	Адрес электронной почты пользователя. Обязательно, если `state=present`.
force логическое значение	Пароль будет изменён только при принудительном применении. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательный	Имя пользователя
password строка	Пароль пользователя. Учитывается только при создании пользователя или если `force=true`.
state строка	Состояние пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Проверять SSL-сертификаты API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Ensure a user exists
  vultr.cloud.user:
    name: john
    email: john.doe@example.com
    password: s3cr3t
    acls:
    - manage_users
    - subscriptions

- name: Remove a user
  vultr.cloud.user:
    name: john
    state: absent

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

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

Ключ	Описание
vultr_api словарь	Ответ API Vultr с некоторыми дополнениями и изменениями. Возвращается: при успехе
api_endpoint строка	Конечная точка, используемая для запросов к API. Возвращается: при успехе Пример: `"https://api.vultr.com/v2"`
api_results_per_page целое число	Количество результатов, возвращаемых при каждом запросе к API. Возвращается: при успехе Пример: `100`
api_retries целое число	Максимальное количество повторных попыток для запросов к API. Возвращается: при успехе Пример: `5`
api_retry_max_delay целое число	Максимальная экспоненциальная задержка (в секундах) между повторными попытками. Возвращается: при успехе Пример: `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@example.com"`
id строка	Идентификатор пользователя. Возвращается: при успехе Пример: `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name строка	Имя пользователя. Возвращается: при успехе Пример: `"john"`

Авторы

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/vultr/cloud/user_module.html