Versions Compared

Key

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

Name

Get-JobSchedulerTaskLog

SYNOPSIS

Read the task log from the JobScheduler History.

...

Get-JobSchedulerTaskLog [[-TaskId] <String> ] [[-Job] <String>] [[-StartTime] <DateTime>] [[-EndTime] <DateTime>] [[-ExitCode] <int><Int32>] [[-State] <PSCustomObject><PSObject>] [[-Criticality] <String>] [[-JobSchedlerIDJobSchedulerId] <String>] [[-ClusterMember] <String>] [<CommonParameters>]

...

Reads a task log for a given task ID. This cmdlet is mostly used for pipelined input from the
Get-JobScchedulerTaskHistoryJobSchedulerTaskHistory cmdlet that allows to search the execution history of tasks and
that returns task IDs that are used by this cmdlet to retrieve the task's log output.

...

-TaskId <String>
Specifies the ID that the task was running with. This information is provided by the
Get-JobSchedulerTaskHistory cmdlet.

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

Job

-Job <String>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory cmdlet and forwards the parameter to the resulting object.

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

StartTime

-StartTime <DateTime>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

EndTime

-EndTime <DateTime>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

ExitCode

-ExitCode <int><Int32>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

State

-State <PSCustomObject><PSObject>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

Criticality

-Criticality <String>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

JobSchedulerId

-JobSchedulerId <String>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

ClusterMember

-ClusterMember <String>
This parameter is used to accept pipeline input from the Get-JobSchedulerTaskHistory   cmdlet and forwards the parameter to the resulting object.

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

about_jobschedulerJobScheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Get> Get-JobSchedulerTaskHistory -Job /some/job174 | Get-JobSchedulerTaskLog

...

-------------------------- EXAMPLE 2 --------------------------

PS > Get> Get-JobSchedulerTaskHistory -Job /some/job174 | Get-JobSchedulerTaskLog | Out-File /tmp/job174.log -Encoding Unicode

...

-------------------------- EXAMPLE 3 --------------------------

PS > Get> Get-JobSchedulerTaskHistory -RelativeDateFrom -8h | Get-JobSchedulerTaskLog | Select-Object @{name='path'; expression={ "/tmp/history/$(Get-Date $_.startTime -f 'yyyyMMdd-hhmmss')-$([io.path]::GetFileNameWithoutExtension($_.job)).log"}}, @{name='value'; expression={ $_.log }} | Set-Content

...

-------------------------- EXAMPLE 4 --------------------------

PS > # > # execute once
PS > $lastHistory $lastHistory = Get-JobSchedulerTaskHistory -RelativeDateFrom -8h | Sort-Object -Property startTime
PS > # # execute by interval
PS > GetGet-JobSchedulerTaskHistory -DateFrom $lastHistory[0].startTime | Tee-Object -Variable lastHistory | Get-JobSchedulerTaskLog | Select-Object @{name='path'; expression={ "/tmp/history/$(Get-Date $_.startTime -f 'yyyyMMdd-hhmmss')-$([io.path]::GetFileNameWithoutExtension($_.job)).log"}}, @{name='value'; expression={ $_.log }} | Set-Content

Provides a mechanism to subsequently retrieve previous logs. Starting from intial execution of the Get-JobSchedulerTaskHistory cmdlet the resulting $lastHistory object is used for any subsequent calls.
Consider use of the Tee-Object cmdlet in the pipeline that updates the $lastHistory object that can be used for later executions of the same pipeline.
The pipeline can e.g. be executed in a cyclic job.