< Back

Remove-AlarmDefinition

Sun Jan 19, 2020 7:02 pm

NAME Remove-AlarmDefinition



SYNOPSIS

This cmdlet removes alarm definitions from the vSphere environment.





SYNTAX

Remove-AlarmDefinition [-AlarmDefinition] <AlarmDefinition[]> [-Confirm] [-Server <VIServer[]>] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

This cmdlet removes alarm definitions from the vSphere environment.





PARAMETERS

-AlarmDefinition <AlarmDefinition[]>

Specifies the alarm definitions that you want to remove.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

VMware.VimAutomation.ViCore.Types.V1.Alarm.AlarmDefinition[]







OUTPUTS

None







NOTES









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



RELATED LINKS

Get-AlarmAction

Get-AlarmActionTrigger

Get-AlarmDefinition

Get-AlarmTrigger

New-AlarmAction

New-AlarmActionTrigger

New-AlarmDefinition

New-AlarmTrigger

Remove-AlarmAction

Remove-AlarmActionTrigger

Remove-AlarmDefinition

Set-AlarmDefinition

Get-Metric

Get-EventType