Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

Examples

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

Required Parameters

-Component

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

Type:

String

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

The Identity parameter specifies the server you want to configure.

Type:

ServerIdParameter

Position:

1

Default value:

None

Accept pipeline input:

True

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Requester

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

HealthAPI

Maintenance

Sidelined

Functional

Deployment

Type:

String

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-State

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

Active

Inactive

Draining

Type:

Inactive | Active | Draining

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Optional Parameters

-Confirm

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.

Type:

SwitchParameter

Aliases:

cf

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

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 LocalOnlyswitch 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.

Type:

SwitchParameter

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-RemoteOnly

The RemoteOnlyswitch 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.

Type:

SwitchParameter

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-TimeoutInSeconds

This parameter is reserved for internal Microsoft use.

Type:

Int32

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

Applies to:

Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-WhatIf

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.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.