• Article

Job.ApplyToTargetServer Method

Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Sub ApplyToTargetServer ( _
    serverName As String _
)
'Usage
Dim instance As Job
Dim serverName As String

instance.ApplyToTargetServer(serverName)

public void ApplyToTargetServer(
    string serverName
)

public:
void ApplyToTargetServer(
    String^ serverName
)

member ApplyToTargetServer : 
        serverName:string -> unit 

public function ApplyToTargetServer(
    serverName : String
)

Parameters

  • serverName
    Type: System.String
    A String value that specifies the name of the execution target server.

Remarks

Before a SQL Server Agent job can execute, the job must have at least one step and an execution target.

Use either the ApplyToTargetServer or ApplyToTargetServerGroup method to add an execution target. When the job is to run on the local server, use the ApplyToTargetServer method to target the job and specify the server by using the string (local).

Examples

The following code example creates a job and sets it to execute on the local server.

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.Create();
jb.ApplyToTargetServer("(locl)");

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.Create()
$jb.ApplyToTargetServer("(local)")