Export (0) Print
Expand All

Set-ServerComponentState

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-15

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

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

For information about the parameter sets in the Syntax section below, see 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 and Shell infrastructure 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. The string can be one of the following:

  • HealthAPI

  • Maintenance

  • Sidelined

  • Functional

  • Deployment

State

Required

Microsoft.Exchange.Data.ServiceState

The State parameter specifies the state that you want for the component. The state can be one of the following:

  • Active

  • Inactive

  • Draining

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

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 parameter specifies that the cmdlet changes should be written to the Windows registry only.

RemoteOnly

Optional

System.Management.Automation.SwitchParameter

The RemoteOnly parameter specifies that the cmdlet changes should be written to Active Directory only.

TimeoutInSeconds

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf 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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft