How to configure the Microsoft Distributed Transaction Coordinator (MSDTC) on Linux
This article describes how to configure the Microsoft Distributed Transaction Coordinator (MSTDC) on Linux. MSDTC support on Linux was introduced in SQL Server 2019 preview.
Distributed transactions are enabled on SQL Server on Linux by introducing MSDTC and RPC endpoint mapper functionality within SQL Server. By default, an RPC endpoint-mapping process listens on port 135 for incoming RPC requests and provides registered components information to remote requests. Remote requests can use the information returned by endpoint mapper to communicate with registered RPC components, such as MSDTC services. A process requires super user privileges to bind to well-known ports (port numbers less than 1024) on Linux. To avoid starting SQL Server with root privileges for the RPC endpoint mapper process, system administrators must use iptables to create Network Address Translation to route traffic on port 135 to SQL Server's RPC endpoint-mapping process.
SQL Server 2019 introduces two configuration parameters for the mssql-conf utility.
|network.rpcport||The TCP port that the RPC endpoint mapper process binds to.|
|distributedtransaction.servertcpport||The port that the MSDTC server listens to. If not set, the MSDTC service uses a random ephemeral port on service restarts, and firewall exceptions will need to be reconfigured to ensure that MSDTC service can continue communication.|
For more information about these settings and other related MSDTC settings, see Configure SQL Server on Linux with the mssql-conf tool.
Supported MSDTC configurations
The following MSDTC configurations are supported:
- OLE-TX Distributed transactions against SQL Server on Linux for ODBC providers.
- XA Distributed transactions against SQL Server on Linux using JDBC and ODBC providers. For XA transactions to be performed using ODBC provider, you need to use Microsoft ODBC Driver for SQL Server version 17.3 or higher.
- Distributed transactions on Linked server.
For limitations and known issues for MSDTC in preview, see Release notes for SQL Server 2019 preview on Linux.
MSDTC configuration steps
There are three steps to configure MSDTC communication and functionality. If the necessary configuration steps are not done, SQL Server will not enable MSDTC functionality.
- Configure network.rpcport and distributedtransaction.servertcpport using mssql-conf.
- Configure the firewall to allow communication on distributedtransaction.servertcpport and port 135.
- Configure Linux server routing so that RPC communication on port 135 is redirected to SQL Server's network.rpcport.
The following sections provide detailed instructions for each step.
Configure RPC and MSDTC ports
First, configure network.rpcport and distributedtransaction.servertcpport using mssql-conf. This step if specific to SQL Server and common across all supported distributions.
Use mssql-conf to set the network.rpcport value. The following example sets it to 13500.
sudo /opt/mssql/bin/mssql-conf set network.rpcport 13500
Set the distributedtransaction.servertcpport value. The following example sets it to 51999.
sudo /opt/mssql/bin/mssql-conf set distributedtransaction.servertcpport 51999
Restart SQL Server.
sudo systemctl restart mssql-server
Configure the firewall
The second step is to configure the firewall to allow communication on servertcpport and port 135. This enables the RPC endpoint-mapping process and MSDTC process to communicate externally to other transaction managers and coordinators. The actual steps for this will vary depending on your Linux distribution and firewall.
The following example shows how to create these rules on Ubuntu.
sudo ufw allow from any to any port 51999 proto tcp sudo ufw allow from any to any port 135 proto tcp
The following example shows how this could be done on Red Hat Enterprise Linux (RHEL):
sudo firewall-cmd --zone=public --add-port=51999/tcp --permanent sudo firewall-cmd --zone=public --add-port=135/tcp --permanent sudo firewall-cmd --reload
It is important to configure the firewall before configuring port routing in the next section. Refreshing the firewall can clear the port routing rules in some cases.
Configure port routing
Configure the Linux server routing table so that RPC communication on port 135 is redirected to SQL Server's network.rpcport. Configuration mechanism for port forwarding on different distribution may differ. The following sections provide guidance for Ubuntu, SUS Enterprise Linux (SLES), and Red Hat Enterprise Linux (RHEL).
Port routing in Ubuntu and SLES
Ubuntu and SLES do not use the firewalld service, so iptable rules are an efficient mechanism to achieve port routing. The iptable rules may not persist during reboots, so the following commands also provide instructions for restoring the rules after a reboot.
Create routing rules for port 135. In the following example, port 135 is directed to the RPC port, 13500, defined in the previous section. Replace
<ipaddress>with the IP address of your server.
sudo iptables -t nat -A PREROUTING -d <ip> -p tcp --dport 135 -m addrtype --dst-type LOCAL \ -j DNAT --to-destination <ip>:13500 -m comment --comment RpcEndPointMapper sudo iptables -t nat -A OUTPUT -d <ip> -p tcp --dport 135 -m addrtype --dst-type LOCAL \ -j DNAT --to-destination <ip>:13500 -m comment --comment RpcEndPointMapper
--comment RpcEndPointMapperparameter in the previous commands assists with managing these rules in later commands.
View the routing rules you created with the following command:
sudo iptables -S -t nat | grep "RpcEndPointMapper"
Save the routing rules to a file on your machine.
sudo iptables-save > /etc/iptables.conf
To reload the rules after a reboot, add the following command to
/etc/rc.local(for Ubuntu) or to
iptables-restore < /etc/iptables.conf
You must have super user (sudo) privileges to edit the rc.local or after.local files.
The iptables-save and iptables-restore commands, along with
after.local startup configuration, provide a basic mechanism to save and restore iptables entries. Depending on your Linux distribution, there might be more advanced or automated options available. For example, an Ubuntu alternative is the iptables-persistent package to make entries persistent.
The previous steps assume a fixed IP address. If the IP address for your SQL Server instance changes (due to manual intervention or DHCP), you must remove and recreate the routing rules if they were created with iptables. If you need to recreate or delete existing routing rules, you can use the following command to remove old
sudo iptables -S -t nat | grep "RpcEndPointMapper" | sed 's/^-A //' | while read rule; do iptables -t nat -D $rule; done
Port routing in RHEL
On distributions that use firewalld service, such as Red Hat Enterprise Linux, the same service can be used for both opening the port on the server and internal port forwarding. For example, on Red Hat Enterprise Linux, you should use firewalld service (via firewall-cmd configuration utility with
-add-forward-port or similar options) to create and manage persistent port forwarding rules instead of using iptables.
sudo firewall-cmd --permanent --add-forward-port=port=135:proto=tcp:toport=13500 sudo firewall-cmd --reload
At this point, SQL Server should be able to participate in distributed transactions. To verify that SQL Server is listening, run the netstat command (if you are using RHEL, you might have to first install the net-tools package):
sudo netstat -tulpn | grep sqlservr
You should see output similar to the following:
tcp 0 0 0.0.0.0:1433 0.0.0.0:* LISTEN 13911/sqlservr tcp 0 0 127.0.0.1:1434 0.0.0.0:* LISTEN 13911/sqlservr tcp 0 0 0.0.0.0:13500 0.0.0.0:* LISTEN 13911/sqlservr tcp 0 0 0.0.0.0:51999 0.0.0.0:* LISTEN 13911/sqlservr tcp6 0 0 :::1433 :::* LISTEN 13911/sqlservr tcp6 0 0 ::1:1434 :::* LISTEN 13911/sqlservr tcp6 0 0 :::13500 :::* LISTEN 13911/sqlservr tcp6 0 0 :::51999 :::* LISTEN 13911/sqlservr
However, after a restart, SQL Server does not start listening on the servertcpport until the first distributed transaction. In this case, you would not see SQL Server listening on port 51999 in this example until the first distributed transaction.
Configure authentication on RPC communication for MSDTC
MSDTC for SQL Server on Linux does not use authentication on RPC communication by default. However, when the host machine is joined to an Active Directory (AD) domain, it is possible to configure MSDTC to use authenticated RPC communication using following mssql-conf settings:
|distributedtransaction.allowonlysecurerpccalls||Configure secure only RPC calls for distributed transactions.|
|distributedtransaction.fallbacktounsecurerpcifnecessary||Configure security only RPC calls for distributed transactions.|
|distributedtransaction.turnoffrpcsecurity||Enable or disable RPC security for distributed transactions.|
For more information about SQL Server on Linux, see SQL Server on Linux.
Send feedback about: