Get-CrmServer
Retrieves details for one or all Dynamics 365 servers in a deployment.
Syntax
Get-CrmServer
[[-Name] <String>]
[-Timeout <Int32>]
[-Diag]
[-Credential <PSCredential>]
[-DwsServerUrl <String>]
Description
The Get-CrmServer cmdlet retrieves details for one or all Dynamics 365 servers in a deployment. If no parameters are provided, the cmdlet retrieves details for all servers in the deployment. If the Name parameter is specified, the cmdlet retrieves details for the specified server.
Examples
Example 1
PS C:\> Get-CrmServer
Retrieves information for all Dynamics 365 servers in a deployment.
Example 2
PS C:\> Get-CrmServer -Name contosoweb
Retrieves information for the Dynamics 365 server named contosoweb.
Parameters
-Credential
Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Diag
Turns on stack traces for error reports returned from 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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DwsServerUrl
The URL of the Deployment Web Service. This should be in the format: https://, for example, https://contoso.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the Dynamics 365 server to retrieve. You can find the name of all Dynamics 365 servers in the deployment by running the Get-CrmServer cmdlet with no parameters.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Timeout
For internal use only.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
System.String
System.Int32 System.Management.Automation.SwitchParameter System.Management.Automation.PSCredential
Outputs
System.Collections.Generic.List`1[[Microsoft.Xrm.Sdk.Deployment.Server, Microsoft.Crm.PowerShell, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
Microsoft.Xrm.Sdk.Deployment.Server