...
Get-JobSchedulerAgentCluster
SYNOPSIS
Returns a number of Agent Clusters clusters from the JobScheduler Master. Agent clusters correspond to process class objects in JobScheduler Master.
SYNTAX
Get-JobSchedulerAgentCluster [[-AgentClusterDirectory] <String>] [[-DirectoryAgentCluster] <String>] [-RecursiveNoSubfolders] [-CompactNoCache] [ [-State] <Int32>] [<CommonParameters>]
DESCRIPTION
Agent Clusters clusters are retrieved from a JobScheduler Master, they correspond to process classes that specify
a remote JobScheduler instance.
Agent Clusters clusters can be selected either by the folder of the Agent Cluster cluster location including sub-folders subfolders
or by an individual Agent Clustercluster.
Resulting Agent Clusters clusters can be forwarded to cmdlets, such as Get-JobSchedulerAgentStatus, for pipelined bulk operations.
PARAMETERS
...
Directory
-AgentCluster Directory <String>
Optionally specifies the path and name of an Agent Cluster that folder for which Agent clusters should be returned. The directory is determined
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 Clusterfrom the root folder, i.e. the "live" directory.
One of the parameters -Directory or and -AgentCluster has to be specified.
| Required? | false |
| Position? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
AgentCluster
-Directory AgentCluster <String>
Optionally specifies the folder for which Agent Clusters path and name of an Agent cluster that should be returned. The directory is determined
from the root folder, i.e. the "live" directory
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 and or -AgentCluster has to be specified.
| Required? | false |
| Position? | 2 |
| Default value/ | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
NoSubfolders
-Recursive NoSubfolders <SwitchParameter>
Specifies that any sub-folders no subfolders should be looked up. By default no sub-folders any subfolders will be searched for Agent Clustersclusters.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName)false |
| Accept wildcard characters? | false |
...
NoCache
-Compact <SwitchParameter>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? | true (ByPropertyName) | Accept wildcard characters? | false |
State
-State <Int32>
| Required? | false | ||
| Position? | 3 | ||
| Default value | 0 | ||
| Accept pipeline input? | true (ByPropertyName) | Accept wildcard characters? | false |
...
PS > $agentClusters = Get-JobSchedulerAgentCluster
Returns all Agent Clustersclusters.
-------------------------- EXAMPLE 2 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster -Directory / some_folder -RecursiveNoSubfolders
Returns all Agent Clusters clusters that are configured with the folder "some_root folder " (starting from the "live" directory) and any sub-folderswithout consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster -AgentCluster /test/globals/Agent_01
Returns the Agent Cluster cluster "Agent_01" from the folder "/test/globals".