Name
Get-JobSchedulerAgentReport
SYNOPSIS
Return reporting information about job executions from a JobScheduler Agent.
SYNTAX
Get-JobSchedulerAgentReport [[-Agents] <Uri[]>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [-Display] [<CommonParameters>]
DESCRIPTION
Reporting information about job executions is returned from a JobScheduler Agent.
* Reporting information includes e.g. the number of successfully executed tasks with an Agent.
PARAMETERS
Agents
-Agents <Uri[]>
Specifies an array of URLs that point to Agents. This is useful if specific Agents
should be checked. Without this parameter all Agents configured for a Master will be checked.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Specifies the date starting from which job executions are reported.
| Required? | false |
| Position? | 2 |
| Default value | (Get-Date -Hour 0 -Minute 00 -Second 00).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateTo
-DateTo <DateTime>
Specifies the date up to which job executions are reported.
| Required? | false |
| Position? | 3 |
| 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? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JobSchedulerAgentReport -Display -DateFrom 2020-01-01
Displays reporting information about job executions sind first of January 2020.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerAgentReport -Agents http://localhost:4445 -Display
Returns reporting information about Agent job executions for today. Formatted output is displayed.
-------------------------- EXAMPLE 3 --------------------------
PS > $report = Get-JobSchedulerAgentReport -DateFrom 2020-04-01 -DateTo 2020-06-30
Returns an object that includes reporting information for the second quarter 2020.