Remove-ClusterVMMonitoredItem

  • Reference
Module:
FailoverClusters

Removes monitoring of a service or event that is currently being monitored on a virtual machine.

Syntax

Remove-ClusterVMMonitoredItem
      [-InputObject <PSObject>]
      [-Service <StringCollection>]
      [-EventLog <String>]
      [-EventSource <String>]
      [-EventId <Int32>]
      [[-VirtualMachine] <String>]
      [-Wait <Int32>]
      [-Cluster <String>]
      [<CommonParameters>]
Remove-ClusterVMMonitoredItem
      [-InputObject <PSObject>]
      [-Service <StringCollection>]
      [-EventLog <String>]
      [-EventSource <String>]
      [-EventId <Int32>]
      [-VMId <Guid>]
      [-Wait <Int32>]
      [-Cluster <String>]
      [<CommonParameters>]

Description

The Remove-ClusterVMMonitoredItem cmdlet removes monitoring of a service or event that is currently being monitored. After removal, if the service fails or the event occurs, the system will no longer take an action, such as restarting the virtual machine.

Examples

Example 1

PS C:\> Get-ClusterVMMonitoredItem -VirtualMachine VM1 | Remove-ClusterVMMonitoredItem -VirtualMachine VM1

This example removes all of the items being monitored on the virtual machine named VM1.

Example 2

PS C:\> Remove-ClusterVMMonitoredItem -VirtualMachine VM1 -Service spooler

This example removes monitoring on the print spooler service on the virtual machine named VM1.

Parameters

-Cluster

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventId

Specifies the event identifier (ID) of the Event Tracing for Windows (ETW) event to be removed from monitoring.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventLog

Specifies the event log of the event to be removed from monitoring.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventSource

Specifies the event source of the event to be removed from monitoring.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item to stop monitoring.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Service

Specifies the name of the service to be removed from monitoring.

Type:StringCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualMachine

Specifies the name of the clustered virtual machine from which to remove monitoring. When this parameter is specified, this cmdlet must be run on one of the host cluster nodes, or else the Cluster parameter must also be specified.

Type:String
Aliases:VM
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMId

Specifies the virtual machine identifier (ID).

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Wait

Specifies the time in seconds to wait for the cmdlet. If the Wait parameter is not specified, then the cmdlet waits for completion. If -Wait 0 is specified, then the call is initiated and the cmdlet returns without waiting.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Microsoft.FailoverClusters.PowerShell.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem

Outputs

None