Get-AdtJob
Synopsis
Gets adTempus jobs.
Syntax
Name (Default)
Get-AdtJob [[-Name] <string[]>] [-Group <string>] [-Recurse] [-ExecutableOnly]
[-Connection <AdtConnection>] [-Server <string>] [-Credential <pscredential>]
Id
Get-AdtJob -Id <guid[]> [-ExecutableOnly] [-Connection <AdtConnection>] [-Server <string>]
[-Credential <pscredential>]
Description
Gets jobs by name or ID. A name can be a job name ("Job"), which searches all groups; a full path ("Group\Subgroup\Job"); or a job in the root group ("\Job"). Each part of the name can contain "*" wildcards. With no name, all jobs are returned.
Examples
Example 1
Get-AdtJob 'Nightly\*'
Gets all jobs in the Nightly group.
Example 2
Get-AdtJob -Group Finance -Recurse -ExecutableOnly
Gets the jobs in the Finance group and its subgroups that the current user can run.
Parameters
-Connection
The connection to use. See Connect-AdtServer.
| Type | AdtConnection |
|---|---|
| Required | False |
| Position | Named |
| Default value | None |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Credential
The credential used to connect to the -Server.
| Type | PSCredential |
|---|---|
| Required | False |
| Position | Named |
| Default value | None |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-ExecutableOnly
Returns only jobs that the current user has permission to run.
| Type | SwitchParameter |
|---|---|
| Required | False |
| Position | Named |
| Default value | False |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Group
The full name of the group to search, such as "Finance\Daily".
| Type | String |
|---|---|
| Parameter sets | Name |
| Required | False |
| Position | Named |
| Default value | None |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Id
The IDs of the jobs to get.
| Type | Guid[] |
|---|---|
| Parameter sets | Id |
| Required | True |
| Position | Named |
| Default value | None |
| Accept pipeline input | True (ByPropertyName) |
| Accept wildcard characters | False |
-Name
The job names to find.
| Type | String[] |
|---|---|
| Parameter sets | Name |
| Required | False |
| Position | 0 |
| Default value | None |
| Accept pipeline input | True (ByValue) |
| Accept wildcard characters | True |
-Recurse
Also searches the subgroups of the -Group.
| Type | SwitchParameter |
|---|---|
| Parameter sets | Name |
| Required | False |
| Position | Named |
| Default value | False |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Server
The server to connect to, if no connection is specified.
| Type | String |
|---|---|
| Required | False |
| Position | Named |
| Default value | None |
| Accept pipeline input | False |
| Accept wildcard characters | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
System.String[]
Job names.
System.Guid[]
Job IDs, from the Id property of piped objects.
Outputs
ArcanaDevelopment.adTempus.Client.Job
A job.
Notes
This cmdlet uses the connection that fetched the objects piped to it. Otherwise it uses the connection given by -Connection, or a connection to -Server (reused if one is already open for the same server and user), or the default connection. If no connection is open, it connects to the local server using Windows authentication. See Connect-AdtServer.