Skip to content

configure-firewall-rules-before-running-the-tsql-debugger.md

Latest commit

 

History

History
172 lines (102 loc) · 12.2 KB

configure-firewall-rules-before-running-the-tsql-debugger.md

File metadata and controls

172 lines (102 loc) · 12.2 KB
title Configure Firewall rules before running the T-SQL Debugger
description Learn how to configure the Windows Firewall rules before running the Transact-SQL (T-SQL) debugger when connected to an SQL Server in SQL Server Management Studio.
ms.custom seo-lt-2019
ms.prod sql
ms.prod_service sql-tools
ms.technology ssms
ms.topic conceptual
f1_keywords
vs.debug.error.sqlde_accessdenied
vs.debug.error.sqlde_register_failed
vs.debug.error.sqlde_firewall.remotemachines
helpviewer_keywords
Transact-SQL debugger, remote connections
Windows Firewall [Database Engine], Transact-SQL debugger
Transact-SQL debugger, Windows Firewall
Transact-SQL debugger, configuring
ports [SQL Server], Transact-SQL debugger
TCP/IP [SQL Server], port numbers
ms.assetid f50e0b0d-eaf0-4f4a-be83-96f5be63e7ea
author markingmyname
ms.author maghan
ms.reviewer
ms.date 10/20/2016
monikerRange >=aps-pdw-2016||=azuresqldb-current||=azure-sqldw-latest||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current

Configure firewall rules before running the TSQL Debugger

[!INCLUDE SQL Server]

Windows Firewall rules must be configured to enable [!INCLUDEtsql] debugging when connected to an instance of the [!INCLUDEssDE] that is running on a different computer than the [!INCLUDEssDE] Query Editor.

[!INCLUDEssms-old-versions]

Configuring the Transact-SQL Debugger

The [!INCLUDEtsql] debugger includes both server-side and client-side components. The server-side debugger components are installed with each instance of the Database Engine from [!INCLUDEssVersion2005] Service Pack 2 (SP2) or later. The client-side debugger components are included:

  • When you install the client-side tools from [!INCLUDEssKatmai] or later.

  • When you install Microsoft Visual Studio 2010 or later.

  • When you install [!INCLUDEssBIDevStudioFull] from the web download.

There are no configuration requirements to run the [!INCLUDEtsql] debugger when [!INCLUDEssManStudioFull] or [!INCLUDEssBIDevStudio] is running on the same computer as the instance of the [!INCLUDEssDEnoversion]. However, to run the [!INCLUDEtsql] debugger when connected to a remote instance of the [!INCLUDEssDE], program and port rules in the Windows Firewall must be enabled on both computers. These rules may be created by [!INCLUDEssNoVersion] setup. If you get errors attempting to open a remote debugging session, ensure the following firewall rules are defined on your computer.

Use the Windows Firewall with Advanced Security application to manage the firewall rules. In both [!INCLUDEwin7] and [!INCLUDEwinserver2008r2], open Control Panel, open Windows Firewall, and select Advanced settings. In [!INCLUDEwinserver2008r2] you can also open Service Manager, expand Configuration in the left pane, and expand Windows Firewall with Advanced Security.

Caution

Enabling rules in the Windows Firewall may expose your computer to security threats that the firewall is designed to block. Enabling rules for remote debugging unblocks the ports and programs listed in this topic.

Firewall Rules on the Server

On the computer that is running the instance of the [!INCLUDEssDE], use Windows Firewall with Advanced Security to specify the following information:

  • Add an inbound program rule for sqlservr.exe. You must have a rule for each instance that needs to support remote debugging sessions.

    1. In Windows Firewall with Advanced Security, in the left pane, right-click Inbound Rules, and then select New Rule in the action pane.

    2. In the Rule Type dialog, select Program, and then click Next.

    3. In the Program dialog, select This program path: and enter the full path to sqlservr.exe for this instance. By default, sqlservr.exe is installed in C:\Program Files\Microsoft SQL Server\MSSQL13.InstanceName\MSSQL\Binn, where InstanceName is MSSQLSERVER for the default instance, and the instance name for any named instance.

    4. In the Action dialog, select Allow the connection, and click Next.

    5. In the Profile dialog, select any profiles that describe the computer connection environment when you want to open a debugging session with the instance, and click Next.

    6. In the Name dialog, type a name and description for this rule and click Finish.

    7. In the Inbound Rules list, right click the rule you created, and then select Properties in the action pane.

    8. Select the Protocols and Ports tab.

    9. Select TCP in the Protocol type: box, select RPC Dynamic Ports in the Local port: box, click Apply, and then click OK.

  • Add an inbound program rule for svchost.exe to enable DCOM communications from remote debugger sessions.

    1. In Windows Firewall with Advanced Security, in the left pane, right-click Inbound Rules, and then select New Rule in the action pane.

    2. In the Rule Type dialog, select Program, and then click Next.

    3. In the Program dialog, select This program path: and enter the full path to svchost.exe. By default, svchost.exe is installed in %systemroot%\System32\svchost.exe.

    4. In the Action dialog, select Allow the connection, and click Next.

    5. In the Profile dialog, select any profiles that describe the computer connection environment when you want to open a debugging session with the instance, and click Next.

    6. In the Name dialog, type a name and description for this rule and click Finish.

    7. In the Inbound Rules list, right click the rule you created, and then select Properties in the action pane.

    8. Select the Protocols and Ports tab.

    9. Select TCP in the Protocol type: box, select RPC Endpoint Mapper in the Local port: box, click Apply, and then click OK.

  • If the domain policy requires network communications to be done through IPsec, you must also add inbound rules opening UDP port 4500 and UDP port 500.

