# Модуль decort_account_info ## Обзор модуля Модуль **decort_account_info** предназначен для получения следующей информации об аккаунте: - **основная информация** (см. [возвращаемые значения](#основная-информация) и [примеры](#получение-основной-информации-об-аккаунте)) - **используемые и зарезервированные ресурсы** (см. [параметр resource_consumption](#resource_consumption), [возвращаемые значения](#используемые-и-зарезервированные-ресурсы) и [примеры](#получение-информации-об-используемых-и-зарезервированных-ресурсах-аккаунта)) - **ресурсные группы** (см. [параметр resource_groups](#resource_groups), [возвращаемые значения](#ресурсные-группы) и [примеры](#получение-информации-о-ресурсных-группах)) - **виртуальные машины** (см. [параметр computes](#computes), [возвращаемые значения](#виртуальные-машины) и [примеры](#получение-информации-о-виртуальных-машинах)) - **внутренние сети** (см. [параметр vinses](#vinses), [возвращаемые значения](#внутренние-сети) и [примеры](#получение-информации-о-внутренних-сетях)) - **диски** (см. [параметр disks](#disks), [возвращаемые значения](#диски) и [примеры](#получение-информации-о-дисках)) - **образы** (см. [параметр images](#param_images), [возвращаемые значения](#образы) и [примеры](#получение-информации-об-образах)) - **группы с плавающим IP-адресом** (см. [параметр flip_groups](#flip_groups), [возвращаемые значения](#группы-с-плавающим-ip-адресом) и [примеры](#получение-информации-о-группах-с-плавающим-ip-адресом)) - **аудиты** (см. [параметр audits](#audits), [возвращаемые значения](#аудиты) и [примеры](#получение-информации-об-аудитах)) ## Параметры модуля Ниже приведен список параметров для модуля **decort_account_info** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)):
Параметр Тип Описание
audits (bool)
Default: false 		Получить информацию об аудитах.
computes (dict) Получить информацию о виртуальных машинах, к которым имеет доступ пользователь, с учётом заданных параметров вывода.
Чтобы получить информацию без использования параметров вывода, необходимо задать пустой словарь {}.
filter (dict) Фильтр.
ext_net_id (int) По идентификатору внешней сети.
ext_net_name (str) По имени внешней сети.
id (int) По идентификатору.
ip (str) По IP-адресу.
name (str) По имени.
rg_id (int) По идентификатору ресурсной группы.
rg_name (str) По имени ресурсной группы.
tech_status (str)
Значения:
BACKUP_RUNNING
BACKUP_STOPPED
DOWN
MIGRATING
PAUSED
PAUSING
SCHEDULED
STARTED
STARTING
STOPPED
STOPPING 		По техническому статусу.
pagination (dict) Постраничный вывод.
number (int)
Default: 1 		Номер страницы.
size (int) Размер страниц.
Обязательный параметр.
sorting (dict) Сортировка.
asc (bool)
Default: true 		Сортировать по возрастанию.
true - по возрастанию.
false - по убыванию.
field (str)
Значения:
cpus
createdBy
createdTime
deletedBy
deletedTime
id
name
ram
registered
rgId
rgName
status
techStatus
totalDisksSize
updatedBy
updatedTime
userManaged
vinsConnected 		Название поля, по которому сортировать.
Обязательный параметр.
disks (dict) Получить информацию о неподключённых дисках, к которым имеет доступ пользователь, с учётом заданных параметров вывода.
Чтобы получить информацию без использования параметров вывода, необходимо задать пустой словарь {}.
filter (dict) Фильтр.
id (int) По идентификатору.
name (str) По имени.
size (int) По объёму.
type (str)
Значения:
B
D 		По типу.
pagination (dict) Постраничный вывод.
number (int)
Default: 1 		Номер страницы.
size (int) Размер страниц.
Обязательный параметр.
sorting (dict) Сортировка.
asc (bool)
Default: true 		Сортировать по возрастанию.
true - по возрастанию.
false - по убыванию.
field (str)
Значения:
id
name
pool
sepId
shareable
sizeMax
type 		Название поля, по которому сортировать.
Обязательный параметр.
flip_groups (dict) Получить информацию о группах с плавающим IP-адресом, к которым имеет доступ пользователь, с учётом заданных параметров вывода.
Чтобы получить информацию без использования параметров вывода, необходимо задать пустой словарь {}.
filter (dict) Фильтр.
ext_net_id (int) По идентификатору внешней сети.
id (int) По идентификатору.
ip (str) По IP-адресу.
name (str) По имени.
vins_id (int) По идентификатору внутренней сети.
vins_name (str) По имени внутренней сети.
pagination (dict) Постраничный вывод.
number (int)
Default: 1 		Номер страницы.
size (int) Размер страниц.
Обязательный параметр.
id (int) Идентификатор целевого аккаунта.
Обязательный параметр, если не задан параметр name.
images (dict) Получить информацию об образах, к которым имеет доступ пользователь, с учётом заданных параметров вывода.
Чтобы получить информацию без использования параметров вывода, необходимо задать пустой словарь {}.
deleted (bool)
Default: false 		Включение в вывод удалённых объектов.
filter (dict) Фильтр.
id (int) По идентификатору.
name (str) По имени.
type (str)
Значения:
cdrom
linux
other
virtual
windows 		По типу.
pagination (dict) Постраничный вывод.
number (int)
Default: 1 		Номер страницы.
size (int) Размер страниц.
Обязательный параметр.
sorting (dict) Сортировка.
asc (bool)
Default: true 		Сортировать по возрастанию.
true - по возрастанию.
false - по убыванию.
field (str)
Значения:
UNCPath
desc
id
name
public
size
status
type
username 		Название поля, по которому сортировать.
Обязательный параметр.
name (str) Имя целевого аккаунта.
Может быть альтернативой параметру id, за исключением случая, когда необходимо получить информацию о безвозвратно удалённом объекте.
resource_groups (dict) Получить информацию о ресурсных группах, к которым имеет доступ пользователь, с учётом заданных параметров вывода.
Чтобы получить информацию без использования параметров вывода, необходимо задать пустой словарь {}.
filter (dict) Фильтр.
id (int) По идентификатору.
name (str) По имени.
status (str)
Значения:
CREATED
DELETED
DELETING
DESTROYED
DESTROYING
DISABLED
DISABLING
ENABLED
ENABLING
MODELED
RESTORING 		По статусу.
vins_id (int) По идентификатору внутренней сети.
vm_id (int) По идентификатору виртуальной машины.
pagination (dict) Постраничный вывод.
number (int)
Default: 1 		Номер страницы.
size (int) Размер страниц.
Обязательный параметр.
sorting (dict) Сортировка.
asc (bool)
Default: true 		Сортировать по возрастанию.
true - по возрастанию.
false - по убыванию.
field (str)
Значения:
createdBy
createdTime
deletedBy
deletedTime
id
milestones
name
status
updatedBy
updatedTime
vinses 		Название поля, по которому сортировать.
Обязательный параметр.
resource_consumption (bool)
Default: false 		Получить информацию об используемых и зарезервированных ресурсах.
vinses (dict) Получить информацию о внутренних сетях, к которым имеет доступ пользователь, с учётом заданных параметров вывода.
Чтобы получить информацию без использования параметров вывода, необходимо задать пустой словарь {}.
filter (dict) Фильтр.
ext_ip (int) По внешнему IP-адресу.
id (int) По идентификатору.
name (str) По имени.
rg_id (int) По идентификатору ресурсной группы.
pagination (dict) Постраничный вывод.
number (int)
Default: 1 		Номер страницы.
size (int) Размер страниц.
Обязательный параметр.
sorting (dict) Сортировка.
asc (bool)
Default: true 		Сортировать по возрастанию.
true - по возрастанию.
false - по убыванию.
field (str)
Значения:
computes
createdBy
createdTime
deletedBy
deletedTime
externalIP
extnetId
freeIPs
id
name
network
priVnfDevId
rgId
rgName
status
updatedBy
updatedTime 		Название поля, по которому сортировать.
Обязательный параметр.
## Возвращаемые значения Модуль **decort_account_info** возвращает информацию об аккаунте в виде словаря `facts` со следующими ключами: ### Основная информация
Ключ Тип
данных 		Описание
acl list Список словарей, описывающих доступы пользователей.
canBeDeleted bool Может ли быть удалён.
explicit bool Видимость аккаунта.
right str Права.
status str Статус.
type str Тип.
userGroupId str Идентификатор пользователя или группы пользователей.
company str Название компании.
companyurl str URL компании.
computeFeatures list Список дополнительных возможностей гипервизора, доступных ВМ.
computes_amount dict Количество ВМ по состоянию.
started int Количество запущенных ВМ.
stopped int Количество остановленных ВМ.
cpu_allocation_parameter str Режим выделения ЦП.
cpu_allocation_ratio str Коэффициент для режима выделения ЦП.
createdBy str Идентификатор пользователя, который создал.
createdTime int Unix-время создания.
createdTime_readable str Дата и время создания.
deactivationTime int Unix-время выключения.
deactivationTime_readable str Дата и время выключения.
deletedBy str Идентификатор пользователя, который удалил.
deletedTime int Unix-время удаления.
deletedTime_readable str Дата и время удаления.
displayname str Отображаемое имя.
id int Идентификатор.
name str Имя.
resourceLimits dict Квоты на ресурсы.
CU_C int Количество виртуальных процессоров.
CU_D int Объём диска в ГБ.
CU_DM int Объём дисков в ГБ.
CU_I int Количество внешних IP-адресов.
CU_M float Объём оперативной памяти в МБ.
CU_NP int Объём трафика внешних сетей.
gpu_units int Количество графических процессоров.
sendAccessEmails bool Отправка пользователям на эл. почту уведомлений о предоставлении доступа.
status str Статус.
uniqPools list Список доступных пулов СХД.
updatedTime int Unix-время обновления.
updatedTime_readable str Дата и время обновления.
vins list Список идентификаторов внутренних сетей на уровне аккаунта.
vinses_amount int Количество внутренних сетей.
### Используемые и зарезервированные ресурсы
Ключ Тип
данных 		Описание
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 .
### Ресурсные группы
Ключ Тип
данных 		Описание
resource_groups list Список словарей, описывающих ресурсные группы.
Computes dict Количество ВМ по состоянию.
Started int Количество запущенных ВМ.
Stopped int Количество остановленных ВМ.
Resources dict Используемые и зарезервированные ресурсы.
Consumed dict Используемые ресурсы.
Структура словаря аналогична словарю resource_consumed .
Limits dict Квоты на ресурсы.
cpu int Количество виртуальных процессоров.
disksize int Объём дисков в ГБ.
disksizemax int Объём диска в ГБ.
extips int Количество внешних IP-адресов.
exttraffic int Объём трафика внешних сетей.
gpu int Количество графических процессоров.
ram float Объём оперативной памяти в МБ.
Reserved dict Зарезервированные ресурсы.
Структура словаря аналогична словарю resource_consumed .
createdBy str Идентификатор пользователя, который создал.
createdTime int Unix-время создания.
createdTime_readable str Дата и время создания.
deletedBy str Идентификатор пользователя, который удалил.
deletedTime int Unix-время удаления.
deletedTime_readable str Дата и время удаления.
id int Идентификатор.
milestones int Количество событий.
name str Имя.
status str Статус.
updatedBy str Идентификатор пользователя, который обновил.
updatedTime int Unix-время обновления.
updatedTime_readable str Дата и время обновления.
vinses int Количество внутренних сетей.
### Виртуальные машины
Ключ Тип
данных 		Описание
computes list Список словарей, описывающих виртуальные машины.
accountId int Идентификатор аккаунта.
accountName str Имя аккаунта.
cpus int Количество виртуальных процессоров.
createdBy str Идентификатор пользователя, который создал.
createdTime int Unix-время создания.
createdTime_readable str Дата и время создания.
deletedBy str Идентификатор пользователя, который удалил.
deletedTime int Unix-время удаления.
deletedTime_readable str Дата и время удаления.
id int Идентификатор.
name str Имя.
ram int Объём оперативной памяти в МБ.
registered bool Зарегистрирована ли ВМ как используемая.
rgId int Идентификатор ресурсной группы.
rgName str Имя ресурсной группы.
status str Статус.
techStatus str Технический статус.
totalDisksSize int Общий объём дисков.
updatedBy str Идентификатор пользователя, который обновил.
updatedTime int Unix-время обновления.
updatedTime_readable str Дата и время обновления.
vinsConnected int Количество подключенных внутренних сетей.
### Внутренние сети
Ключ Тип
данных 		Описание
vinses list Список словарей, описывающих внутренние сети.
accountId int Идентификатор аккаунта.
accountName str Имя аккаунта.
computes int Количество виртуальных машин.
createdBy str Идентификатор пользователя, который создал.
createdTime int Unix-время создания.
createdTime_readable str Дата и время создания.
deletedBy str Идентификатор пользователя, который удалил.
deletedTime int Unix-время удаления.
deletedTime_readable str Дата и время удаления.
externalIP str Внешний IP-адрес.
extnetId int Идентификатор внешней сети.
freeIPs int Количество свободных IP-адресов.
id int Идентификатор.
name str Имя.
network str Адрес сети.
priVnfDevId int Идентификатор виртуального маршрутизатора.
rgId int Идентификатор ресурсной группы.
rgName str Имя ресурсной группы.
status str Статус.
updatedBy str Идентификатор пользователя, который обновил.
updatedTime int Unix-время обновления.
updatedTime_readable str Дата и время обновления.
### Диски
Ключ Тип
данных 		Описание
disks list Список словарей, описывающих диски.
id int Идентификатор.
name str Имя.
pool str Пул СХД.
sepId int Идентификатор СХД.
shareable bool Общий доступ.
sizeMax int Объём.
type str Тип.
### Образы
Ключ Тип
данных 		Описание
images list Список словарей, описывающих образы.
UNCPath str Путь к файлу.
desc str Описание.
id int Идентификатор.
name str Имя.
public bool Общий доступ.
size int Размер в ГБ.
status str Статус.
type str Тип.
username str Имя пользователя.
### Группы с плавающим IP-адресом
Ключ Тип
данных 		Описание
flip_groups list Список словарей, описывающих группы с плавающим IP-адресом.
clientType str Тип клиентов.
connType str Тип соединения.
createdBy str Идентификатор пользователя, который создал.
createdTime int Unix-время создания.
createdTime_readable str Дата и время создания.
deletedBy str Идентификатор пользователя, который удалил.
deletedTime int Unix-время удаления.
deletedTime_readable str Дата и время удаления.
desc str Описание.
gid int Идентификатор ЦОД.
id int Идентификатор.
ip str IP-адрес.
milestones int Количество событий.
name str Имя.
netId int Идентификатор сети.
netType str Тип сети.
netmask int Маска подсети (длина префикса).
status str Статус.
updatedBy str Идентификатор пользователя, который обновил.
updatedTime int Unix-время обновления.
updatedTime_readable str Дата и время обновления.
### Аудиты
Ключ Тип
данных 		Описание
audits list Список словарей, описывающих аудиты.
call str Метод API.
responsetime float Время отклика в секундах.
statuscode int Код ответа.
timestamp float Unix-время.
timestamp_readable str Дата и время.
user str Идентификатор пользователя.
## Примеры использования ### Получение основной информации об аккаунте #### По идентификатору ``` - name: Example hosts: localhost tasks: - name: Get basic account info by ID decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" ``` #### По имени ``` - name: Example hosts: localhost tasks: - name: Get basic account info by name decort_account_info: # Параметры для авторизации упущены name: "{{ account_name }}" ``` ### Получение информации об используемых и зарезервированных ресурсах аккаунта ``` - name: Example hosts: localhost tasks: - name: Get account info with resource consumption decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" resource_consumption: true ``` ### Получение информации о ресурсных группах #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get account info with resource groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" resource_groups: {} ``` #### С фильтрацией по статусу ``` - name: Example hosts: localhost tasks: - name: Get account info with resource groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" resource_groups: filter: status: CREATED ``` #### С сортировкой по имени ``` - name: Example hosts: localhost tasks: - name: Get account info with resource groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" resource_groups: sorting: field: name ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get account info with resource groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" resource_groups: pagination: size: 2 ``` ### Получение информации о виртуальных машинах #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get account info with computes decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" computes: {} ``` #### С фильтрацией по IP-адресу ``` - name: Example hosts: localhost tasks: - name: Get account info with computes decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" computes: filter: ip: 192.168.1.2 ``` #### С сортировкой по имени ``` - name: Example hosts: localhost tasks: - name: Get account info with computes decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" computes: sorting: field: name ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get account info with computes decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" computes: pagination: size: 2 ``` ### Получение информации о внутренних сетях #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get account info with vinses decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" vinses: {} ``` #### С фильтрацией по идентификатору ресурсной группы ``` - name: Example hosts: localhost tasks: - name: Get account info with vinses decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" vinses: filter: rg_id: "{{ rg_id }}" ``` #### С сортировкой по времени создания ``` - name: Example hosts: localhost tasks: - name: Get account info with vinses decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" vinses: sorting: field: createdTime ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get account info with vinses decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" vinses: pagination: size: 2 ``` ### Получение информации о дисках #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get account info with disks decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" disks: {} ``` #### С фильтрацией по типу ``` - name: Example hosts: localhost tasks: - name: Get account info with disks decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" disks: filter: type: D ``` #### С сортировкой по объёму ``` - name: Example hosts: localhost tasks: - name: Get account info with disks decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" disks: sorting: field: sizeMax ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get account info with disks decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" disks: pagination: size: 2 ``` ### Получение информации об образах #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get account info with images decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" images: {} ``` #### С включение в вывод удаленных ``` - name: Example hosts: localhost tasks: - name: Get account info with images decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" images: deleted: true ``` #### С фильтрацией по типу ``` - name: Example hosts: localhost tasks: - name: Get account info with images decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" images: filter: type: linux ``` #### С сортировкой по статусу ``` - name: Example hosts: localhost tasks: - name: Get account info with images decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" images: sorting: field: status ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get account info with images decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" images: pagination: size: 2 ``` ### Получение информации о группах с плавающим IP-адресом #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get account info with flip groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" flip_groups: {} ``` #### С фильтрацией по IP-адресу ``` - name: Example hosts: localhost tasks: - name: Get account info with flip groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" flip_groups: filter: ip: 192.168.1.5 ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get account info with flip groups decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" flip_groups: pagination: size: 2 ``` ### Получение информации об аудитах ``` - name: Example hosts: localhost tasks: - name: Get account info with audits decort_account_info: # Параметры для авторизации упущены id: "{{ account_id }}" audits: true ```