Disable-CrmServer

Reference

Module:: Microsoft.Crm.PowerShell

Disables the specified Dynamics 365 server.

Syntax

Disable-CrmServer
       [-Name] <String>
       [-Timeout <Int32>]
       [-Diag]
       [-Credential <PSCredential>]
       [-DwsServerUrl <String>]
       [-WhatIf]
       [-Confirm]

Description

The Disable-CrmServer cmdlet disables the specified server. Disabling a Dynamics 365 server removes the server from the resource pool for the deployment.

Examples

Example 1

PS C:\> Disable-CrmServer -Name ContosoSrv

Disables the Dynamics 365 server named ContosoSrv.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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 that you want to disable. You can find all enabled server names in a deployment by running the Get-CrmServer cmdlet.

Type:	String
Position:	0
Default value:	None
Required:	True
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.String

System.Int32 System.Management.Automation.SwitchParameter System.Management.Automation.PSCredential

Outputs

System.Object

Share via