Get-CrmMonitoringResult

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

Get-CrmMonitoringResult

Retrieves results from the monitoring service operations tests for the Microsoft Dynamics 365 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 Dynamics 365 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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Diag

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EndTime<DateTime]>

Filters test results that were reported earlier than this time.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Server<String>

Comma delimited list of servers to filter results by.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ServiceHealth

Reports the overall Dynamics 365 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.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-StartTime<DateTime]>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Status<String>

Filters results based on this status.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Timeout<Int32>

For internal use only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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:\>