...
Get-JobSchedulerJobStreamHistory [[-JobStream] <String>] [[-State] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Limit] <Int32>] [-Successful] [-Failed] [-Incomplete] [-WithTasks] [<CommonParameters>]
...
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
State
-State <String>
| Required? | false | Position? | 2 | Default value |
| Accept pipeline input? | true (ByPropertyName) | |||
| Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Specifies the date starting from which history items 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? | 32 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-DateTo <DateTime>
Specifies the date until which history items should be returned.
Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 43 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.
* -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 timezone time offset can be specified, e.g. -1d+02:00, as otherwise a midnight UTC date is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, 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? | 54 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateTo <String>
Specifies a relative date until which history items should be returned, e.g.
* -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 timezone time offset can be specified, e.g. -1d+02:00, as otherwise a midnight UTC date is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ, that is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateTo DateFrom parameter.
| Required? | false |
| Position? | 65 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the history information.
A timezone can e.g. be specified like this:
Get-JSJobStreamHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')
All dates in JobScheduler are UTC and can be converted e.g. to the local time zone like this:
Get-JSJobStreamHistory -Timezone (Get-Timezone)
Default: Dates are returned in UTC.
| Required? | false |
| Position? | 76 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Limit <Int32>
Specifies the max. number of history items for job stream executions to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.
| Required? | false |
| Position? | 87 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-WithTasks <SwitchParameter>
Specifies that to the history information that is returned an additional record for each task is added.
This allows to receive the list of tasks executed for each job stream in the order of their start time.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
about_jobschedulerJobScheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
...