Wes Carroll
6.4 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| ZertoApiWrapper-help.xml | ZertoApiWrapper | https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoAlert.md | 2.0.0 |
Get-ZertoAlert
SYNOPSIS
Get Alerts from the Zerto Virtual Manager
SYNTAX
main (Default)
Get-ZertoAlert [<CommonParameters>]
alertId
Get-ZertoAlert -alertId <String[]> [<CommonParameters>]
entities
Get-ZertoAlert [-entities] [<CommonParameters>]
helpIdentifiers
Get-ZertoAlert [-helpIdentifiers] [<CommonParameters>]
levels
Get-ZertoAlert [-levels] [<CommonParameters>]
filter
Get-ZertoAlert [-startDate <String>] [-endDate <String>] [-vpgIdentifier <String>] [-siteIdentifier <String>]
[-zorgIdentifier <String>] [-level <String>] [-helpIdentifier <String>] [-entity <String>]
[-isDismissed <Boolean>] [<CommonParameters>]
DESCRIPTION
This function will return all alerts from the Zerto Virtual Manager when called witout any parameters.
When the filter parameter set is used it will return any alerts that suit the passed criteria depending on the parameters that are defined. The parameters are combined with "AND" logic so it will only return alerts that meet all the criteria passed.
Any of the other parameter sets used will return valid settings for each setting type.
EXAMPLES
Example 1
PS C:\> Get-ZertoAlert
Returns all current alerts.
Example 2
PS C:\> Get-ZertoAlert -startDate "2019-02-01T08:00:00.000" -endDate "2019-02-02T20:30:00.000"
Returns all alerts that were started after Feb. 01, 2019 8 AM ZVM local time and Feb. 02 2019 8 PM ZVM local time.
Example 3
PS C:\> Get-ZertoAlert -alertId "Need to Fill This In"
Returns information on the alert with alert identifier "Need to Fill This In"
Example 4
PS C:\> Get-ZertoAlert -entities
Returns entities information
Example 5
PS C:\> Get-ZertoAlert -helpIdentifiers
Returns Help Identifiers information
Example 6
PS C:\> Get-ZertoAlert -levels
Returns information about alert levels
PARAMETERS
-alertId
AlertId or array of AlertIds to be queried
Type: String[]
Parameter Sets: alertId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-endDate
Returns Alerts before the End Date. Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff'
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-entities
Switch to return the entities information from the API
Type: SwitchParameter
Parameter Sets: entities
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-entity
Returns alerts for the specified entity
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-helpIdentifier
Returns alerts for the specified helpIdentifier
Type: String
Parameter Sets: filter
Aliases: helpId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-helpIdentifiers
Switch to get the Help Identifiers information from the API
Type: SwitchParameter
Parameter Sets: helpIdentifiers
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-isDismissed
Returns alerts that are dismissed when set to $true an undismissed alerts when set to $false
Type: Boolean
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-level
Returns alerts for the specified level
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-levels
Switch to return Alert Levels information from the API
Type: SwitchParameter
Parameter Sets: levels
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-siteIdentifier
Returns alerts for the specified siteIdentifier
Type: String
Parameter Sets: filter
Aliases: siteId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-startDate
Returns Alerts after the Start Date. Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff'
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-vpgIdentifier
Returns alerts for the specified vraIdentifier
Type: String
Parameter Sets: filter
Aliases: vpgId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-zorgIdentifier
Returns alerts for the specified zorgIdentifier
Type: String
Parameter Sets: filter
Aliases: zorgId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.