Firewall Rules on the Client

On the computer that is running the [!INCLUDEssDE] Query Editor, the SQL Server setup or [!INCLUDEssBIDevStudio] setup may have configured the Windows Firewall to allow remote debugging.

If you get errors attempting to open a remote debugging session, you can manually configure the program and port exceptions by using Windows Firewall with Advanced Security to configure firewall rules:

  • Add a program entry for svchost:

    1. In Windows Firewall with Advanced Security, in the left pane, right-click Inbound Rules, and then select New Rule in the action pane.

    2. In the Rule Type dialog, select Program, and then click Next.

    3. In the Program dialog, select This program path: and enter the full path to svchost.exe. By default, svchost.exe is installed in %systemroot%\System32\svchost.exe.

    4. In the Action dialog, select Allow the connection, and click Next.

    5. In the Profile dialog, select any profiles that describe the computer connection environment when you want to open a debugging session with the instance, and click Next.

    6. In the Name dialog, type a name and description for this rule and click Finish.

    7. In the Inbound Rules list, right click the rule you created, and then select Properties in the action pane.

    8. Select the Protocols and Ports tab.

    9. Select TCP in the Protocol type: box, select RPC Endpoint Mapper in the Local port: box, click Apply, and then click OK.

  • Add a program entry for the application hosting the [!INCLUDEssDE] Query Editor. If you need to open remote debugging sessions from both [!INCLUDEssManStudioFull] and [!INCLUDEssBIDevStudio] on the same computer, you must add a program rule for both:

    1. In Windows Firewall with Advanced Security, in the left pane, right-click Inbound Rules, and then select New Rule in the action pane.

    2. In the Rule Type dialog, select Program, and then click Next.

    3. In the Program dialog, select This program path: and enter one of these three values.

      • For [!INCLUDEssManStudioFull], enter the full path to ssms.exe. By default, ssms.exe is installed in C:\Program Files (x86)\Microsoft SQL Server\130\Tools\Binn\Management Studio.

      • For [!INCLUDEssBIDevStudio] enter the full path to devenv.exe:

        1. By default, the devenv.exe for Visual Studio 2010 is in C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE.

        2. By default, the devenv.exe for Visual Studio 2012 is in C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE

        3. You can find the path to ssms.exe from the shortcut you use to launch [!INCLUDEssManStudioFull]. You can find the path to devenv.exe from the shortcut you use to launch [!INCLUDEssBIDevStudio]. Right click the shortcut and select Properties. The executable and path are listed in the Target box.

    4. In the Action dialog, select Allow the connection, and click Next.

    5. In the Profile dialog, select any profiles that describe the computer connection environment when you want to open a debugging session with the instance, and click Next.

    6. In the Name dialog, type a name and description for this rule and click Finish.

    7. In the Inbound Rules list, right click the rule you created, and then select Properties in the action pane.

    8. Select the Protocols and Ports tab.

    9. Select TCP in the Protocol type: box, select RPC Dynamic Ports in the Local port: box, click Apply, and then click OK.

Requirements for Starting the Debugger

All attempts to start the [!INCLUDEtsql] debugger must also meet the following requirements:

  • [!INCLUDEssManStudioFull] or [!INCLUDEssBIDevStudio] must be running under a Windows account that is a member of the sysadmin fixed server roll.

  • The [!INCLUDEssDE] Query Editor window must be connected by using either a Windows Authentication or [!INCLUDEssNoVersion] Authentication login that is a member of the sysadmin fixed server role.

  • The [!INCLUDEssDE] Query Editor window must be connected to an instance of the [!INCLUDEssDE] from [!INCLUDEssVersion2005] Service Pack 2 (SP2) or later. You cannot run the debugger when the Query Editor window is connected to an instance that is in single-user mode.

  • The server needs to communicate back to the client via RPC. The account under which SQL Server service is running must have authenticated permissions to the client

See Also