SnapCenter PowerShell Commands
Get-SmPluginReport
Suggest changes
PDFs
Initiates a plug-in report.
Syntax
Get-SmPluginReport [-Plugin] <PluginCode> [-HostName] <String> [-ResourceGroup] <String> [-DayCount] <Int32> [-Terse] <>
Detailed Description
Initiates a plug-in report. A plug-in report provides backup information about resources managed by a specified SnapCenter plug-in. For example, the report shows you how many SnapCenter Plug-in for Microsoft SQL Server resources have been backed up, which resources have failed backups, which resources are unprotected, and which resources do not have SnapVault updates. This report provides information for a time period you specify. The default time period is 7 days.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
Plugin |
Specifies the plug-in code for which you want a plug-in activity report. For example, if you want this report for SnapCenter Plug-in for Microsoft SQL Server, enter SCSQL. Valid plug-in values are SCW, SCSQL, and SMO. |
true |
true (ByPropertyName) |
|
HostName |
Specifies the name of the host on which the plug-in instance is installed. You can specify the host name or IP address if you want to run a plug-in activity report for only one instance of a plug-in. |
false |
true (ByPropertyName) |
|
ResourceGroup |
false |
true (ByPropertyName) |
||
DayCount |
Indicates the number of days for which you want plug-in activity reported. For example, if you want to get information for the last 5 days, enter 5. The default is 7 days. |
false |
true (ByPropertyName) |
|
Terse |
Indicates that you want to receive only limited information. Specifying terse gives you just the number of databases that are protected, unprotected, with backups that have failed, and that have no SnapVault updates. |
false |
false |
Examples
Example 1: Getting a plugin report
Get-SmPluginReport -Plugin SCSQL
This example syntax gets a plug-in report for the SnapCenter Plug-in for Microsoft SQL Server.
BackupCount : 29
AgedBackupCount : 25
ProtectedObjectCount :
NotBackedUpObjectCount : 0
UnprotectedObjectCount : 1
FailedBackupObjectCount : 0
UnprotectedBackupObjectCount : 0
AllObjectCount : 6
Backups : {Test, Test, Test, Test...}
NotBackedUpObjects : {}
UnprotectedObjects : {TestDB6}
FailedBackupObjects : {}
UnprotectedBackupObjects : {}
Result : SMCoreContracts.SMResult
TotalCount : 0
DisplayCount : 0
Context :
Job : SMCoreContracts.SmJob
Example 2: Getting a plugin report for a specific plugin instance and number of days
Get-SmPluginReport -Plugin SCSQL -HostName SCSPR0019366001.gdl.mycompany.com
This example syntax gets a plug-in report for the SnapCenter Plug-in for Microsoft SQL Server.
BackupCount : 29
AgedBackupCount : 25
ProtectedObjectCount :
NotBackedUpObjectCount : 0
UnprotectedObjectCount : 1
FailedBackupObjectCount : 0
UnprotectedBackupObjectCount : 0
AllObjectCount : 6
Backups : {Test, Test, Test, Test...}
NotBackedUpObjects : {}
UnprotectedObjects : {TestDB6}
FailedBackupObjects : {}
UnprotectedBackupObjects : {}
Result : SMCoreContracts.SMResult
TotalCount : 0
DisplayCount : 0
Context :
Job : SMCoreContracts.SmJob
Example 3: Limiting the amount of information in the plugin report
Get-SmPluginReport -Plugin SCSQL -Terse
This example syntax gets a plug-in report for the SnapCenter Plug-in for Microsoft SQL Server that only includes resource counts.
BackupCount : 29 AgedBackupCount : 25 ProtectedObjectCount : NotBackedUpObjectCount : 0 UnprotectedObjectCount : 1 FailedBackupObjectCount : 0 UnprotectedBackupObjectCount : 0 AllObjectCount : 6