Name
Show-JobSchedulerAgentStatus
SYNOPSIS
Show summary information and statistics information for a JobScheduler Agent.
SYNTAX
Show-JobSchedulerAgentStatus [[-Url] <Uri>] [[-Agents] <Uri[]>] [[-Path] <String>] [[-Timeout] <Int32>] [<CommonParameters>]
DESCRIPTION
This cmdlet is an alias for Get-JobSchedulerAgentStatus -Display -NoOutputs
PARAMETERS
Url
-Url <Uri>
Specifies the URL to access the Agent.
This parameter cannot be specified if the -Agents parameter is used.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
Agents
-Agents <Uri[]>
Specifies an array of URLs that point to Agents. This is useful if a number of Agents
should be checked at the same time, e.g. should the Agents from the result of the
Get-JobSchedulerAgentCluster cmdlet be checked.
This parameter cannot be specified if the -Url parameter is used.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
Path
-Path <String>
Specifies the URL path that is used to retrieve the Agent status.
Default: /jobscheduler/agent/api/overview
| Required? | false |
| Position? | 3 |
| Default value | /jobscheduler/agent/api/overview |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Timeout
-Timeout <Int32>
Specifies the number of milliseconds for establishing a connection to the JobScheduler Agent.
With the timeout being exceeded the Agent is considered being unavailable.
Default: 3000 ms
| Required? | false |
| Position? | 4 |
| Default value | 3000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Show-JobSchedulerAgentStatus http://localhost:4445
Returns the summary information of the JobScheduler Agent for the specified host and port.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JobSchedulerAgentCluster | Show-JobSchedulerAgentStatus
Returns the summary information and statistics information about all JobScheduler Agents that are configured with the JobScheduler Master that is currently in use.