Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Get-JS7Notification

SYNOPSIS

Returns Notification entries

...

-ControllerId <String>
Optionally specifies the unique identifier of the Controller for which notifications should be returned.

Required?false
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

DateFrom

-DateFrom <DateTime>
Specifies the date starting from which notifications should be returned.
Consider that a UTC date has to be provided.

Default: Begin of the current day as a UTC date

Required?false
Position?2
Default value(Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime()
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

RelativeDateFrom

-RelativeDateFrom <String>
Specifies a relative date starting from which notifications should be returned, for example

* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -1d, -2d: one day ago, two days ago
* -1w, -2w: one week ago, two weeks ago
* -1M, -2M: one month ago, two months ago
* -1y, -2y: one year ago, two years ago

Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ. This , that is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

Required?false
Position?3
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted from the history information.
A timezone can e.g. be specified like this:

Get-JS7Notification -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JS7 are UTC and can be converted e.g. to the local time zone like this:

Get-JS7Notification -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

Required?false
Position?4
Default value(Get-Timezone -Id 'UTC')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Limit

-Limit <Int32>
Specifies the max. number of notifications to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.

Required?false
Position?5
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

...