...
Name
Get-JobSchedulerAgentStatus
SYNOPSIS
Return summary information and statistics information from a JobScheduler Agent.
SYNTAX
Get-JobSchedulerAgentStatus [-Url <Uri>] [-Agents] <Uri[]>] [-Path <String>Display] [-Timeout <Int32>] -Display [-NoO
utputs] <CommonParameters><CommonParameters>]
DESCRIPTION
Summary information and statistics information are 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
Url
...
...
Agents
...
...
Agents
-Agents <Uri[]>
Specifies an array of URLs that point to Agents. This is useful if a number of specific Agents
should be checked at the same time, e.g. should the Agents from the result of the
Get-JobSchedulerAgentCluster cmdlet . Without this parameter all Agents configured for a Master will be checked.
This parameter cannot be specified if the -Url parameter is used.
| Required? | false |
| Position? |
...
| 1 | |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters |
...
Path
-Path <String>
Specifies the URL path that is used to retrieve the Agent status.
Default: /jobscheduler/agent/api/overview
...
| ? |
...
...
| 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
Accept pipeline input? false
Accept wildcard characters?
Display
-Display <SwitchParameter>
Optionally specifies formatted output to be displayed.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters |
...
NoOutputs
-NoOutputs <SwitchParameter>
Optionally specifies that no output is returned by this cmdlet.
...
| ? |
...
...
| false |
...
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Get-JobSchedulerAgentStatus http://localhost:4455
PS > Get-JobSchedulerAgentStatus -Display
Displays Returns summary information about the JobScheduler Agentall JobScheduler Agents configured for the current Master.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>GetPS > Get-JobSchedulerAgentStatus -Url Agents http://localhost:44554445 -Display
Returns summary information about the Agent. Formatted output is displayed.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$status PS > $status = Get-JobSchedulerAgentStatus -Agents http://localhost:44554445
Returns a status information object.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>$status = GetJobScheduler-AgentCluster /agent/fixed_priority_scheduling_agent | Get-JobSchedulerAgentStatus
Returns an array of status information objects each representing the state of an Agent in the cluster.