Get-CrmServer
Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)
Get-CrmServer
Retrieves a server object for one or all Microsoft Dynamics 365 servers in a deployment.
Syntax
Parameter Set: Default
Get-CrmServer [[-Name] <String> ] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-CrmServer cmdlet retrieves a server object for one or all Microsoft Dynamics 365 servers in a deployment. If no parameters are provided, the cmdlet retrieves the server object for all servers in the deployment. If the Name parameter is specified, the cmdlet retrieves the server object for the specified server.
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 |
-Name<String>
Specifies the name of the Microsoft Dynamics 365 server to retrieve. You can find the name in the Server.Name property.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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
-------------------------- EXAMPLE 1 --------------------------
This example retrieves the server objects for all Microsoft Dynamics 365 servers in a deployment.
PS C:\> Get-CrmServer
-------------------------- EXAMPLE 2 --------------------------
This example retrieves the server object for the Microsoft Dynamics 365 server named “localhost.”
PS C:\> Get-CrmServer localhost