sp_apply_job_to_targets (T-SQL)

Applies a job to one or more target servers or to the target servers belonging to one or more target server groups.

Syntax

sp_apply_job_to_targets [@job_id =] job_id | [@job_name =] 'job_name'
    [, [@target_server_groups =] 'target_server_groups']
    [, [@target_servers =] 'target_servers']
    [, [@operation =] 'operation']

Arguments

[@job_id =] job_id

Is the job identification number of the job to apply to the specified target servers or target server groups. job_id is uniqueidentifier, with a default of NULL.

[@job_name =] 'job_name'

Is the name of the job to apply to the specified the associated target servers or target server groups. job_name is sysname, with a default of NULL.

---

Note Either job_id or job_name must be specified, but both cannot be specified.

---

[@target_server_groups =] 'target_server_groups'

Is a comma-separated list of target server groups to which the specified job is to be applied. target_server_groups is nvarchar(1024), with a default of NULL.

[@target_servers =] 'target_servers'

Is a comma-separated list of target servers to which the specified job is to be applied. target_servers is nvarchar(1024), with a default of NULL.

[@operation =] 'operation'

Is whether the specified job should be applied to or removed from the specified target servers or target server groups. operation is varchar(7), with a default of APPLY. Valid operations are APPLY and REMOVE.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sp_apply_job_to_targets provides an easy way to apply (or remove) a job from multiple target servers, and is an alternative to calling sp_add_jobserver (or sp_delete_jobserver) once for each target server required.

Permissions

Only members of the sysadmin fixed server role can execute sp_apply_job_to_targets.

Examples

This example applies the previously created Backup Customer Information job to all the target servers in the Servers Maintaining Customer Information group.

USE msdb

EXEC sp_apply_job_to_targets @job_name = 'Backup Customer Information',     @target_server_groups = 'Servers Maintaining Customer Information',
    @operation = 'APPLY'

See Also