Files
ZertoApiWrapper/Help/Get-Events.md
T
2019-02-19 15:53:30 -05:00

331 lines
5.2 KiB
Markdown

---
external help file: ZertoFunctions-help.xml
Module Name: ZertoFunctions
online version:
schema: 2.0.0
---
# Get-Events
## SYNOPSIS
{{Fill in the Synopsis}}
## SYNTAX
### main (Default)
```
Get-Events [<CommonParameters>]
```
### filter
```
Get-Events [-startDate <String>] [-endDate <String>] [-vpg <String>] [-vpgIdentifier <String>]
[-eventType <String>] [-siteName <String>] [-siteIdentifier <String>] [-zorgIdentifier <String>]
[-entityType <String>] [-userName <String>] [-category <String>] [-eventCategory <String>]
[-alertIdentifier <String>] [<CommonParameters>]
```
### eventId
```
Get-Events -eventId <String[]> [<CommonParameters>]
```
### categories
```
Get-Events [-categories] [<CommonParameters>]
```
### entities
```
Get-Events [-entities] [<CommonParameters>]
```
### types
```
Get-Events [-types] [<CommonParameters>]
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### Example 1
```powershell
PS C:\> {{ Add example code here }}
```
{{ Add example description here }}
## PARAMETERS
### -alertIdentifier
{{Fill alertIdentifier Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -categories
{{Fill categories Description}}
```yaml
Type: SwitchParameter
Parameter Sets: categories
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -category
{{Fill category Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -endDate
{{Fill endDate Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -entities
{{Fill entities Description}}
```yaml
Type: SwitchParameter
Parameter Sets: entities
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -entityType
{{Fill entityType Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -eventCategory
{{Fill eventCategory Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -eventId
{{Fill eventId Description}}
```yaml
Type: String[]
Parameter Sets: eventId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
### -eventType
{{Fill eventType Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteIdentifier
{{Fill siteIdentifier Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -siteName
{{Fill siteName Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -startDate
{{Fill startDate Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -types
{{Fill types Description}}
```yaml
Type: SwitchParameter
Parameter Sets: types
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -userName
{{Fill userName Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpg
{{Fill vpg Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -vpgIdentifier
{{Fill vpgIdentifier Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -zorgIdentifier
{{Fill zorgIdentifier Description}}
```yaml
Type: String
Parameter Sets: filter
Aliases:
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String[]
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS