sp_grant_proxy_to_subsystem (Transact-SQL)

Grants a proxy access to a subsystem.

Topic link icon Transact-SQL Syntax Conventions

Syntax

sp_grant_proxy_to_subsystem
     { [ @proxy_idĀ = ] proxy_id | [ @proxy_nameĀ = ] 'proxy_name' },
     { [ @subsystem_id = ] subsystem_id | [ @subsystem_name = ] 'subsystem_name' }

Arguments

  • [ @proxy\_id = ] id
    The proxy identification number of the proxy to grant access for. The proxy_id is int, with a default of NULL. Either proxy_id or proxy_name must be specified, but both cannot be specified.

  • [ @proxy\_name = ] 'proxy_name'
    The name of the proxy to grant access for. The proxy_name is sysname, with a default of NULL. Either proxy_id or proxy_name must be specified, but both cannot be specified.

  • [ @subsystem\_id = ] id
    The id number of the subsystem to grant access to. The subsystem_id is int, with a default of NULL. Either subsystem_id or subsystem_name must be specified, but both cannot be specified. The following table lists the values for each subsystem.

    Value

    Description

    2

    Microsoft ActiveX Script

    Important

    The ActiveX Scripting subsystem will be removed from SQL Server Agent in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

    3

    Operating System (CmdExec)

    4

    Replication Snapshot Agent

    5

    Replication Log Reader Agent

    6

    Replication Distribution Agent

    7

    Replication Merge Agent

    8

    Replication Queue Reader Agent

    9

    Analysis Services Query

    10

    Analysis Services Command

    11

    SSIS package execution

    12

    PowerShell Script

  • [ @subsystem\_name = ] 'subsystem_name'
    The name of the subsystem to grant access to. The subsystem_name is sysname, with a default of NULL. Either subsystem_id or subsystem_name must be specified, but both cannot be specified. The following table lists the values for each subsystem.

    Value

    Description

    ActiveScripting

    ActiveX Script

    CmdExec

    Operating System (CmdExec)

    Snapshot

    Replication Snapshot Agent

    LogReader

    Replication Log Reader Agent

    Distribution

    Replication Distribution Agent

    Merge

    Replication Merge Agent

    QueueReader

    Replication Queue Reader Agent

    ANALYSISQUERY

    Analysis Services Query

    ANALYSISCOMMAND

    Analysis Services Command

    Dts

    SSIS package execution

    PowerShell

    PowerShell Script

Remarks

Granting a proxy access to a subsystem does not change the permissions for the principal specified in the proxy.

Permissions

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

Examples

A. Granting access to a subsystem by ID

The following example grants the proxy Catalog application proxy access to the ActiveX Scripting subsystem.

USE msdb ;
GO

EXEC dbo.sp_grant_proxy_to_subsystem
    @proxy_name = 'Catalog application proxy',
    @subsystem_id = 2;
GO

B. Granting access to a subsystem by name.

The following example grants the proxy Catalog application proxy access to the SSIS package execution subsystem.

USE msdb ;
GO

EXEC dbo.sp_grant_proxy_to_subsystem
    @proxy_name = N'Catalog application proxy',
    @subsystem_name = N'Dts' ;
GO

See Also

Reference

sp_revoke_proxy_from_subsystem (Transact-SQL)

sp_add_proxy (Transact-SQL)

sp_delete_proxy (Transact-SQL)

sp_update_proxy (Transact-SQL)

Concepts

Implement SQL Server Agent Security