Versions Compared

Key

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

Name

Get-JobSchedulerJobHistory

SYNOPSIS

Returns JobScheduler history items for jobs.

...

-Job <String>
Specifies the path and name of a job.
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?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

JobChain

-JobChain <String>
Optionally specifies the path and name of a job chain that includes jobs.
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?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Directory

-Directory <String>
Optionally specifies the folder for which jobs should be returned. The directory is determined
from the root folder, i.e. the "live" directory.

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

Recursive

-Recursive <SwitchParameter>
Specifies that sub-folders should be looked up if the -Directory parameter is used and no job or job chain is specified.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Compact

-Compact <SwitchParameter>
Specifies a more compact response with fewer job history attributes.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

WithLog

-WithLog <SwitchParameter>
Specifies the task log to be returned.

This operation is time-consuming and should be restricted to selecting individual jobs.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

MaxLastHistoryItems

-MaxLastHistoryItems <Int32>
Specifies the number of items that are returned from the history. Items are provided
in descending order starting with the latest history item.

Default: 1

Required?false
Position?4
Default value1
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_jobscheduler

...