List Backup & Recovery Sessions

Service name: list_mob_sessions

https://SERVER/api/?apikey=yourAPIkey&service=list_mob_sessions

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Lists all Backup & Recovery - previously known as Managed Online Backup - (MOB) sessions for a device.

Note: Backups are recorded in batches after the whole batch finishes; once recorded the information about all backup sessions is available for the lifespan of the device, whilst Backup & Recovery remains enabled.

Please be aware that the backup values stated in this API call are in Bytes. If you require this information in Megabyte, divide the backup values by 1048576 (or backup value/1024/1024) and for Gigabytes divide the backup values by 1073741824 (or backup value/1024/1024/1024).

Parameters

Default

0

0

Example Service Call =list_mob_sessions

https://SERVER/api/?apikey=yourAPIkey&service=list_mob_sessions&deviceid=DEVICEID

Example Response

<example>

<result created="2013-10-11T14:55:41+01:00" host="SERVER" status="OK">

<session>

<session_id>12345[unique id for the backup session]</session_id>

<type>[one of: BACKUP, RESTORE]</type>

<storage_account_id>139[id of the storage account used for storing this backup]</storage_account_id>

<plugin>[one of: FILE_SYSTEM, SYSTEM_STATE, EXCHANGE, NETWORK_SHARES, VMWARE, MSSQL, SHAREPOINT, ORACLE]</plugin>

<start>2013-03-17 00:06:57[start time, UTC]</start>

<end>2013-03-17 00:07:23[end time, UTC]</end>

<selection_size>132579334528[size in bytes of all data included in this backup]</selection_size>

<selection_item_count>22[number of items included in this backup]</selection_item_count>

<size_change>843776[difference (in bytes) between this selection and the previous (using this plugin) selection; note there is no indiciation of bigger or smaller]</size_change>

<item_count_change>2[absolute difference in the number of items included in this backup versus previous backup (using this plugin)]</item_count_change>

<removed_item_count>0[number of items removed from backup storage as a result of this backup]</removed_item_count>

<processed_size>132579334528[amount (in bytes) of data processed]</processed_size>

<processed_item_count>22[number of items processed]</processed_item_count>

<transferred_size>955045456[amount (in bytes) of data transferred]</transferred_size>

<error_count>0[number of errors which occurred during this backup; no further information is available]</error_count>

<status>[one of: COMPLETED, INTERRUPTED, COMPLETED_WITH_ERRORS, FAILED, NOT_STARTED, CANCELED]</status>

</session>

[...more session entries if they exist...]

</result>

</example>

Field Description

A mob_sessions element containing zero or more entries (session elements in XML), each session having:

description

unique id for the backup session

BACKUP

RESTORE

id of the storage account used for storing this backup

FILE_SYSTEM

SYSTEM_STATE

EXCHANGE

NETWORK_SHARES

VMWARE

MSSQL

SHAREPOINT

ORACLE

start time, UTC

end time, UTC

size in bytes of all data included in this backup

number of items included in this backup

difference (in bytes) between this selection and the previous (using this plugin) selection; note there is no indication of bigger or smaller

absolute difference in the number of items included in this backup versus previous backup (using this plugin)

number of items removed from backup storage as a result of this backup

amount (in bytes) of data processed

number of items processed

amount (in bytes) of data transferred

number of errors which occurred during this backup; no further information is available

COMPLETED

INTERRUPTED

COMPLETED_WITH_ERRORS

FAILED

NOT_STARTED

CANCELED

https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=server

https://SERVER/api/?apikey=yourAPIkey&service=list_servers&siteid=SITEID

https://SERVER/api/?apikey=yourAPIkey&service=list_workstations&siteid=SITEID