devel

Get-RubrikEvent

SYNOPSIS

Retrieve information for events that match the value specified in any of the following categories: type, status, or ID, and limit events by date.

SYNTAX

eventByID

Get-RubrikEvent [-Limit <Int32>] [-AfterId <String>] [-Status <String>] [-EventSeriesStatus <String>]
 [-EventType <String>] [-ExcludeEventType <String[]>] [-id <String[]>] [-ObjectName <String>]
 [-BeforeDate <DateTime>] [-AfterDate <DateTime>] [-ObjectType <String>] [-ExcludeObjectType <String[]>]
 [-Descending] [-IncludeEventSeries] [-Server <String>] [-api <String>] [<CommonParameters>]

EventSeries

Get-RubrikEvent -EventSeriesId <String> [-Server <String>] [-api <String>] [<CommonParameters>]

DESCRIPTION

The Get-RubrikEvent cmdlet is used to pull a event data set from a Rubrik cluster. There are a vast number of arguments that can be supplied to narrow down the event query.

EXAMPLES

EXAMPLE 1

Get-RubrikEvent -ObjectName "vm-foo" -EventType Backup

This will query for any 'Backup' events on the Rubrik VM object named 'vm-foo'

EXAMPLE 2

Get-RubrikVM -Name jbrasser-win | Get-RubrikEvent -Limit 10

Queries the Rubrik Cluster for any vms named jbrasser-win and return the last ten events for each VM found

EXAMPLE 3

Get-RubrikEvent -EventType Archive -Limit 100

This will query the latest 100 Archive events on the currently logged in Rubrik cluster

EXAMPLE 4

Get-RubrikHost -Name SQLFoo.demo.com | Get-RubrikEvent

This will feed any events against the Rubrik Host object 'SQLFoo.demo.com' via a piped query.

EXAMPLE 5

Get-RubrikEvent -EventSeriesId '1111-2222-3333'

This will retrieve all of the events belonging to the specified EventSeriesId. Note - This will call Get-RubrikEventSeries

EXAMPLE 6

Get-RubrikEvent -EventType Archive -Limit 10 -IncludeEventSeries

This will query the latest 10 Archive events on the currently logged in Rubrik cluster and include the relevant EventSeries.

EXAMPLE 7

Get-RubrikEvent -Limit 25 -ExcludeObjectType AggregateAhvVm,Mssql -Verbose

This will retrieve all of the events while excluding events of the AggregateAhvVm & Mssql object types while displaying verbose messages. This will potentially display less than 25 objects, as filtering happens after receiving the objects from the endpoint

EXAMPLE 8

Get-RubrikEvent -Limit 25 -ExcludeEventType Archive,Replication,Configuration,Backup

This will retrieve all of the events while excluding events of the Archive,Replication,Configuration,Backup Event types while displaying verbose messages. This will potentially display less than 25 objects, as filtering happens after receiving the objects from the endpoint

EXAMPLE 9

Get-RubrikEvent -Limit 25 -EventType Archive -ExcludeObjectType AggregateAhvVm,Mssql -Verbose

This will retrieve all Archive events while excluding events of the AggregateAhvVm & Mssql object types while displaying verbose messages. This will potentially display less than 25 objects, as filtering happens after receiving the objects from the endpoint

EXAMPLE 10

Get-RubrikDatabase | ForEach-Object {Get-RubrikEvent -Limit 1 -Verbose -id $_.ID}

This will retrieve the last event for each of the SQL databases protected by Rubrik identifying the database by its object_id while displaying Verbose information

EXAMPLE 11

Get-RubrikEvent -Limit 1 -Descending:$false

Will retrieve the oldest event on the Rubrik Cluster

EXAMPLE 12

Get-RubrikEvent -Limit 1 -Descending:$false -EventType Backup

Will retrieve the oldest backup event on the Rubrik Cluster

EXAMPLE 13

Get-RubrikEvent -Status Failure -EventSeriesStatus Success

Will retrieve the first 50 Events which have event_status failed and event_series_status Success

PARAMETERS

-Limit

Maximum number of events retrieved, default is to return 50 objects

Type: Int32
Parameter Sets: eventByID
Aliases:

Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False

-AfterId

Earliest event retrieved

Type: String
Parameter Sets: eventByID
Aliases: after_id

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventSeriesId

Filter by Event Series ID

Type: String
Parameter Sets: EventSeries
Aliases: event_series_id

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

Filter by Event status. Enter any of the following values: 'Failure', 'Warning', 'Running', 'Success', 'Canceled', 'Canceling'.

Type: String
Parameter Sets: eventByID
Aliases: event_status

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventSeriesStatus

Filter by Status. Enter any of the following values: 'Success', 'Failure', 'Scheduled', 'Active', 'Canceling', 'Canceled', 'SuccessWithWarnings'.

Type: String
Parameter Sets: eventByID
Aliases: event_series_status

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventType

Filter by Event Type.

Type: String
Parameter Sets: eventByID
Aliases: event_type

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeEventType

Filter by excluding specific Event Types, multiple entries are allowed. Note that this filtering happens after receiving the results, this means that if a limit of 50 is specified 50 or less results will be returned

Type: String[]
Parameter Sets: eventByID
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

Filter by a comma separated list of object IDs.

Type: String[]
Parameter Sets: eventByID
Aliases: object_ids

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ObjectName

Filter all the events according to the provided name using infix search for resources and exact search for usernames.

Type: String
Parameter Sets: eventByID
Aliases: object_name

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BeforeDate

Filter all the events before a date.

Type: DateTime
Parameter Sets: eventByID
Aliases: before_date

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AfterDate

Filter all the events after a date.

Type: DateTime
Parameter Sets: eventByID
Aliases: after_date

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ObjectType

Filter all the events by object type. Enter any of the following values: 'VmwareVm', 'Mssql', 'LinuxFileset', 'WindowsFileset', 'WindowsHost', 'LinuxHost', 'StorageArrayVolumeGroup', 'VolumeGroup', 'NutanixVm', 'Oracle', 'AwsAccount', and 'Ec2Instance'. WindowsHost maps to both WindowsFileset and VolumeGroup, while LinuxHost maps to LinuxFileset and StorageArrayVolumeGroup.

Type: String
Parameter Sets: eventByID
Aliases: object_type

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeObjectType

Filter by excluding specific Object Types, multiple entries are allowed. Note that this filtering happens after receiving the results, this means that if a limit of 50 is specified 50 or less results will be returned

Type: String[]
Parameter Sets: eventByID
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Descending

A Switch value that determines whether to display the results in descending or ascending order. Setting this to Descending:$false will return the oldest results instead of the most recent

Type: SwitchParameter
Parameter Sets: eventByID
Aliases: order_by_time

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeEventSeries

A Switch value that determines whether or not EventSeries events are included in the results

Type: SwitchParameter
Parameter Sets: eventByID
Aliases: should_include_event_series

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Server

Rubrik server IP or FQDN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.server
Accept pipeline input: False
Accept wildcard characters: False

-api

API version

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $global:RubrikConnection.api
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.

INPUTS

OUTPUTS

NOTES

Written by J.R. Phillips for community usage GitHub: JayAreP

RELATED LINKS

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikevent

PreviousGet-RubrikEmailSettingNextGet-RubrikEventSeries

Last updated