Get-NectarEvent
    • 15 May 2023
    • 2 Minutes to read
    • Contributors
    • Dark
      Light
    • PDF

    Get-NectarEvent

    • Dark
      Light
    • PDF

    Article Summary

    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.

    ParameterValue
    Requiredfalse
    Position1
    Requiredfalse
    Default ValueLAST_HOUR
    Accept pipeline input?false
    Accept wildcard characters?false

    -TimePeriodFrom <String>

    ParameterValue
    Requiredfalse
    Position2
    Requiredfalse
    Default ValueNone
    Accept pipeline input?false
    Accept wildcard characters?false

    -TimePeriodTo <String>

    ParameterValue
    Requiredfalse
    Position3
    Requiredfalse
    Default ValueNone
    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

    ParameterValue
    Requiredfalse
    Position4
    Requiredfalse
    Default ValueNone
    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

    ParameterValue
    Requiredfalse
    Position5
    Requiredfalse
    Default ValueNone
    Accept pipeline input?false
    Accept wildcard characters?false

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

    ParameterValue
    Requiredfalse
    Position6
    Requiredfalse
    Default ValueNone
    Accept pipeline input?true (ByPropertyName)
    Accept wildcard characters?false

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

    ParameterValue
    Requiredfalse
    Position7
    Requiredfalse
    Default ValueNone
    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

    ParameterValue
    Requiredfalse
    Position8
    Requiredfalse
    Default ValueNone
    Accept pipeline input?false
    Accept wildcard characters?false

    -OrderDirection <String>

    ParameterValue
    Requiredfalse
    Position9
    Requiredfalse
    Default ValueNone
    Accept pipeline input?false
    Accept wildcard characters?false

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

    ParameterValue
    Requiredfalse
    Position10
    Requiredfalse
    Default ValueCurrent
    Accept pipeline input?false
    Accept wildcard characters?false

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

    ParameterValue
    Requiredfalse
    Position11
    Requiredfalse
    Default ValueNone
    Accept pipeline input?true (ByPropertyName)
    Accept wildcard characters?false

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

    ParameterValue
    Requiredfalse
    Position12
    Requiredfalse
    Default Value1000
    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

    ParameterValue
    Requiredfalse
    Position13
    Requiredfalse
    Default Value0
    Accept pipeline input?false
    Accept wildcard characters?false

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.