get_reports_protection_summary
Alberto Gonzalez edited this page Oct 29, 2015
·
1 revision
Returns a protection summary for all clients and vms (and in the future, applications) on the system. For VMs, includes a list of both protected and unprotected VMs. For each instance, the protection method (backup, replication, archiving) is returned.
GET /api/reports/protection_summary/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>
Optional filters are as described in the overall reports API, here.
200 success
The data array properties are as follows:
| Index | Value | Type | Returned |
|---|---|---|---|
| protected_assets | count of assets that have a backup in the given time-frame | long | always |
| unprotected_assets | count of assets that do not have a backup in the given time-frame | long | always |
| assets_protected_by_backup_copy | count of assets that have a backup copy in the given time-frame | long | always |
| assets_not_protected_by_backup_copy | count of assets that do not have a backup copy in the given time-frame | long | always |
| assets | array of assets that are registered to the system | array | always |
| backups | information about backups over the given time-frame | array | always |
| backup_copies | information about backup copies over the given time-frame | array | always |
*** NDMP and Cisco UCS information is not returned in this phase of the API.
The assets sub-array includes:
| Index | Value | Type | Returned |
|---|---|---|---|
| system_name | system name | string | always |
| client_name | client name | string | always |
| instance_name | instance_name | string | always (may be an empty string) |
| asset_type | type of asset | string | always |
| protected | whether or not a backup occurred for this instance during the given time-frame | boolean | always |
| protected_by_backup_copy | whether or not a backup copy occurred to this target for this instance during the given time-frame | boolean | always |
| last_backup | formatted start date of last backup | string | only if a backup occurred for this instance during the given time-frame |
| last_backup_copy_<target_name> | formatted start date of last backup copy to the target named <target_name> | string | only if a backup copy occurred to this target for this instance during the given time-frame |
The backups sub-array includes:
| Index | Value | Type | Returned |
|---|---|---|---|
| successes | the number of successful backups during the given time-frame | long | always |
| warnings | the number of backups that had warnings during the given time-frame | long | always |
| failures | the number of failed backups during the given time-frame | long | always |
| assets | array of assets that had a backup in the given time-frame | array | always (may be empty) |
The assets sub-array of the backups sub-array includes:
| Index | Value | Type | Returned |
|---|---|---|---|
| system_name | system name | string | always |
| client_name | client name | string | always |
| instance_name | instance_name | string | always (may be an empty string) |
| asset_type | type of asset | string | always |
| backup_types | types of successful backups during the given time-frame for that asset | array | always (may be empty) |
| successes | the number of successful backups during the given time-frame for that asset | long | always |
| warnings | the number of backups that had warnings during the given time-frame for that asset | long | always |
| failures | the number of failed backups during the given time-frame for that asset | long | always |
| last_backup | formatted start date of the last backup for that asset | string | only if a backup was succesful for this instance during the given time-frame |
| next_backup | formatted start date of the next scheduled backup for that asset | string | only if a backup is scheduled for this asset and no 'end_date' is specified |
| next_backup_joborder | name of the joborder for the next backup for that asset | string | only if a backup is scheduled for this asset and no 'end_date' is specified |
The backup_copies sub-array includes:
| Index | Value | Type | Returned |
|---|---|---|---|
| successes | the number of successful backup copies during the given time-frame | long | always |
| failures | the number of failed backup copies during the given time-frame | long | always |
| assets | array of backup targets that have assets coping to them over the time-frame | array | always (may be empty) |
The assets sub-array of the backup_copies sub-array includes:
| Index | Value | Type | Returned |
|---|---|---|---|
| successes | the number of successful backup copies to that target during the given time-frame | long | always |
| failures | the number of failed backup copies to that target during the given time-frame | long | always |
| target | name of the backup copy target | string | always |
| assets | array of assets that had a backup copy in the given time-frame | array | always (may be empty) |
The assets sub-array of the assets sub-array of the backup_copies sub-array includes:
| Index | Value | Type | Returned |
|---|---|---|---|
| system_name | system name | string | always |
| client_name | client name | string | always |
| instance_name | instance_name | string | always (may be an empty string) |
| asset_type | type of asset | string | always |
| backup_copy_types | types of successful backup copies to that target during the given time-frame for that asset | array | always (may be empty) |
| backup_copy_successes | the number of successful backups to that target during the given time-frame for that asset | long | always |
| backup_copy_failures | the number of failed backups to that target during the given time-frame for that asset | long | always |
| last_backup_copy | formatted start date of the last backup copy to that target for that asset | string | only if a backup was successful for this asset to that target during the given time-frame |
| next_backup_copy_to_<target_name> | formatted start date of the next scheduled backup copy to <target_name> for that asset | string | only if a backup is scheduled to <target_name> for this asset and no 'end_date' is specified |
| next_backup_copy_to_<target_name>_joborder | name of the joborder for the next backup copy to <target_name> for that asset | string | only if a backup copy joborder exists to <target_name> for this asset and no 'end_date' is specified |
GET /api/reports/protection_summary/start_date=09/05/2014
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324
{
"count": 136,
"total": 136,
"start": 1,
"data": {
"protected_assets": 9,
"unprotected_assets": 127,
"assets_protected_by_backup_copy": 7,
"assets_not_protected_by_backup_copy": 129,
"assets": [
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "win7-lmc",
"asset_type": "VMware",
"protected": false,
"protected_by_backup_copy": false
},
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "UVBA-lmc-190",
"asset_type": "VMware",
"protected": false,
"protected_by_backup_copy": false
},
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "Sanket_Ubuntu_UVB-RDR",
"asset_type": "VMware",
"protected": false,
"protected_by_backup_copy": false
},
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "UVB_PlugIn_ljh",
"asset_type": "VMware",
"protected": false,
"protected_by_backup_copy": false
},
<too many records to display>
{
"system_name": "re943",
"client_name": "win7",
"instance_name": "",
"asset_type": "Windows 2003",
"protected": true,
"protected_by_backup_copy": false,
"last_backup": "Aug 26, 2015 5:00 am"
}
],
"backups": {
"successes": 309,
"warnings": 2,
"failures": 46,
"assets": [
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "HotLink DR Express",
"asset_type": "VMware",
"backup_types": [
"Full"
],
"successes": 1,
"warnings": 0,
"failures": 16,
"last_backup": "Aug 23, 2015 3:00 am"
},
{
"system_name": "myUEB11",
"client_name": "win2016",
"instance_name": "",
"asset_type": "Windows 2003",
"backup_types": [
"Full",
"Selective"
],
"successes": 9,
"warnings": 0,
"failures": 1,
"last_backup": "Aug 30, 2015 10:10 pm",
"next_backup": "Sep 6, 2015 9:10 pm",
"next_backup_joborder": "win2016 job"
},
{
"system_name": "myUEB11",
"client_name": "win20122",
"instance_name": "",
"asset_type": "Windows 2012 R2",
"backup_types": [
"Differential"
],
"successes": 1,
"warnings": 1,
"failures": 9,
"last_backup": "Aug 23, 2015 1:28 pm",
"next_backup": "Sep 6, 2015 12:00 am",
"next_backup_joborder": "Backup Physical Server Job"
},
{
"system_name": "myUEB11",
"client_name": "win20122",
"instance_name": "casoft-ueb-72",
"asset_type": "Hyper-V",
"backup_types": [],
"successes": 0,
"warnings": 0,
"failures": 0,
"next_backup": "Sep 1, 2015 9:00 am",
"next_backup_joborder": "Backup Job--hv"
},
{
"system_name": "myUEB11",
"client_name": "test-nas-34-NAS-RRC",
"instance_name": "",
"asset_type": "Linux",
"backup_types": [
"Full"
],
"successes": 3,
"warnings": 0,
"failures": 0,
"last_backup": "Aug 31, 2015 5:00 am",
"next_backup": "Sep 6, 2015 5:00 am",
"next_backup_joborder": "Backup NAS Job-test-change"
},
{
"system_name": "myUEB11",
"client_name": "aix",
"instance_name": "",
"asset_type": "AIX",
"backup_types": [],
"successes": 0,
"warnings": 0,
"failures": 0,
"next_backup": "Sep 6, 2015 5:00 am",
"next_backup_joborder": "aix job"
},
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "AWS Connector 2.0.0",
"asset_type": "VMware",
"backup_types": [
"Full",
"Incremental"
],
"successes": 57,
"warnings": 0,
"failures": 0,
"last_backup": "Aug 31, 2015 3:00 am",
"next_backup": "Sep 1, 2015 3:00 am",
"next_backup_joborder": "Backup Job - 2 VMs - Test2"
},
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "AwakeOrAsleep?1MB_restore",
"asset_type": "VMware",
"backup_types": [
"Full",
"Incremental"
],
"successes": 82,
"warnings": 0,
"failures": 0,
"last_backup": "Aug 20, 2015 3:00 am"
},
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "AWS Connector 2.0.0_restore_synth_test",
"asset_type": "VMware",
"backup_types": [
"Full",
"Incremental"
],
"successes": 50,
"warnings": 0,
"failures": 0,
"last_backup": "Aug 27, 2015 2:05 pm"
},
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "2Small2Furious-2MB_restore",
"asset_type": "VMware",
"backup_types": [
"Full",
"Incremental"
],
"successes": 103,
"warnings": 0,
"failures": 0,
"last_backup": "Aug 31, 2015 3:00 am",
"next_backup": "Sep 1, 2015 3:00 am",
"next_backup_joborder": "Backup Job - 2 VMs - Test2"
},
{
"system_name": "re943",
"client_name": "win7",
"instance_name": "",
"asset_type": "Windows 2003",
"backup_types": [
"Full",
"Incremental"
],
"successes": 3,
"warnings": 0,
"failures": 0,
"last_backup": "Aug 26, 2015 5:00 am"
}
]
},
"backup_copies": {
"successes": 68,
"failures": 0,
"assets": {
"backup_copies_to_UEB-Calsoft-240-target": {
"successes": 5,
"failures": 0,
"target": "UEB-Calsoft-240-target",
"assets": [
{
"system_name": "myUEB11",
"client_name": "win2016",
"instance_name": "",
"asset_type": "Windows 2003",
"backup_copy_types": [
"Full"
],
"backup_copy_successes": 2,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 30, 2015 11:47 pm",
"next_backup_copy_to_UEB-Calsoft-240-target_joborder": "Backup Copy Job-Repl"
},
{
"system_name": "myUEB11",
"client_name": "win20122",
"instance_name": "",
"asset_type": "Windows 2012 R2",
"backup_copy_types": [
"Full",
"Differential"
],
"backup_copy_successes": 2,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 23, 2015 1:34 pm",
"next_backup_copy_to_UEB-Calsoft-240-target_joborder": "Backup Copy Job-Repl"
},
{
"system_name": "myUEB11",
"client_name": "test-nas-34-NAS-RRC",
"instance_name": "",
"asset_type": "Linux",
"backup_copy_types": [
"Full"
],
"backup_copy_successes": 1,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 30, 2015 6:12 am",
"next_backup_copy_to_UEB-Calsoft-240-target_joborder": "Backup Copy Job-Repl"
}
]
},
"backup_copies_to_AWS_Storage": {
"successes": 2,
"failures": 0,
"target": "AWS_Storage",
"assets": [
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "HotLink Synchronizer",
"asset_type": "VMware",
"backup_copy_types": [
"Full"
],
"backup_copy_successes": 1,
"backup_copy_failures": 0,
"last_backup_copy": "May 5, 2015 3:01 am"
},
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "AWS Connector 2.0.0",
"asset_type": "VMware",
"backup_copy_types": [
"Full"
],
"backup_copy_successes": 1,
"backup_copy_failures": 0,
"last_backup_copy": "May 5, 2015 3:01 am"
}
]
},
"backup_copies_to_s3-target": {
"successes": 5,
"failures": 0,
"target": "s3-target",
"assets": [
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "BoltVTA",
"asset_type": "VMware",
"backup_copy_types": [],
"backup_copy_successes": 0,
"backup_copy_failures": 0,
"next_backup_copy_to_s3-target": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_s3-target_joborder": "Bolt-VTA-Copy-Job"
},
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "2Small2Furious-2MB_restore",
"asset_type": "VMware",
"backup_copy_types": [],
"backup_copy_successes": 0,
"backup_copy_failures": 0,
"next_backup_copy_to_s3-target": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_s3-target_joborder": "copy job - clients and instances"
},
{
"system_name": "myUEB11",
"client_name": "win2016",
"instance_name": "",
"asset_type": "Windows 2003",
"backup_copy_types": [
"Full",
"Selective"
],
"backup_copy_successes": 2,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 31, 2015 3:05 am",
"next_backup_copy_to_s3-target": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_s3-target_joborder": "copy job - clients and instances"
},
{
"system_name": "myUEB11",
"client_name": "win20122",
"instance_name": "",
"asset_type": "Windows 2012 R2",
"backup_copy_types": [
"Full",
"Differential"
],
"backup_copy_successes": 2,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 31, 2015 3:05 am",
"next_backup_copy_to_s3-target": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_s3-target_joborder": "copy job - clients and instances"
},
{
"system_name": "myUEB11",
"client_name": "test-nas-34-NAS-RRC",
"instance_name": "",
"asset_type": "Linux",
"backup_copy_types": [
"Full"
],
"backup_copy_successes": 1,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 31, 2015 3:05 am",
"next_backup_copy_to_s3-target": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_s3-target_joborder": "copy job - clients and instances"
}
]
},
"backup_copies_to_ASHUarchive": {
"successes": 0,
"failures": 0,
"target": "ASHUarchive",
"assets": [
{
"system_name": "myUEB11",
"client_name": "win20122",
"instance_name": "rhel-73",
"asset_type": "Hyper-V",
"backup_copy_types": [],
"backup_copy_successes": 0,
"backup_copy_failures": 0,
"next_backup_copy_to_ASHUarchive": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_ASHUarchive_joborder": "Backup Copy Job-rhel73"
}
]
},
"backup_copies_to_Attached-Archives": {
"successes": 0,
"failures": 0,
"target": "Attached-Archives",
"assets": [
{
"system_name": "myUEB11",
"client_name": "vCenter-lmc",
"instance_name": "win7-lmc",
"asset_type": "VMware",
"backup_copy_types": [],
"backup_copy_successes": 0,
"backup_copy_failures": 0,
"next_backup_copy_to_Attached-Archives": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_Attached-Archives_joborder": "Backup Copy Job-win7"
}
]
},
"backup_copies_to_LAL-Test1": {
"successes": 27,
"failures": 0,
"target": "LAL-Test1",
"assets": [
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "AWS Connector 2.0.0",
"asset_type": "VMware",
"backup_copy_types": [
"Full",
"Incremental"
],
"backup_copy_successes": 27,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 31, 2015 3:02 am"
}
]
},
"backup_copies_to_Recovery Archive": {
"successes": 29,
"failures": 0,
"target": "Recovery Archive",
"assets": [
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "AWS Connector 2.0.0_restore_synth_test",
"asset_type": "VMware",
"backup_copy_types": [
"Full",
"Incremental"
],
"backup_copy_successes": 29,
"backup_copy_failures": 0,
"last_backup_copy": "Aug 6, 2015 3:02 am"
},
{
"system_name": "re943",
"client_name": "vCenter-lmc",
"instance_name": "2Small2Furious-2MB_restore",
"asset_type": "VMware",
"backup_copy_types": [],
"backup_copy_successes": 0,
"backup_copy_failures": 0,
"next_backup_copy_to_Recovery Archive": "Sep 1, 2015 3:00 am",
"next_backup_copy_to_Recovery Archive_joborder": "Backup Copy Job-recovery-archive"
}
]
}
}
}
},
"timestamp": 1441069432
}