Name
Get-JS7AgentReport
SYNOPSIS
Returns reporting information about job executions from a JS7 Agent
SYNTAX
Get-JS7AgentReport [[-AgentId] <String[]>] [[-AgentUrl] <Uri[]>] [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [-Display] [<CommonParameters>]
DESCRIPTION
Reporting information about job executions is returned from a JS7 Agent.
Reporting information includes e.g. the number of successfully executed tasks with an Agent.
The following REST Web Service API resources are used:
* /agents/report
PARAMETERS
AgentId
-AgentId <String[]>
Optionally specifies the unique identifier of an Agent. More than one Agent identifier can be specified using a comma.
Without the -AgentId and -AgentUrl parameters the report is created for all Agents registered with a Controller.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
AgentUrl
-AgentUrl <Uri[]>
Optionally specifies the URL that points to an Agent. More than one Agent URL can be specified using a comma.
Without the -AgentId and -AgentUrl parameters the report is created for all Agents registered with a Controller.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Optionally limits reporting results to Agents that are registered with the specified Controller.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Specifies the date starting from which job executions are reported.
| Required? | false |
| Position? | 4 |
| Default value | (Get-Date -Hour 0 -Minute 00 -Second 00).ToUniversalTime() |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
DateTo
-DateTo <DateTime>
Specifies the date up to which job executions are reported.
| Required? | false |
| Position? | 5 |
| Default value | (Get-Date).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Display
-Display <SwitchParameter>
Optionally specifies formatted output to be displayed.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7AgentReport -Display -DateFrom 2020-01-01
Displays reporting information about job executions with any Agents since first of January 2020.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7AgentReport -AgentUrl http://host-a:4445,http://host-b:4445 -Display
Returns reporting information about job executions with the indicated Agents for today. Formatted output is displayed.
-------------------------- EXAMPLE 3 --------------------------
PS > $report = Get-JS7AgentReport -DateFrom 2020-04-01 -DateTo 2020-06-30
Returns an object that includes reporting information for the second quarter 2020.
Overview
Content Tools