sp_post_msx_operation (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

Inserts operations (rows) into the sysdownloadlist system table for target servers to download and execute.

Syntax

  
sp_post_msx_operation  
     [ @operation = ] 'operation'  
     [ , [ @object_type = ] 'object' ]   
     { , [ @job_id = ] job_id }   
     [ , [ @specific_target_server = ] 'target_server' ]   
     [ , [ @value = ] value ]  
     [ , [ @schedule_uid = ] schedule_uid ]

Arguments

[ @operation = ] 'operation' The type of operation for the posted operation. operation is varchar(64), with no default. Valid operations depend upon object_type.

Object type	Operation
JOB	INSERT UPDATE DELETE START STOP
SERVER	RE-ENLIST DEFECT SYNC-TIME SET-POLL
SCHEDULE	INSERT UPDATE DELETE

[ @object_type = ] 'object' The type of object for which to post an operation. Valid types are JOB, SERVER, and SCHEDULE. object is varchar(64), with a default of JOB.

[ @job_id = ] job_id The job identification number of the job to which the operation applies. job_id is uniqueidentifier, with no default. 0x00 indicates ALL jobs. If object is SERVER, then job_idis not required.

[ @specific_target_server = ] 'target_server' The name of the target server for which the specified operation applies. If job_id is specified, but target_server is not specified, the operations are posted for all job servers of the job. target_server is nvarchar(30), with a default of NULL.

[ @value = ] value The polling interval, in seconds. value is int, with a default of NULL. Specify this parameter only if operation is SET-POLL.

[ @schedule_uid = ] schedule_uid The unique identifier for the schedule to which the operation applies. schedule_uid is uniqueidentifier, with no default.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sp_post_msx_operation must be run from the msdb database.

sp_post_msx_operation can always be called safely because it first determines if the current server is a multiserver Microsoft SQL Server Agent and, if so, whether object is a multiserver job.

After an operation has been posted, it appears in the sysdownloadlist table. After a job has been created and posted, subsequent changes to that job must also be communicated to the target servers (TSX). This is also accomplished using the download list.

We highly recommend that the download list be managed by using the SQL Server Management Studio. For more information, see View or Modify Jobs.

Permissions

To run this stored procedure, users must be granted the sysadmin fixed server role.