Job.EnumTargetServers Method
Enumerates a list of execution target servers that have been assigned to the referenced job.
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Function EnumTargetServers As DataTable
'Usage
Dim instance As Job
Dim returnValue As DataTable
returnValue = instance.EnumTargetServers()
public DataTable EnumTargetServers()
public:
DataTable^ EnumTargetServers()
member EnumTargetServers : unit -> DataTable
public function EnumTargetServers() : DataTable
Return Value
Type: System.Data.DataTable
A DataTable object value that contains a list of execution target servers and information about the referenced job when it is run on the target servers. The table describes the different columns of the returned DataTable.
Column |
Data type |
Description |
|---|---|---|
Name |
String |
The name of the instance of Microsoft SQL Server that is a target server. |
ID |
Int32 |
The ID value of the target server. |
LastRunOutcome |
Int32 |
The numeric value that specifies the way in which the job finishes on the target server that is listed in the CompletionAction enumeration. |
LastRunOutcomeMessage |
String |
The message that was recorded with the last completion of the job on the target server. |
LastRunDate |
DateTime |
The date and time when the job was last run on the target server. |
LastRunDuration |
Int32 |
The time it took to complete when the job was last run on the target server, in seconds. |
EnlistDate |
DateTime |
The date and time when the target server was enlisted. |
LastPollDate |
DateTime |
The date and time when the target server last polled the master server for any outstanding jobs to be executed. |
Examples
The following code example creates a job then displays the target execution servers.
C#
Server srv = new Server("(local)");
Job jb = srv.JobServer.Jobs["Test Job"];
DataTable serverList = jb.EnumTargetServers();
PowerShell
$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = $srv.JobServer.Jobs["Test Job"]
$serverList = $jb.EnumTargetServers()
See Also
Reference
Microsoft.SqlServer.Management.Smo.Agent Namespace
Other Resources
Scheduling Automatic Administrative Tasks in SQL Server Agent