ngine_io.vultr.vultr_user – Управляет пользователями на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr
Для использования в книге задач укажите: ngine_io.vultr.vultr_user
Новое в версии 0.1.0: модуля ngine_io.vultr
Обзор
- Создание, обновление и удаление пользователей.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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_retry_max_delay целое число | Задержка экспоненциального возврата при повторных подключениях в секундах, до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию — 12 секунд, если не указано. | |
| 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
ngine_io.vultr.vultr_user:
name: john
email: john.doe@example.com
password: s3cr3t
acls:
- upgrade
- dns
- manage_users
- subscriptions
- upgrade
- name: Remove a user
ngine_io.vultr.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_retry_max_delay целое число | успех | Экспоненциальная задержка возврата при повторных подключениях в секундах до максимального значения. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_user сложный | успех | Ответ от Vultr API | |
| acls список / элементы=строка | успех | Список разрешений (ACL) пользователя. Пример: ['manage_users', 'support', 'upgrade'] | |
| api_enabled логическое значение | успех | Включен ли API или нет. Пример: True | |
| api_key строка | только после создания ресурса | Ключ API пользователя. Пример: 567E6K567E6K567E6K567E6K567E6K | |
| email строка | успех | Электронная почта пользователя. Пример: john@example.com | |
| id строка | успех | Идентификатор пользователя. Пример: 5904bc6ed9234 | |
| name строка | успех | Имя пользователя. Пример: john | |
Авторы
- 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.10/collections/ngine_io/vultr/vultr_user_module.html
