Management Engine query interface

Download

Query request

Query request supports following logical operations between predicates:

1. And — symbol "&"
2. Or — symbol "|"

The priority of predicates is distributed consistently. The first predicate has higher priority than the last one.

Any predicate is set as expression: <short field name><predicate operator><compared value>

There is a list of short field names (if Short Field contains symbol "%" that means any field):

Short name	Description	Type	Update type
username	Account name	String	Static
TS	Timestamp	Time	Dynamic
ST	Client status	Status	Dynamic
US	Size of the used storage	Size	Dynamic
AP	Active plugins	String	Custom
RP	Most recent restore plugin	String	Custom
B2	Currently effective bandwidth throttle	Numeric	Dynamic
NC	Company name	String	Static
QW	Password	String	Static
EM	E-mail address	String	Custom
DF	Frequency for the dashboards	Bitmask	Custom
DL	Language for the dashboards	String	Custom
AD	Address	String	Custom
ZP	ZIP code	String	Custom
CY	Country	String	Custom
CT	City	String	Custom
PH	Phone number	String	Custom
FX	Fax number	String	Custom
CP	Contract name	String	Static
GN	Group name	String	Static
PN	Product name	String	Static
CD	Contract creation date	Time	Static
ED	Contract expiration date	Time	Static
VN	Version number of the IASO client	String	Custom
OS	Name and version of operating system	String	Custom
IP	List of IP addresses	String	Custom
MN	Computer name	String	Custom
TZ	Time zone offset	String	Custom
Total
T0	Total status	Status	Dynamic
T1	Total number of files in selection	Numeric	Dynamic
T2	Total number of changed files	Numeric	Dynamic
T3	Total selected size	Size	Dynamic
T4	Total processed size	Size	Dynamic
T5	Total sent size	Size	Dynamic
T6	Total protected size	Size	Dynamic
T7	Total number of errors	Numeric	Dynamic
TB	Total color bar — last 28 days	String	Dynamic
TL	Total last successful backup	Time	Dynamic
Files and Folders ("FsBackupPlugin")
F0	Files and Folders status	Status	Dynamic
F1	Files and Folders number of files in selection	Numeric	Dynamic
F2	Files and Folders number of changed files	Numeric	Dynamic
F3	Files and Folders selected size	Size	Dynamic
F4	Files and Folders processed size	Size	Dynamic
F5	Files and Folders sent size	Size	Dynamic
F6	Files and Folders protected size	Size	Dynamic
F7	Files and Folders number of errors	Numeric	Dynamic
F8	Files and Folders number of files in pre recent session	Numeric	Dynamic
F9	Files and Folders selected size in pre recent session	Size	Dynamic
FB	Files and Folders color bar — last 28 days	String	Dynamic
FL	Files and Folders last successful backup	Time	Dynamic
System State ("SystemStateBackupPlugin", "VssSystemStateBackupPlugin")
S0	System State status	Status	Dynamic
S1	System State number of files in selection	Numeric	Dynamic
S2	System State number of changed files	Numeric	Dynamic
S3	System State selected size	Size	Dynamic
S4	System State processed size	Size	Dynamic
S5	System State sent size	Size	Dynamic
S6	System State protected size	Size	Dynamic
S7	System State number of errors	Numeric	Dynamic
S8	System State number of files in pre recent session	Numeric	Dynamic
S9	System State selected size in pre recent session	Size	Dynamic
SB	System State color bar — last 28 days	String	Dynamic
SL	System State last successful backup	Time	Dynamic
MsSql ("MsSqlBackupPlugin")
Q0	MsSql status	Status	Dynamic
Q1	MsSql number of files in selection	Numeric	Dynamic
Q2	MsSql number of changed files	Numeric	Dynamic
Q3	MsSql selected size	Size	Dynamic
Q4	MsSql processed size	Size	Dynamic
Q5	MsSql sent size	Size	Dynamic
Q6	MsSql protected size	Size	Dynamic
Q7	MsSql number of errors	Numeric	Dynamic
Q8	MsSql number of files in pre recent session	Numeric	Dynamic
Q9	MsSql selected size in pre recent session	Size	Dynamic
QB	MsSql color bar — last 28 days	String	Dynamic
QL	MsSql last successful backup	Time	Dynamic
Exchange Stores ("ExchangeBackupPlugin")
X0	Exchange Stores status	Status	Dynamic
X1	Exchange Stores number of files in selection	Numeric	Dynamic
X2	Exchange Stores number of changed files	Numeric	Dynamic
X3	Exchange Stores selected size	Size	Dynamic
X4	Exchange Stores processed size	Size	Dynamic
X5	Exchange Stores sent size	Size	Dynamic
X6	Exchange Stores protected size	Size	Dynamic
X7	Exchange Stores number of errors	Numeric	Dynamic
X8	Exchange Stores number of files in pre recent session	Numeric	Dynamic
X9	Exchange Stores selected size in pre recent session	Size	Dynamic
XB	Exchange Stores color bar — last 28 days	String	Dynamic
XL	Exchange Stores last successful backup	Time	Dynamic
Network Shares ("NetworkSharesBackupPlugin")
N0	Network Shares status	Status	Dynamic
N1	Network Shares number of files in selection	Numeric	Dynamic
N2	Network Shares number of changed files	Numeric	Dynamic
N3	Network Shares selected size	Size	Dynamic
N4	Network Shares processed size	Size	Dynamic
N5	Network Shares sent size	Size	Dynamic
N6	Network Shares protected size	Size	Dynamic
N7	Network Shares number of errors	Numeric	Dynamic
N8	Network Shares number of files in pre recent session	Numeric	Dynamic
N9	Network Shares selected size in pre recent session	Size	Dynamic
NB	Network Shares color bar — last 28 days	String	Dynamic
NL	Network Shares last successful backup	Time	Dynamic
VMware Virtual Machines ("VMWareBackupPlugin")
W0	VMware Virtual Machines status	Status	Dynamic
W1	VMware Virtual Machines number of files in selection	Numeric	Dynamic
W2	VMware Virtual Machines number of changed files	Numeric	Dynamic
W3	VMware Virtual Machines selected size	Size	Dynamic
W4	VMware Virtual Machines processed size	Size	Dynamic
W5	VMware Virtual Machines sent size	Size	Dynamic
W6	VMware Virtual Machines protected size	Size	Dynamic
W7	VMware Virtual Machines number of errors	Numeric	Dynamic
W8	VMware Virtual Machines number of files in pre recent session	Numeric	Dynamic
W9	VMware Virtual Machines selected size in pre recent session	Size	Dynamic
WB	VMware Virtual Machines color bar — last 28 days	String	Dynamic
WI	VMware Virtual Machines licence items count	Numeric	Dynamic
WL	VMware Virtual Machines last successful backup	Time	Dynamic
VSS MsSql ("VssMsSqlBackupPlugin")
Z0	VSS MsSql status	Status	Dynamic
Z1	VSS MsSql number of files in selection	Numeric	Dynamic
Z2	VSS MsSql number of changed files	Numeric	Dynamic
Z3	VSS MsSql selected size	Size	Dynamic
Z4	VSS MsSql processed size	Size	Dynamic
Z5	VSS MsSql sent size	Size	Dynamic
Z6	VSS MsSql protected size	Size	Dynamic
Z7	VSS MsSql number of errors	Numeric	Dynamic
Z8	VSS MsSql number of files in pre recent session	Numeric	Dynamic
Z9	VSS MsSql selected size in pre recent session	Size	Dynamic
ZB	VSS MsSql color bar — last 28 days	String	Dynamic
ZL	VSS MsSql last successful backup	Time	Dynamic

