Name
Get-JobSchedulerAgentCluster
SYNOPSIS
Returns Agent Clusters from the JobScheduler Master.
SYNTAX
Get-JobSchedulerAgentCluster [[-AgentCluster] <String>] [[-Directory] <String>] [-Recursive] [-Compact] [[-State] <Int32>] [<CommonParameters>]
DESCRIPTION
Agent Clusters are retrieved from a JobScheduler Master.
Agent Clusters can be selected either by the folder of the Agent Cluster location including sub-folders
or by an individual Agent Cluster.
Resulting Agent Clusters can be forwarded to cmdlets, such as Get-JobSchedulerAgentStatus, for pipelined bulk operations.
PARAMETERS
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? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up. By default no sub-folders will be searched for Agent Clusters.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Compact
-Compact <SwitchParameter>
| 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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster
Returns all Agent Clusters.
-------------------------- EXAMPLE 2 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster -Directory /some_folder -Recursive
Returns all Agent Clusters that are configured with the folder "some_folder" (starting from the "live" directory) and any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
PS > $agentClusters = Get-JobSchedulerAgentCluster -AgentCluster /test/globals/Agent_01
Returns the Agent Cluster "Agent_01" from the folder "/test/globals".