Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

Get-JobSchedulerAgentStatus

SYNOPSIS

Return summary information and statistics information from a JobScheduler Agent.

SYNTAX

Get-JobSchedulerAgentStatus [-Url <Uri>] [-Agents <Uri[]>] [-Path <String>] [-Timeout <Int32>] -Display [-NoO
utputs] <CommonParameters>

DESCRIPTION

Summary information and statistics information are returned from a JobScheduler Agent.

...

This cmdlet can be used to check if an Agent is available.

PARAMETERS

Url

-Url <Uri>
Specifies the URL to access the Agent.

...

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters?

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.

...

Required? false
Position? 2
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.

...

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters?

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.

...

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
Accept pipeline input? false
Accept wildcard characters?

NoOutputs

-NoOutputs <SwitchParameter>
Optionally specifies that no output is returned by this cmdlet.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?

about_jobscheduler

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

...