Get-QCMSharePointReport

From PowerGUI Wiki

Saves reports for the specified objects in a pdf file.

Contents 1 Syntax 2 Detailed Description 3 Related Commands 4 Parameters 5 Input Type 6 Return Values 7 Notes 8 Examples 8.1 EXAMPLE 1 8.2 EXAMPLE 2 8.3 EXAMPLE 3

Syntax

Get-QCMSharePointReport -ServerName <string> -ConfigDbName <string> [-ContentDbName <string>] [-SiteName <string>] -FilePath <string> [-ServerAlias <string>] [-ApplicationAlias <string>] [<CommonParameters>] Get-QCMSharePointReport -SharePointGroupName <string> -FilePath <string> [<CommonParameters>]

Detailed Description

The Get-QCMSharePointReport cmdlet creates the Manage SharePoint reports for the specified object and saves it to a file in pdf format.

Related Commands

• Get-QCMCapacityReport
• Get-QCMFragmentationReport
• Send-QCMReport
• Start-QCMStatusesCalculation

Parameters

Name	Description	Required?	Pipeline Input	Default Value
SharePointGroupName	Specifies the name of the SharePoint Group for which you want to create the report.	true
ServerName	Specifies the name of the SQL Server instance where the SharePoint Configuration Database is stored.	true	false
ConfigDbName	Specifies the name of the SharePoint Configuration Database for which you want to create the report.	true	false
ContentDbName	Specifies the name of the SharePoint Content Database for which you want to create the report.	false	false
SiteName	Specifies the name of the SharePoint Site 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
ApplicationAlias	Specifies the SharePoint Application alias. The alias can be used instead of the ServerName and ConfigDbName parameters.	false	false

Input Type

None

Return Values

None

Notes

For more information, type "Get-Help Get-QCMSharePointReport -detailed". For technical information, type "Get-Help Get-QCMSharePointReport -full".

Examples

EXAMPLE 1

Get-QCMSharePointReport -SharePointGroupName "SharePoint Group" -FilePath C:\qcm_report.pdf

This command loads SharePoint capacity information about the "SharePoint Group" SharePoint Group and saves the report in the "C:\qcm_report.pdf" file.

EXAMPLE 2

Get-QCMSharePointReport -ServerName sql1 -ConfigDbName SPConfig -FilePath C:\qcm_report.pdf

This command loads SharePoint capacity information about the SharePoint Configuration Database on the sql1 SQL Server instance and saves the report in the "C:\qcm_report.pdf" file.

EXAMPLE 3

Get-QCMSharePointReport -ServerName sql1 -ConfigDbName SPConfig -ContentDbName SPContent -FilePath C:\qcm_report.pdf

This command loads SharePoint capacity information about the "SPContent" SharePoint Content Database registered in the "SPConfig SharePoint Configuration Database" and saves the report in the "C:\qcm_report.pdf" file.