Export (0) Print
Expand All

Set-ServerMonitor

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-14

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

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.

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

This example sets the maintenance monitor on the Exch01 server.

Set-ServerMonitor -Name Maintenance -Repairing $true -Server Exch01

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.

 

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies the monitor identity.

Repairing

Required

System.Boolean

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

The default value is $true.

Server

Required

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.

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.

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.

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