Set-ServerMonitor

 

Applies to: Exchange Server 2016

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

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 infrastructure and PowerShell 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 where 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 this parameter, the command is run on the local server.

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.

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 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: