Disable-CrmServer
Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)
Disable-CrmServer
Disables the specified Microsoft Dynamics 365 server.
Syntax
Parameter Set: Default
Disable-CrmServer [-Name] <String> [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Disable-CrmServer cmdlet disables the specified server. Disabling a Microsoft Dynamics 365 server removes the server from the resource pool for the deployment.
Parameters
-Credential<PSCredential>
Specifies the credential 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 will display 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. The location should be in one of the following formats: 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 disable. You can find the name in the Server.Name property.
Aliases |
none |
Required? |
true |
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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 disables the Microsoft Dynamics 365 server with the name “ContosoSrv.”
PS C:\> Disable-CrmServer –Name ContosoSrv
PS C:\>