Edit

sp_syscollector_stop_collection_set (Transact-SQL)

  • Article

Applies to: SQL Server

Stops a collection set.

Transact-SQL syntax conventions

Syntax

sp_syscollector_stop_collection_set
    [ [ @collection_set_id = ] collection_set_id ]
    [ , [ @name = ] N'name' ]
    [ , [ @stop_collection_job = ] stop_collection_job ]
[ ; ]

Arguments

[ @collection_set_id = ] collection_set_id

The unique local identifier for the collection set. @collection_set_id is int, with a default of NULL. @collection_set_id must have a value if @name is NULL.

[ @name = ] N'name'

The name of the collection set. @name is sysname, with a default of NULL. @name must have a value if @collection_set_id is NULL.

[ @stop_collection_job = ] stop_collection_job

Specifies that the collection job for the collection set should be stopped if it is running. @stop_collection_job is bit, with a default 1.

@stop_collection_job applies only to collection sets with collection mode set to cached. For more information, see sp_syscollector_create_collection_set (Transact-SQL).

Return code values

0 (success) or 1 (failure).

Remarks

sp_syscollector_create_collection_set must be run in the context of the msdb system database.

Permissions

Requires membership in the dc_operator (with EXECUTE permission) fixed database role to execute this procedure.

Examples

The following example stops a collection set using its identifier.

USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
    @collection_set_id = 1;

Related content