PowerShell CLI 2.0 - Cmdlets - Get-JS7FileTransferHistory

Name

Get-JS7FileTransferHistory

SYNOPSIS

Returns the history of file transfers performed with YADE

SYNTAX

Get-JS7FileTransferHistory [[-ControllerId] <String>] [[-Operation] <String[]>] [[-Profile] <String[]>] [[-Source] <String[]>] [[-Target] <String[]>] [[-SourceFile] <String[]>] [[-TargetFile] <String[]>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Limit] <Int32>] [-Compact] [-Successful] [-Failed] [-InProgress] [<CommonParameters>]

DESCRIPTION

File transfer history information is returned for file transfers performed with YADE from a JS7 workflow.
File transfers can be selected by YADE profile, file name, history status etc.

The history information returned includes start time, end time, status etc. of a file transfer.
File transfers can include any number of files. For information about individual files
the Get-JS7FileTransferHistoryFile cmdlet can be used.

This cmdlet can be used for pipelining to return information about individual files like this:

$files = Get-JS7FileTransferHistory -RelativeDateFrom -1w -Successful | Get-JS7FileTransferHistoryFile

The following REST Web Service API resources are used:

* /yade/transfers

PARAMETERS

ControllerId

-ControllerId <String>
Optionally limits file transfer history items to workflows that have been executed which the indicated Controller.

Operation

-Operation <String[]>
Optionally limits file transfer history items to the ones using one or more of the following operations:

* COPY
* MOVE
* GETLIST
* RENAME

A number of operations can be specified by use of a comma, for example: -Operation COPY,MOVE.

Profile

-Profile <String[]>
Optionally limits file transfer history items to the ones using the indicated YADE file transfer profile.

This parameter accepts any number of profiles separated by a comma.

Source

-Source <String[]>
Optionally specifies the host and port that act as the source of a file transfer to limit the file transfer history items returned.
Depending on the source protocol in use this can be the localhost for a local source or
the host configured with a file transfer fragment that is used as the source.

A source is specified by the hostname and optionally a port that are separated by a colon, for example: -Source some_host:22.

This parameter accepts any number of sources separated by a comma.

Target

-Target <String[]>
Optionally specifies the host and port that act as the target of a file transfer to limit the file transfer history items returned.
Depending on the target protocol in use this can be the localhost for a local target or
the host configured with a file transfer fragment that is used as the target.

A target is specified by the hostname and optionally a port that are separated by a colon, for example: -Target some_host:22.

This parameter accepts any number of targets separated by a comma.

SourceFile

-SourceFile <String[]>
Optionally specifies the name of a source file to limit the file transfer history items returned.

This parameter accepts any number of source file names separated by a comma.

TargetFile

-TargetFile <String[]>
Optionally specifies the name of a target file to limit the file transfer history items returned.

This parameter accepts any number of target file names separated by a comma.

DateFrom

-DateFrom <DateTime>
Specifies the date starting from which file transfer history items should be returned.
Consider that a UTC date has to be provided.

Default: Begin of the current day as a UTC date

DateTo

-DateTo <DateTime>
Specifies the date until which file transfer history items should be returned.
Consider that a UTC date has to be provided.

Default: End of the current day as a UTC date

RelativeDateFrom

-RelativeDateFrom <String>
Specifies a relative date starting from which file transfer history items should be returned, for example:

* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -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 time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ. This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

RelativeDateTo

-RelativeDateTo <String>
Specifies a relative date until which file transfer history items should be returned, for example:

* -1s, -2s: one second ago, two seconds ago
* -1m, -2m: one minute ago, two minutes ago
* -1h, -2h: one hour ago, two hours ago
* -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 time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ. This is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted available from the file transfer history.
A timezone can be specified like this:

Get-JS7FileTransferHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JS7 are UTC and can be converted e.g. to the local time zone like this:

Get-JS7FileTransferHistory -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

Limit

-Limit <Int32>
Specifies the max. number of history items for file transfers to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.

Compact

-Compact <SwitchParameter>
Specifies the a smaller subset of properties to be returned with the file transfer history items.

Successful

-Successful <SwitchParameter>
Returns history items for successfully completed file transfers.

Failed

-Failed <SwitchParameter>
Returns history items for failed file transfers.

InProgress

-InProgress <SwitchParameter>
Specifies that history items for running file transfers should be returned.

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $items = Get-JS7FileTransferHistory

Returns today's file transfer history from any workflows.

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

PS > $items = Get-JS7FileTransferHistory -Profile copy_to_remote,move_to_remote

Returns today's file transfers that have been performed by use of the indicated YADE profiles.

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

PS > $items = Get-JS7FileTransferHistory -Timezone (Get-Timezone)

Returns today's file transfers with dates being converted to the local timezone.

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

PS > $items = Get-JS7FileTransferHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')

Returns today's file transfers with dates being converted to the GMT timezone.

-------------------------- EXAMPLE 5 --------------------------

PS > $items = Get-JS7FileTransferHistory -Successful -DateFrom "2020-08-11 14:00:00Z"

Returns the file transfer history for successfully completed orders that started after the specified UTC date and time.

-------------------------- EXAMPLE 6 --------------------------

PS > $items = Get-JS7FileTransferHistory -Failed -DateFrom (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(-7).ToUniversalTime()

Returns the file transfer history for any failed orders for the last seven days.

-------------------------- EXAMPLE 7 --------------------------

PS > $items = Get-JS7FileTransferHistory -RelativeDateFrom -7d

Returns the file transfer history for the last seven days. The history is reported starting from midnight UTC.

-------------------------- EXAMPLE 8 --------------------------

PS > $items = Get-JS7FileTransferHistory -RelativeDateFrom -7d+01:00

Returns the file transfer history for the last seven days. The history is reported starting from 1 hour after midnight UTC.

-------------------------- EXAMPLE 9 --------------------------

PS > $items = Get-JS7FileTransferHistory -RelativeDateFrom -7d+TZ

Returns the file transfer history for the last seven days. The history is reported starting from midnight in the same timezone that is used with the -Timezone parameter.

-------------------------- EXAMPLE 10 --------------------------

PS > $items = Get-JS7FileTransferHistory -RelativeDateFrom -1w

Returns the file transfer history for the last week.