Versions Compared

Key

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

NAME

Get-JobSchedulerAgentCluster

SYNOPSIS

Returns a number of Agent clusters from the JobScheduler Master. Agent clusters correspond to process class
objects in JobScheduler Master.

SYNTAX

Get-JobSchedulerAgentCluster [-Directory <String>] [-AgentCluster <String>] -NoSubfolders -NoCache [<CommonPara
meters>]

DESCRIPTION

Agent clusters are retrieved from a JobScheduler Master, they correspond to process classes that specify
a remote JobScheduler instance.

...

Resulting Agent clusters can be forwarded to cmdlets, such as Get-JobSchedulerAgentStatus, for pipelined bulk operation
s.

PARAMETERS

Directory

-Directory <String>
Optionally specifies the folder for which Agent clusters should be returned. The directory is determined
from the root folder, i.e. the "live" directory.

...

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

AgentCluster

-AgentCluster <String>
Optionally specifies the path and name of an Agent cluster that should be returned.
If the name of an Agent cluster is specified then the -Directory parameter is used to determine the folder.
Otherwise the -AgentCluster parameter is assumed to include the full path and name of the Agent cluster.

...

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

NoSubfolders

-NoSubfolders <SwitchParameter>
Specifies that no subfolders should be looked up. By default any subfolders will be searched for Agent clusters.

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

NoCache

-NoCache <SwitchParameter>
Specifies that the cache for JobScheduler Agent objects is ignored.
This results in the fact that for each Get-Agent* cmdlet execution the response is
retrieved directly from the JobScheduler Master and is not resolved from the cache.

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

about_jobscheduler

EXAMPLES

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

...