Page History
...
SYNTAX
Get-JS7AgentReport [[-AgentsAgentId] <String[]>] [[-AgentUrl] <Uri[]>] [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [-Display] [<CommonParameters>]
...
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 -Agents <Uri[]>
Specifies an array of URLs that point to Agents. This is useful if specific Agents
should be checked. Without this parameter 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 will be checked.
| Required? | false |
| Position? | 12 |
| 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 <DateTime>
Specifies the date starting from which job executions are reported.
| Required? | false |
| Position? | 24 |
| Default value | (Get-Date -Hour 0 -Minute 00 -Second 00).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
-DateTo <DateTime>
Specifies the date up to which job executions are reported.
| Required? | false |
| Position? | 35 |
| Default value | (Get-Date).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input?false | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
...
Displays reporting information about job executions sind with any Agents since first of January 2020.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7AgentReport -Agents AgentUrl http://host-a:4445,http://host-b:4445 -Display
...
Overview
Content Tools