Name
Get-JobSchedulerDailyPlan
SYNOPSIS
Returns the daily plan items for job streams, jobs and orders of JobScheduler.
...
Get-JobSchedulerDailyPlan [[-JobChain] <String>] [[-OrderId] <String>] [[-Job] <String>] [[-Directory] <String>] [-Recursive] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [-Late] [-Successful] [-Failed] [-Incomplete] [-Planned] [-IsJobStream] [<CommonParameters>]
DESCRIPTION
...
-JobChain <String>
Optionally specifies the path and name of a job chain for which daily plan items should be returned.
If the name of a job chain is specified then the -Directory parameter is used to determine the folder.
Otherwise the -JobChain parameter is assumed to include the full path and name of the job chain.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
OrderId
-OrderId <String>
Optionally specifies the path and name of an order for which daily plan items should be returned.
If the name of an order is specified then the -Directory parameter is used to determine the folder.
Otherwise the -OrderId parameter is assumed to include the full path and name of the order.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Job
-Job <String>
Optionally specifies the path and name of a job for which daily plan items should be returned.
If the name of a job is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Job parameter is assumed to include the full path and name of the job.
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the folder for which daily plan items should be returned. The directory is determined
from the root folder, i.e. the "live" directory and should start with a "/".
Required? | false |
Position? | 4 |
Default value | / |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
When used with the -Directory parameter then any sub-folders of the specified directory will be looked up.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan items should be returned.
Default: Begin of the current day.
Required? | false |
Position? | 5 |
Default value | (Get-Date -Hour 0 -Minute 00 -Second 00).ToUniversalTime() |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
DateTo
-DateTo <DateTime>
Optionally specifies the date until which daily plan items should be returned.
Default: End of the current day.
Required? | false |
Position? | 6 |
Default value | (Get-Date -Hour 0 -Minute 00 -Second 00).AddDays(1).ToUniversalTime() |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Late
-Late <SwitchParameter>
Specifies that daily plan items are returned that did start later than expected.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Successful
-Successful <SwitchParameter>
Specifies that daily plan items are returned that did complete successfully.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Failed
-Failed <SwitchParameter>
Specifies that daily plan items are returned that did complete with errors.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Incomplete
-Incomplete <SwitchParameter>
Specifies that daily plan items are returned that did not yet complete.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Planned
-Planned <SwitchParameter>
Specifies that daily plan items are returned that did not yet start.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
IsJobStream
-IsJobStream <SwitchParameter>
Limits results to Job Streams only.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
...
Returns the daily plan items for any orders of the given job chain.
-------------------------- EXAMPLE 5 --------------------------
PS > $items = Get-JobSchedulerDailyPlan -IsJobStream -Planned
Returns the daily plan items for job streams that are planned for the current day.