SQL Monitor 13

Remove-SqlMonitorMonitoredObject

Removes the given monitored object from SQL Monitor.

Syntax

Remove-SqlMonitorMonitoredObject [-MonitoredObject] <MonitoredObject[]> [-DeleteData] [<CommonParameters>]

Description

The Remove-SqlMonitorMonitoredObject cmdlet removes the given monitored object from a SQL Monitor Server.

Connect-SqlMonitor must be called before this cmdlet.

Parameters

-MonitoredObject <MonitoredObject[]>

The Monitored Object to remove. For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-MonitoredObject.

Aliases None
Required? true
Position? 1
Default Value None
Accept Pipeline Input True (ByValue)
Accept Wildcard Characters false

-DeleteData <SwitchParameter>

The switch to determine whether to delete data associated this object from the database.

Aliases None
Required? false
Position? named
Default Value False
Accept Pipeline Input False
Accept Wildcard Characters false

-ProgressAction <ActionPreference>

{{ Fill ProgressAction Description }}

Aliases None
Required? false
Position? named
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

Get-SqlMonitorCluster -Name 'exampleserver.mydomain.com' | Remove-SqlMonitorMonitoredObject

-------------------------- EXAMPLE 2 --------------------------

Remove-SqlMonitorMonitoredObject -MonitoredObject $monitoredObject

-------------------------- EXAMPLE 3 --------------------------

Remove-SqlMonitorMonitoredObject -MonitoredObject $monitoredObject -DeleteData


Do you have any feedback on this documentation?

Let us know at sqlmonitorfeedback@red-gate.com


Didn't find what you were looking for?