Applies to: Exchange Server 2013

Topic Last Modified: 2012-08-02

Use the Set-ServerMonitor cmdlet to edit or set a parameter on a single monitor on an Exchange server.

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

Syntax

Set-ServerMonitor -Name <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Repairing <$true | $false>] [-Server <ServerIdParameter>] [-TargetResource <String>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example sets the maintenance monitor on the Exch01 server.

Copy Code
Set-ServerMonitor -Name Maintenance -Server Exch01

Detailed Description

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 "Shell infrastructure permissions" section in the Exchange and Shell Infrastructure Permissions topic.

Parameters

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies the monitor identity.

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.

In the cloud-based service, this parameter is reserved for internal Microsoft use.

Repairing

Optional

System.Boolean

The Repairing parameter specifies whether to set or clear the repairing property on a monitor.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the Exchange server on which you want to run this command. You can use any value that uniquely identifies the server. For example:

  • Name

  • FQDN

  • Distinguished name (DN)

  • Exchange Legacy DN

If you don't use the Server parameter, the command is run on the local server.

TargetResource

Optional

System.String

The TargetResource parameter specifies the target resource that you want to set the monitor on.

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.

Input Types

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.

Return Types

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.