PowerShell CLI 2.0 - Cmdlets - Get-JS7TaskLog

Name

Get-JS7TaskLog

SYNOPSIS

Returns the task log from the JS7 History

SYNTAX

Get-JS7TaskLog [[-ControllerId] <String>] [[-AgentUrl] <String>] [-TaskId] <String> [[-OrderId] <String>] [[-Workflow] <String>] [[-Position] <String>] [[-Job] <String>] [[-Criticality] <String>] [[-ExitCode] <Int32>] [[-State] <PSObject>] [[-StartTime] <DateTime>] [[-EndTime] <DateTime>] [<CommonParameters>]

DESCRIPTION

Returns a task log for a given Task ID. This cmdlet is mostly used for pipelined input from the
Get-JS7TaskHistory 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.

The following REST Web Service API resources are used:

* /task/log/download

PARAMETERS

ControllerId

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

AgentUrl

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

TaskId

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

OrderId

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

Workflow

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

Position

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

Job

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

Criticality

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

ExitCode

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

State

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

StartTime

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

EndTime

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

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Get-JS7TaskHistory -WorkflowPath /product_demo/sample_workflow -Job job174 | Get-JS7TaskLog

Retrieves the most recent task log for the given job.

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

PS > Get-JS7TaskHistory -WorkflowPath /product_demo/sample_workflow -Job job174 | Get-JS7TaskLog | Out-File /tmp/job174.log -Encoding Unicode

Writes the task log to a file.

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

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

Reads the logs of tasks that completed within the last 8 hours and writes the log output to individual files. The log file names are created from the start time and the job name of each task.

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

PS > # execute once
$lastHistory = Get-JS7TaskHistory -RelativeDateFrom -8h | Sort-Object -Property startTime
# execute in intervals
Get-JS7TaskHistory -DateFrom $lastHistory[0].startTime | Tee-Object -Variable lastHistory | Get-JS7TaskLog | 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 initial execution of the Get-JS7TaskHistory 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.