Get-NectarEvent

Return a list of current or historic Nectar monitored device events

Syntax

Get-NectarEvent
  -TimePeriod  <String>
  -TimePeriodFrom  <String>
  -TimePeriodTo  <String>
  -LastTimeAfter  <String>
  -EventAlertLevels  <String[]>
  -Locations  <String[]>
  -SearchQuery  <String>
  -OrderByField  <String>
  -OrderDirection  <String>
  -EventState  <String>
  -TenantName  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>

Examples

Example 1

Get-NectarEvent -EventAlertLevels CRITICAL,MAJOR

Returns a list of current events in the last hour that are either critical or major

Example 2

Get-NectarEvent -SearchQuery BadServer -EventState Historic -TimePeriod LAST_WEEK

Returns a list of historical events from the last week that include the word 'badserver'

Parameters

-TimePeriod <String>
The time period to show event data from. Select from 'LAST_HOUR','LAST_DAY','LAST_WEEK','LAST_MONTH','CUSTOM'.
CUSTOM requires using TimePeriodFrom and TimePeriodTo parameters.

Parameter	Value
Required	false
Position	1
Required	false
Default Value	LAST_HOUR
Accept pipeline input?	false
Accept wildcard characters?	false

-TimePeriodFrom <String>

Parameter	Value
Required	false
Position	2
Required	false
Default Value	None
Accept pipeline input?	false
Accept wildcard characters?	false

-TimePeriodTo <String>

Parameter	Value
Required	false
Position	3
Required	false
Default Value	None
Accept pipeline input?	false
Accept wildcard characters?	false

-LastTimeAfter <String>
Only return results that occurred more recently than the entered value. Use date-time format as in 2020-04-20T17:46:37.554

Parameter	Value
Required	false
Position	4
Required	false
Default Value	None
Accept pipeline input?	false
Accept wildcard characters?	false

-EventAlertLevels <String[]>
Return only events that meet the specified alert level. Choose one or more from CRITICAL, MAJOR, MINOR, WARNING, GOOD, NO_ACTIVITY

Parameter	Value
Required	false
Position	5
Required	false
Default Value	None
Accept pipeline input?	false
Accept wildcard characters?	false

-Locations <String[]>
Show alerts for one or more specified locations

Parameter	Value
Required	false
Position	6
Required	false
Default Value	None
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	false

-SearchQuery <String>
Search for events that contain the specified string

Parameter	Value
Required	false
Position	7
Required	false
Default Value	None
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	false

-OrderByField <String>
Order the resultset by the specified field. Choose from id, type, lastTime, displayName, deviceName, description, eventId, time, delay, source, location, sourceId

Parameter	Value
Required	false
Position	8
Required	false
Default Value	None
Accept pipeline input?	false
Accept wildcard characters?	false

-OrderDirection <String>

Parameter	Value
Required	false
Position	9
Required	false
Default Value	None
Accept pipeline input?	false
Accept wildcard characters?	false

-EventState <String>
Return either current events or previously acknowledged events

Parameter	Value
Required	false
Position	10
Required	false
Default Value	Current
Accept pipeline input?	false
Accept wildcard characters?	false

-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.

Parameter	Value
Required	false
Position	11
Required	false
Default Value	None
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	false

-PageSize <Int32>
The size of the page used to return data. Defaults to 1000

Parameter	Value
Required	false
Position	12
Required	false
Default Value	1000
Accept pipeline input?	false
Accept wildcard characters?	false

-ResultSize <Int32>
The total number of results to return. Defaults to 1000. Maximum result size is 9,999,999 results