Set-ServerComponentState

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-ServerComponentState cmdlet to configure and update Microsoft Exchange components and endpoints on servers you specify.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-ServerComponentState -Component <String> -Identity <ServerIdParameter> -Requester <String> -State <Inactive | Active | Draining> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-LocalOnly <SwitchParameter>] [-RemoteOnly <SwitchParameter>] [-TimeoutInSeconds <Int32>] [-WhatIf [<SwitchParameter>]]

This example sets the Unified Messaging (UM) component state to Active, as requested by maintenance mode.

Set-ServerComponentState -Component UMCallRouter -Identity MailboxServer01 -Requester Maintenance -State Active

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Test system health" entry in the Exchange infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

Component

Required

System.String

The Component parameter specifies the component or endpoint for which you want to set the state.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Identity parameter specifies the server you want to configure.

Requester

Required

System.String

The Requester parameter specifies the system requesting this state change. Valid values are:

  • HealthAPI

  • Maintenance

  • Sidelined

  • Functional

  • Deployment

State

Required

Microsoft.Exchange.Data.ServiceState

The State parameter specifies the state that you want for the component. Valid values are:

  • Active

  • Inactive

  • Draining

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

LocalOnly

Optional

System.Management.Automation.SwitchParameter

The LocalOnly switch specifies that the changes are written to the registry of the Exchange server only, and not to Active Directory. You don't need to specify a value with this switch.

RemoteOnly

Optional

System.Management.Automation.SwitchParameter

The RemoteOnly switch specifies that the changes are written to Active Directory only, and not to the registry of the Exchange server. You don't need to specify a value with this switch.

TimeoutInSeconds

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: