vr_user — Управляет пользователями на Vultr.
Новая версия 2.5.
Обзор
- Создание, обновление и удаление пользователей.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| acls |
| Список разрешений (ACLs), которые должен иметь этот пользователь, см. https://www.vultr.com/api/#user_user_list. Требуется, если state=present. Один или несколько вариантов из списка; некоторые из них зависят друг от друга. |
| api_account | Значение по умолчанию: default | Имя раздела ini в файле vultr.ini.Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если определена. |
| api_enabled |
yes | Включен или нет 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 используется в качестве значения по умолчанию, если определена. |
| Электронная почта пользователя. Требуется, если state=present. | ||
| force |
no | Пароль будет изменён только принудительно. |
| name обязательно | Имя пользователя | |
| password | Пароль пользователя. Рассматривается только при создании пользователя или если force=yes. | |
| state |
| Состояние пользователя. |
| validate_certs |
| Проверять сертификаты 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_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | успех | Максимальное количество попыток повторного подключения для запросов API Пример: 5 | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| vultr_user сложное | успех | Ответ от Vultr API | |
| acls список | успех | Список ACLs пользователя. Пример: ['manage_users', 'support', 'upgrade'] | |
| name строка | успех | Имя пользователя. Пример: john | |
| api_enabled булево | успех | Включен или нет API. Пример: True | |
| api_key строка | только после создания ресурса | Ключ API пользователя. Пример: 567E6K567E6K567E6K567E6K567E6K | |
| id строка | успех | ID пользователя. Пример: 5904bc6ed9234 | |
| email строка | успех | Электронная почта пользователя. Пример: john@exmaple.com | |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/vr_user_module.html