There is a list of supported predicate operators:

1. "<" — means begins
2. "=" — means equal
3. ">" — means ends
4. "*" — means contains

For example:

• GN<iaso-|GN=iaso — means to select records which are assigned to group "iaso" or any child of this group
• username=testuser — means to select record with user name "testuser"
• PN=Server — means to select all records with product "Server"
• %=test — means to select the records where value of any field is equal to "test".

Totals calculator

The following algorithms are already implemented:

1. summ — summarizes values in the field;
2. min — gets minimal value of the field;
3. max — gets maximum value of the field.

Total query is a math expression with numerical terminals and non-terminals. Terminal is a simple numerical value. Non-terminal is expression which is matched expression: <algorithm>(<short field name>).

The table below shows which algorithm is allowed for particular field type:

	String	Numeric	Time	Size	Status	Bitmask
summ	no	yes	no	yes	no	no
min	yes	yes	yes	yes	yes	no
max	yes	yes	yes	yes	yes	no

For example, to calculate average by "Selected size" of all plugins the following expression can be used: (summ(F3) + summ(S3) + summ(Q3) + summ(X3) + summ(N3)) / 6.

Field types

Simple types

There're 6 types of fields you may encounter while querying engine for data:

• String — literal data which could be displayed as is; there's an exception in case of colorbar fields which have String type but don't contain human-readable information
• Numeric — integer number which could be displayed as is
• Time — UNIX timestamp (integral number of seconds passed since January 1st, 1970 till date in question)
• Size — human-readable size value, rounded to KiB, MiB, GiB, TiB etc.
• Status — session status code, presented as string identifier
• Bitmask — integer number with each bit having its own meaning within some common area

Since all the values returned by query are stored in string-typed protobuf fields, knowledge of real field type is vital to ensure correct data processing and formatting.

Color bars

Colorbar field value consists of two parts: array of recent statuses reported by Functional Process and difference (in days) between current date and last report date (a.k.a. offset).

For example, "0777755555000000555555008000 0". Offset is "0" days (which means that Functional Process sent this report to Engine today) and statuses array is "0777755555000000555555008000". Statuses are specified in reverse order, so first status letter ("0") corresponds to status of backup offset days ago, second ("7") — offset + 1 days ago etc. If this value has been returned by Engine on Friday, it would be presented in Console as                              (where brighter colors indicate weekends).

You should never rely on status character to be digit. Neither should you rely on statuses array contain exactly 28 items (length may vary depending on history limit). In case when offset is greater than statuses array size, Console would display all the cells gray since none of reported statuses lie within last <statuses array size> days (from today).

Possible status letters and their corresponding colors (in Console) are the following:

Letter	Color	Status
"0"		Undefined
"1"		In Progress
"2"		Failed
"3"		Aborted
"4"		Limited (obsolete since 11.5)
"5"		Succeeded
"6"		Interrupted
"7"		Not Started
"8"		Succeeded With Faults
"9"		In Progress With Faults
"a"		Over Quota

Download