Get-CrmMonitoringResult

Applies To: CRM 2015 on-prem

Get-CrmMonitoringResult

Retrieves results from the monitoring service operations tests for the Microsoft Dynamics CRM deployment.

Syntax

Parameter Set: FilterMonitoringResults
Get-CrmMonitoringResult [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-EndTime <DateTime]> ] [-Role <String> ] [-Server <String> ] [-StartTime <DateTime]> ] [-Status <String> ] [-TestName <String> ] [-Timeout <Int32> ] [ <CommonParameters>]

Parameter Set: ServiceHealth
Get-CrmMonitoringResult [-ServiceHealth] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-CrmMonitoringResult cmdlet returns the results from the monitoring service. These tests report the overall health of the CRM deployment. This cmdlet also allows you to report on specific tests or date ranges.

Parameters

-Credential<PSCredential>

Specifies the credentials used to log in to the Deployment web service.

-Diag

Turns on stack traces for error reports returned from Microsoft Dynamics CRM service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the CRM PowerShell command.

-DwsServerUrl<String>

Identifies the location of the Deployment web service.This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.

-EndTime<DateTime]>

Filters test results that were reported earlier than this time.

-Role<String>

Specifies a comma delimited list of roles to filter results by. Possible roles for this are: AppServer, AsyncService, SrsDataConnector, DiscoveryService, EmailService, WebService, SqlServer, ApiServer,SrsSqlServer, SandboxServer, and DeploymentManagementTools.

-Server<String>

Comma delimited list of servers to filter results by.

-ServiceHealth

Reports the overall CRM Service health. Possible results are: Healthy - Service Verification Only, Healthy, and Not Healthy. For a full report, a monitoring organization needs to be defined for this deployment. To configure this, use the Set-CrmSettings cmdlet and configure the monitoring organization in the MonitoringSettings object.

-StartTime<DateTime]>

Filters results to test results that were reported later than this time.

-Status<String>

Filters results based on this status.

-TestName<String>

Specifies the name of the test to get the results for. Possible tests at the time of this release are: VerifyAsyncServiceMaintenanceRunning, VerifyAsyncServiceRunning, VerifySandboxServiceIsRunning, VerifyUnZipServiceIsRunning, VerifyVSSWriterServiceIsRunning, VerifyWebsiteIsRunning, VerifyApplicationAppPoolIsRunning, VerifyDeploymentWebServiceAppPoolIsRunning, CheckApiServer, CheckWebApp, VerifyActiveCrmKeys, VerifyAsyncBacklogTest, VerifyHelpContent, CheckReportServer, CheckCrmReporting, CheckReportServerFromSrsDataConnector, and CheckFetchBasedReport.

-Timeout<Int32>

For internal use only.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

PS C:\> 

PS C:\>