Job.RemoveFromTargetServerGroup Method
Removes a group of execution target servers 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
'Deklaracja
Public Sub RemoveFromTargetServerGroup ( _
groupName As String _
)
public void RemoveFromTargetServerGroup (
string groupName
)
public:
void RemoveFromTargetServerGroup (
String^ groupName
)
public void RemoveFromTargetServerGroup (
String groupName
)
public function RemoveFromTargetServerGroup (
groupName : String
)
Parameters
- groupName
A String value that specifies a group of execution targets.
Remarks
When Microsoft SQL Server Agent acts as a master server for multiserver administration servers, known execution targets servers can be grouped for easier targeting of multiple servers at the same time.
When you create, schedule, and run jobs, use either the ApplyToTargetServer or 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 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.
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.
Target Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server.