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] [<CommonParameters>]
DESCRIPTION
Agent clusters are retrieved from a JobScheduler Master, they correspond to process classes that specify
a remote JobScheduler instance.
Agent clusters can be selected either by the folder of the Agent cluster location including subfolders
or by an individual Agent cluster.
Resulting Agent clusters can be forwarded to cmdlets, such as Get-JobSchedulerAgentStatus, for pipelined bulk operations.
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.
One of the parameters -Directory and -AgentCluster has to be specified.
| Required? | false |
| Position? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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.
One of the parameters -Directory or -AgentCluster has to be specified.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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 | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
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 | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster
Returns all Agent clusters.
-------------------------- EXAMPLE 2 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster -Directory / -NoSubfolders
Returns all Agent clusters that are configured with the root folder ("live" directory) without consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster -AgentCluster /test/globals/Agent_01
Returns the Agent cluster "Agent_01" from the folder "/test/globals".