SnapCenter PowerShell Commands
Get-SmBackupReport
Suggest changes
PDFs
Gets reports about backup operations based on the options you specify.
Syntax
Get-SmBackupReport [-FromDateTime] <DateTime> [-ToDateTime] <DateTime> [-Backup] <String> [-Status] <String> [-Policy] <String> [-ResourceGroup] <String> [-Resource] <String> [-HostName] <String> [-Plugin] <PluginCode> [-BackupId] <Int64> [-JobId] <Int64>
Detailed Description
Gets reports about backup operations based on the options you specify. You can specify whether you want to get details about a specific backup or a summary of all backups performed using a SnapCenter instance. For any integer value provided for date, value is taken as 1/1/0001 12:00 AM.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
FromDateTime |
Specifies that you want to get backup operations reports for backups run between a specified day and time. This option provides the start date and time. You can specify the date and time using any date and time format string. For example, "2/2/2015 8:52PM". If the cmdlet is run from the remote computer, the output will be shown based on the SnapCenter Server time zone. |
false |
false |
|
ToDateTime |
Specifies that you want to get backup operations reports for backups run between a specified day and time. This option provides the end date and time. You can specify the date and time using any date and time format string. For example, "2/2/2015 8:52PM". If the cmdlet is run from the remote computer, the output will be shown based on the SnapCenter Server time zone. |
false |
false |
|
Backup |
Specifies that you want to get a detailed backup report for the given backup. |
false |
true (ByPropertyName) |
|
Status |
Specifies that you want information about backup jobs with a specified status. Valid values are: completed, failed, warning, and canceled. |
false |
true (ByPropertyName) |
|
Policy |
Specifies that you want reports about backup jobs associated with a specified policy. |
false |
true (ByPropertyName) |
|
ResourceGroup |
false |
true (ByPropertyName) |
||
Resource |
Specifies the resource for which you want backup reports. |
false |
true (ByPropertyName) |
|
HostName |
Specifies the name of the host on which the backup was taken. |
false |
true (ByPropertyName) |
|
BackupId |
ID of the backup for which to get a report. |
true |
true (ByPropertyName) |
|
JobId |
ID of the backup job for which to get a report. |
true |
true (ByPropertyName) |
|
Plugin |
Specify the plug-in code to generate the report. For custom plug-ins, specify the custom plug-in name for example, hana, mysql. |
false |
true (ByPropertyName) |
Examples
Example 1: Getting a backup report for a date range
Get-SmBackupReport -FromDateTime "1/29/2015" -ToDateTime "2/3/2015"
This example syntax gets a report on backups from January 29th 2015 to February 3rd, 2015.
SmBackupId : 113 SmJobId : 2032 StartDateTime: 2/2/2015 6:57:03 AM EndDateTime : 2/2/2015 6:57:11 AM Duration : 00:00:07.3060000 CreatedDateTime : 2/2/2015 6:57:23 AM Status : Completed ProtectionGroupName : Clone SmProtectionGroupId : 34 PolicyName : Vault SmPolicyId : 18 BackupName : Clone_SCSPR0019366001_02-02-2015_06.57.08 VerificationStatus : NotVerified PluginCode : SCC PluginName : hana PluginDisplayName: SAP HANA JobHost : R60618C4A79V1 SmBackupId : 114 SmJobId : 2183 StartDateTime: 2/2/2015 1:02:41 PM EndDateTime : 2/2/2015 1:02:38 PM Duration : -00:00:03.2300000 CreatedDateTime : 2/2/2015 1:02:53 PM Status : Completed ProtectionGroupName : Clone SmProtectionGroupId : 34 PolicyName : Vault SmPolicyId : 18 BackupName : Clone_SCSPR0019366001_02-02-2015_13.02.45 VerificationStatus : NotVerified PluginCode : SCO PluginName : Oracle Database PluginDisplayName: Oracle Database JobHost : R60618C4A79V1
Example 2: Getting a backup report for a dataset and status type
Get-SmBackupReport -Status completed -Dataset Secondary
This example syntax gets a report on all backups for dataset "Secondary" that have the "Completed" status.
SmBackupId : 24 SmJobId : 310 StartDateTime: 1/12/2015 8:50:49 AM EndDateTime : 1/12/2015 8:50:48 AM Duration : -00:00:00.6900000 CreatedDateTime : 1/12/2015 8:51:05 AM Status : Completed ProtectionGroupName : Secondary SmProtectionGroupId : 5 PolicyName : Vault SmPolicyId : 18 BackupName : Secondary_SCSPR0019366001_01-12-2015_08.50.49 VerificationStatus : NotVerified PluginCode : SCC PluginName : hana PluginDisplayName: SAP HANA JobHost : R60618C4A79V1 SmBackupId : 52 SmJobId : 585 StartDateTime: 1/15/2015 6:49:07 AM EndDateTime : 1/15/2015 6:49:21 AM Duration : 00:00:13.8370000 CreatedDateTime : 1/15/2015 6:49:18 AM Status : Completed ProtectionGroupName : Secondary SmProtectionGroupId : 5 PolicyName : Vault SmPolicyId : 18 BackupName : Secondary_SCSPR0019366001_01-15-2015_06.49.08 VerificationStatus : NotVerified PluginCode : SCO PluginName : Oracle Database PluginDisplayName: Oracle Database JobHost : R60618C4A79V1
Example 3: Getting a detailed backup report
Get-SmBackupReport -BackupName Secondary_SCSPR0019366001_01-15-2015_06.49.08
Get a detailed backup for the backup "Secondary_SCSPR0019366001_01-15-2015_06.49.08".
BackedUpObjects : {TestDB1, TestDB2, TestDB3, TestDB4...}
FailedObjects: {}
BackupType : Full Backup
IsScheduled : False
SmBackupId : 52
SmJobId : 585
StartDateTime: 1/15/2015 6:49:07 AM
EndDateTime : 1/15/2015 6:49:21 AM
Duration : 00:00:13.8370000
CreatedDateTime : 1/15/2015 6:49:18 AM
Status : Completed
ProtectionGroupName : Secondary
SmProtectionGroupId : 5
PolicyName : Vault
SmPolicyId : 18
BackupName : Secondary_SCSPR0019366001_01-15-2015_06.49.08
VerificationStatus : NotVerified
PluginCode : SCO
PluginName : Oracle Database
PluginDisplayName: Oracle Database
JobHost : R60618C4A79V1