sp_delete_targetserver (Transact-SQL)

Removes the specified server from the list of available target servers.

Topic link icon Transact-SQL Syntax Conventions

Syntax

sp_delete_targetserver [ @server_name = ] 'server' 
     [ , [ @clear_downloadlist = ] clear_downloadlist ]
     [ , [ @post_defection = ] post_defection ]

Arguments

  • [ @server_name= ] 'server'
    The name of the server to remove as an available target server. server is nvarchar(30), with no default.

  • [ @clear_downloadlist= ] clear_downloadlist
    Specifies whether to clear the download list for the target server. clear_downloadlist is type bit, with a default of 1. When clear_downloadlist is 1, the procedure clears the download list for the server before deleting the server. When clear_downloadlist is 0, the download list is not cleared.

  • [ @post_defection= ] post_defection
    Specifies whether to post a defect instruction to the target server. post_defection is type bit, with a default of 1. When post_defection is 1, the procedure posts a defect instruction to the target server before deleting the server. When post_defection is 0, the procedure does not post a defect instruction to the target server.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

The normal way to delete a target server is to call sp_msx_defect at the target server. Use sp_delete_targetserver only when a manual defection is necessary.

Permissions

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

Examples

The following example removes the server LONDON1 from the available job servers.

USE msdb ;
GO

EXEC dbo.sp_delete_targetserver
  @server_name = N'LONDON1' ;
GO

See Also

Reference

sp_help_targetserver (Transact-SQL)

sp_msx_defect (Transact-SQL)

System Stored Procedures (Transact-SQL)