Get-SmBackup
Suggest changes
PDFs
Gets information about one or more backups.
Syntax
Get-SmBackup [-BackupName] <String> [-BackupId] <String> [-AppObjectName] <String> [-AppObjectId] <String> [-Secondary] <> [-CloudProtected] <> [-Details] <>
Detailed Description
Gets information about one or more backups. You can specify whether to include information about secondary backups.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
BackupName |
Specifies the name of the backup about which you want to retrieve information. |
false |
true (ByPropertyName) |
|
BackupId |
Specifies the ID of the backup about which you want to get information. |
false |
true (ByPropertyName) |
|
AppObjectName |
Specifies the name of the application object. |
false |
true (ByPropertyName) |
|
AppObjectId |
Specifies the ID of the application object. |
false |
true (ByPropertyName) |
|
Secondary |
Specifies whether to list only the secondary backups. |
false |
true (ByPropertyName) |
|
CloudProtected |
Specifies whether to list only the cloud backups. |
false |
true (ByPropertyName) |
|
Details |
false |
true (ByPropertyName) |
Examples
Example 1: Getting information about all backups
Get-SmBackup
This example syntax gets information about all available backups.
BackupId BackupName BackupTime BackupType
-------- ---------- ---------- ----------
1 Payroll Dataset_vise-f6_08… 8/4/2015 11:02:32 AM Full Backup
2 Payroll Dataset_vise-f6_08… 8/4/2015 11:23:17 AM
Example 2: Getting information about secondary backups
Get-SmBackup -Secondary
This example syntax gets information about only secondary backups.
BackupId BackupName BackupTime BackupType
-------- ---------- ---------- ----------
1 Payroll Dataset_vise-f6_08… 8/4/2015 11:02:32 AM
Example 3: Getting a backup information for a specific backup name
Get-SmBackup -BackupName "Payroll Dataset_vise-f6_08-04-2015_11.02.10.3432"
This example syntax gets backup information for the specified backup name.
BackupId BackupName BackupTime BackupType
-------- ---------- ---------- ----------
1 Payroll Dataset_vise-f6_08… 8/4/2015 11:02:32 AM
Example 4: Getting backup information using the backup ID
Get-SmBackup -BackupId 1
This example syntax gets backup information using the specified backup ID.
BackupId BackupName BackupTime BackupType
-------- ---------- ---------- ----------
1 Payroll Dataset_vise-f6_08… 8/4/2015 11:02:32 AM
Example 5: Getting backup information using the resource ID
Get-SmBackup -AppObjectId vise-f6\PayrollDatabase
This example syntax gets backup information using the specified resource ID.
BackupId BackupName BackupTime BackupType
-------- ---------- ---------- ----------
1 Payroll Dataset_vise-f6_08… 8/4/2015 11:02:32 AM Full Backup
2 Payroll Dataset_vise-f6_08… 8/4/2015 11:23:17 AM