Name
Get-JobSchedulerAgentStatus
SYNOPSIS
Return summary information from a JobScheduler Agent.
SYNTAX
Get-JobSchedulerAgentStatus [[-Agents] <Uri[]>] [-Display] [<CommonParameters>]
DESCRIPTION
Summary information is returned from a JobScheduler Agent.
* Summary information includes e.g. the start date and JobScheduler Agent release.
This cmdlet can be used to check if an Agent is available.
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 |
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-JobSchedulerAgentStatus -Display
Displays summary information about all JobScheduler Agents configured for the current Master.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerAgentStatus -Agents http://localhost:4445 -Display
Returns summary information about the Agent. Formatted output is displayed.
-------------------------- EXAMPLE 3 --------------------------
PS > $status = Get-JobSchedulerAgentStatus -Agents http://localhost:4445
Returns a status information object.