Модуль 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	Дополнительные данные.
email_addresses	list	Адреса эл. почты.
name	str	Имя/идентификатор.
roles	list	Группы доступа.

Используемые и зарезервированные ресурсы

Ключ							Тип данных	Описание
consumed							dict[str, any]	Используемые ресурсы.
	cpu_count						int	Количество виртуальных процессоров.
	ext_ip_count						int	Количество внешних IP-адресов.
	gpu_count						int	Количество графических процессоров.
	ram_size_mb						int	Объём оперативной памяти в МБ.
	storage_size_gb_by_disk_max						int	Объём дисков в ГБ, подсчитанный с использованием данных о максимальном объёме дисков.
	storage_size_gb_by_real_usage						int \| float	Объём дисков в ГБ, подсчитанный с использованием реальных данных о занятом пространстве в дисках, для которых есть возможность эти данные получить.
	sep_pools						dict[str, dict[str, float]]	Объём дисков по пулам СХД.
		(идентификатор СХД)					str	Идентификатор пула СХД.
			(название пула)				dict[str, float]	Пул СХД.
				storage_size_gb_by_disk_max			float	Объём дисков в ГБ, подсчитанный с использованием данных о максимальном объёме дисков.
				storage_size_gb_by_real_usage			float	Объём дисков в ГБ, подсчитанный с использованием реальных данных о занятом пространстве в дисках, для которых есть возможность эти данные получить.
	storage_policies						dict[str, dict[str, any]]	Объём дисков по политикам хранения.
		(идентификатор политики хранения)					str	Идентификатор политики хранения.
			storage_size_gb_by_disk_max				float	Объём дисков в ГБ, подсчитанный с использованием данных о максимальном объёме дисков.
			storage_size_gb_by_real_usage				float	Объём дисков в ГБ, подсчитанный с использованием реальных данных о занятом пространстве в дисках, для которых есть возможность эти данные получить.
			storage_size_quota_gb				int \| null	Квота на объём хранилища в ГБ.
			sep_pools				dict[str, dict[str, float]]	Объём дисков по пулам СХД в рамках политики хранения.
				(идентификатор СХД)			str	Идентификатор СХД.
					(название пула)		dict[str, float]	Словарь пула СХД.
						storage_size_gb_by_disk_max	float	Объём дисков в ГБ, подсчитанный с использованием данных о максимальном объёме дисков.
						storage_size_gb_by_real_usage	float	Объём дисков в ГБ, подсчитанный с использованием реальных данных о занятом пространстве в дисках, для которых есть возможность эти данные получить.
reserved							dict[str, any]	Зарезервированные ресурсы. Структура словаря аналогична словарю consumed.

Доступные методы API

Ключ			Тип данных	Описание
api_methods			dict	Словарь, описывающий доступные методы 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

13 KiB Raw Permalink Blame History Unescape Escape