powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-AlarmDefinition



NAME
Get-AlarmDefinition

SYNOPSIS
Retrieves the available alarm definitions.

SYNTAX
Get-AlarmDefinition [-Id ] [[-Name] ] [[-Entity] ] [-Enabled []] [-Server
] []


DESCRIPTION
Retrieves the available alarm definitions.


PARAMETERS
-Id
Specify the Ids of the alarms you want to retrieve.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Name
Specify the names of the alarms you want to retrieve.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Entity
Filter the alarm definitions by the entities to which they are defined. The parameter accepts InventoryItem and
Datastore objects.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Enabled []
Indicate that you want to retrieve only the enabled alarm definitions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
AlarmDefinition


NOTES




-------------- Example 1 --------------

C:\PS>Get-AlarmDefinition -Entity (Get-Folder -NoRecursion) -Name "Host connection and power state" -Enabled:$true


Retrieve the enabled alarms named "Host connection and power state" for the available folders.





-------------- Example 2 --------------

C:\PS>Get-AlarmDefinition -Server Server1, Server2


Retrieves the alarms for the specified servers.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-AlarmDefinition.html
Get-AlarmAction
Get-AlarmActionTrigger
New-AlarmAction
New-AlarmActionTrigger
Remove-AlarmAction
Remove-AlarmActionTrigger
Set-AlarmDefinition
New-AlarmActionTrigger