vultr_user – Управление пользователями на Vultr
Новое в версии 2.5.
Обзор
- Создание, обновление и удаление пользователей.
Псевдонимы: vr_user
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| acls - |
| Список разрешений (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_timeout целое число | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 60 секунд, если не указано. | |
| email - | Электронная почта пользователя. Требуется, если state=present. | |
| force логическое значение |
| Пароль будет изменён только принудительно. |
| name - / обязательно | Имя пользователя | |
| password - | Пароль пользователя. Рассматривается только при создании пользователя или если force=yes. | |
| state - |
| Состояние пользователя. |
| 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 сложный тип | успех | Ответ от Vultr API с несколькими дополнениями/изменениями | |
| api_account строка | успех | Используемый в файле ini аккаунт для выбора ключа Пример: default | |
| api_endpoint строка | успех | Используемая конечная точка для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток повтора для запросов API Пример: 5 | |
| api_timeout целое число | успех | Используемый таймаут для запросов API Пример: 60 | |
| vultr_user сложный тип | успех | Ответ от Vultr API | |
| 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.8/modules/vultr_user_module.html
