< Back
Get-AlarmDefinition
Post
NAME Get-AlarmDefinition
SYNOPSIS
This cmdlet retrieves the available alarm definitions.
SYNTAX
Get-AlarmDefinition [[-Name] <String[]>] [[-Entity] <VIObject[]>] [-Enabled <Boolean>] [-Id <String[]>] [-Server
<VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the available alarm definitions.
PARAMETERS
-Enabled <Boolean>
Indicates that you want to retrieve only the enabled alarm definitions.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Entity <VIObject[]>
Filters the alarm definitions by the entities to which they are defined. This parameter accepts InventoryItem,
Datastore, and DatastoreCluster objects.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Id <String[]>
Specifies the IDs of the alarms you want to retrieve.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that
matches exactly one of the string values in that list.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the alarms you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
<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
OUTPUTS
Zero or more AlarmDefinition objects
NOTES
-------------------------- Example 1 --------------------------
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 --------------------------
Get-AlarmDefinition -Server Server1, Server2
Retrieves the alarms for the specified servers.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ition.html
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
SYNOPSIS
This cmdlet retrieves the available alarm definitions.
SYNTAX
Get-AlarmDefinition [[-Name] <String[]>] [[-Entity] <VIObject[]>] [-Enabled <Boolean>] [-Id <String[]>] [-Server
<VIServer[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the available alarm definitions.
PARAMETERS
-Enabled <Boolean>
Indicates that you want to retrieve only the enabled alarm definitions.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Entity <VIObject[]>
Filters the alarm definitions by the entities to which they are defined. This parameter accepts InventoryItem,
Datastore, and DatastoreCluster objects.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Id <String[]>
Specifies the IDs of the alarms you want to retrieve.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that
matches exactly one of the string values in that list.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the alarms you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
<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
OUTPUTS
Zero or more AlarmDefinition objects
NOTES
-------------------------- Example 1 --------------------------
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 --------------------------
Get-AlarmDefinition -Server Server1, Server2
Retrieves the alarms for the specified servers.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ition.html
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