9.3 KiB
9.3 KiB
Модуль decort_user
Обзор модуля
Модуль decort_user предназначен для получения следующей информации о пользователе:
- основная информация (см. возвращаемые значения и примеры)
- используемые и зарезервированные ресурсы (см. параметр resource_consumption, возвращаемые значения и примеры)
- доступные методы API (см. параметр api_methods, возвращаемые значения и примеры)
- поиск доступных объектов по строке (см. параметр objects_search, возвращаемые значения и примеры)
Параметры модуля
Ниже приведен список параметров для модуля decort_user (за исключением общих параметров):
| Параметр | Тип | Описание | |||||
|---|---|---|---|---|---|---|---|
| api_methods |
(bool)
Default: false
|
Получить методы API, к которым имеет доступ пользователь. | |||||
| objects_search | (str) | Получить информацию о доступных пользователю объектах, найденных по строчному значению данного параметра. | |||||
| resource_consumption |
(bool)
Default: false
|
Получить информацию об используемых и зарезервированных ресурсах, к которым имеет доступ пользователь. | |||||
Возвращаемые значения
Модуль decort_user возвращает информацию о пользователе в виде словаря facts со следующими ключами:
Основная информация
| Ключ |
Тип
данных |
Описание | |||||
|---|---|---|---|---|---|---|---|
| admin | bool | Наличие административных прав. | |||||
| data | dict | Дополнительные данные. | |||||
| emailaddresses | list | Адреса эл. почты. | |||||
| name | str | Имя/идентификатор. | |||||
| roles | list | Группы доступа. | |||||
Используемые и зарезервированные ресурсы
| Ключ |
Тип
данных |
Описание | |||||
|---|---|---|---|---|---|---|---|
| resource_consumed | dict | Используемые ресурсы. | |||||
| cpu | int | Количество виртуальных процессоров. | |||||
| disksize | int | Объём дисков в ГБ. | |||||
| extips | int | Количество внешних IP-адресов. | |||||
| exttraffic | int | Объём трафика внешних сетей. | |||||
| gpu | int | Количество графических процессоров. | |||||
| ram | int | Объём оперативной памяти в МБ. | |||||
| seps | dict | Объём дисков по пулам СХД. | |||||
| (идентификатор СХД) | dict | Пулы СХД. | |||||
| (название пула) | dict | Словарь пула СХД. | |||||
| disksize | int | Объём дисков в ГБ. | |||||
| resource_reserved | dict |
Зарезервированные ресурсы.
Структура словаря аналогична словарю resource_consumed . |
|||||
Доступные методы API
| Ключ |
Тип
данных |
Описание | |||||
|---|---|---|---|---|---|---|---|
| api_methods | list | Список словарей, описывающих доступные методы API. | |||||
| (название группы методов API) | dict | Доступные методы группы. | |||||
| (название подгруппы методов API) | list | Методы подгруппы. | |||||
| ALL | bool | Доступ ко всем методам группы. | |||||
Найденные объекты
| Ключ |
Тип
данных |
Описание | |||||
|---|---|---|---|---|---|---|---|
| objects_search | list | Список словарей, описывающих найденные объекты. | |||||
Примеры использования
Получение основной информации о пользователе
- name: Example
hosts: localhost
tasks:
- name: Get basic user info
decort_user:
# Параметры для авторизации упущены
Получение информации об используемых и зарезервируемых ресурсах
- name: Example
hosts: localhost
tasks:
- name: Get user info with resource consumption
decort_user:
# Параметры для авторизации упущены
resource_consumption: true
Получение доступных методов API
- name: Example
hosts: localhost
tasks:
- name: Get user info with API methods
decort_user:
# Параметры для авторизации упущены
api_methods: true
Поиск доступных объектов
- name: Example
hosts: localhost
tasks:
- name: Get user info with found objects
decort_user:
# Параметры для авторизации упущены
objects_search: test