Get-QCMCapacityReport
From PowerGUI Wiki
Saves reports for the specified objects in a pdf file.
Contents |
Syntax
Get-QCMCapacityReport -ServerName <string> [-DatabaseName <string>] [-ObjectName <string>] [-IndexName <string>] -FilePath <string> [-ServerAlias <string>] [<CommonParameters>]
Get-QCMCapacityReport -ServerGroupName <string> -FilePath <string> [<CommonParameters>]
Detailed Description
The Get-QCMCapacityReport cmdlet creates the Manage Capacity tool report for the specified object and saves it to a file in pdf format.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| ServerGroupName | Specifies the name of the Server Group for which you want to create the report. | true | false | |
| ServerName | Specifies the name of the SQL Server instance for which you want to create the report, or which stores the database, table, view, or index for which you want to create the report. | true | false | |
| DatabaseName | Specifies the name of the SQL Server database for which you want to create the report on, or which stores the table, view, or index for which you want to create the report. | false | false | |
| ObjectName | Specifies the name of SQL Server database object for which you want to create the report, or the SQL Server owner of the index for which you want to create the report. | false | false | |
| IndexName | Specifies the name of the SQL Server index for which you want to create the report. | false | false | |
| FilePath | Specifies the path to the file where the report should be saved. | true | false | |
| ServerAlias | Specifies SQL Server instance alias in the Capacity Manager console. The alias can be used instead of the ServerName parameter. | false | false |
Input Type
None
Return Values
None
Notes
For more information, type "Get-Help Get-QCMCapacityReport -detailed". For technical information, type "Get-Help Get-QCMCapacityReport -full".
Examples
EXAMPLE 1
Get-QCMCapacityReport -ServerGroupName "SQL Server Group" -FilePath C:\qcm_report.pdf
This command loads capacity information about the "SQL Server Group" Server Group and saves the report in the "C:\qcm_report.pdf" file.
EXAMPLE 2
Get-QCMCapacityReport -ServerName sql1 -FilePath C:\qcm_report.pdf
This command loads capacity information about the "sql1" SQL Server instance and saves the report in the "C:\qcm_report.pdf" file.
EXAMPLE 3
Get-QCMCapacityReport -ServerName sql1 -DatabaseName employee -FilePath C:\qcm_report.pdf
This command loads capacity information about the "employee" database on the "sql1" SQL Server instance and saves the report in the "C:\qcm_report.pdf" file.
