Job.RemoveFromTargetServer Método

Artículo
04/26/2013

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

Espacio de nombres: Microsoft.SqlServer.Management.Smo.Agent
Ensamblado: Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Sintaxis

'Declaración
Public Sub RemoveFromTargetServer ( _
    serverName As String _
)
'Uso
Dim instance As Job 
Dim serverName As String

instance.RemoveFromTargetServer(serverName)

public void RemoveFromTargetServer(
    string serverName
)

public:
void RemoveFromTargetServer(
    String^ serverName
)

member RemoveFromTargetServer : 
        serverName:string -> unit

public function RemoveFromTargetServer(
    serverName : String
)

Parámetros

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

Comentarios

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.

Ejemplos

The following code example disables the "Test Job" job and deletes all defined steps from it.

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

PowerShell

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