Share via

Job.RemoveFromTargetServer Method

  • Article

Removes an execution target server from the list of target servers maintained for a job.

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

Syntax

'Declaration
Public Sub RemoveFromTargetServer ( _
    serverName As String _
)

public void RemoveFromTargetServer (
    string serverName
)

public:
void RemoveFromTargetServer (
    String^ serverName
)

public void RemoveFromTargetServer (
    String serverName
)

public function RemoveFromTargetServer (
    serverName : String
)

Parameters

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

Remarks

When you create, schedule, and run jobs, use either the ApplyToTargetServer or the ApplyToTargetServerGroup method to add an execution target server. When a single execution target has been added by using the ApplyToTargetServer method, the RemoveFromTargetServer method can be used to remove it.

When a job is targeted to run on the local server running Microsoft SQL Server Agent, specify the server name using the string (local) when removing the execution target.

When an execution target is removed from a multiserver job, the master server posts an instruction to the target server. This indicates that the target server should drop its local copy of the job. The job is removed from the target server but remains defined at the master server. To completely remove a job from all participating servers, use the Job object's RemoveAllJobSteps method or the JobServer object's RemoveJobByID.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Create a Job with Steps and a Schedule in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Job Class
Job Members
Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Scheduling Automatic Administrative Tasks in SQL Server Agent
Automating Administrative Tasks (SQL Server Agent)
sp_delete_targetsvrgrp_member (Transact-SQL)