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

Примечание

Этот модуль является частью коллекции vultr.cloud collection (версия 1.13.0).

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

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

Для использования в playbook, укажите: vultr.cloud.user.

Новое в vultr.cloud 1.0.0

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

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

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

Параметры

Параметр	Комментарии
acls aliases: acl list / elements=string	Список ACL, которые должен иметь этот пользователь. Требуется, если `state=present`. Один или несколько вариантов из списка, некоторые зависят друг от друга. Варианты: `"manage_users"` `"subscriptions_view"` `"subscriptions"` `"provisioning"` `"billing"` `"support"` `"abuse"` `"dns"` `"upgrade"` `"objstore"` `"loadbalancer"`
api_enabled boolean	Включен ли API или нет. Варианты: `false` `true` ← (по умолчанию)
api_endpoint string	URL конечной точки API (без косой черты в конце). Запасная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / required	API ключ Vultr API. Запасная переменная окружения `VULTR_API_KEY`.
api_retries integer	Количество попыток в случае, если Vultr API возвращает код HTTP ошибки, например - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Запасная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Задержка повторной попытки в секундах, экспоненциально увеличивается до этого максимального значения, в секундах. Запасная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Таймаут HTTP для Vultr API. Запасная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
email string	Электронная почта пользователя. Требуется, если `state=present`.
force boolean	Пароль будет изменен только при принудительном изменении. Варианты: `false` ← (по умолчанию) `true`
name string / required	Имя пользователя
password string	Пароль пользователя. Учитывается только при создании пользователя или когда `force=true`.
state string	Состояние пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять SSL сертификаты Vultr API. Варианты: `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_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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/user_module.html