Syntax
Remove-AlarmDefinition [-AlarmDefinition] <AlarmDefinition[]> [-Confirm] [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet removes alarm definitions from the vSphere environment.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| AlarmDefinition | AlarmDefinition[] | Specifies the alarm definitions that you want to remove. | true | True (ByValue) | |
| Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
System.VoidNotes
Examples
-------------------------- Example 1 --------------------------
Get-AlarmDefinition -Name "MyAlarm" | Remove-AlarmDefinition
Removes the alarm with a name "MyAlarm".
-------------------------- Example 2 --------------------------
Remove-AlarmDefinition -AlarmDefinition "MyAlarm*"
Removes all alarms that match the pattern.