File and command reference for Microsoft Tunnel Gateway, a VPN solution for Microsoft Intune - Microsoft Intune | Microsoft Learn
In brief
The documentation now describes running `mst-cli diagnose` on the Linux server to check prerequisites, configuration, and logging requirements, with some corrective guidance for common failures.
What Intune admins need to know
Administrators have a documented diagnostic command and guidance for interpreting results; no required action is stated.
This summary was assembled from the tracked documentation change. Verify important details in the full Microsoft Learn article.
Documentation change
The comparison below shows only the changed extract. Use the full-page view for complete context.
layout: Conceptual
title: File and command reference for Microsoft Tunnel Gateway, a VPN solution for Microsoft Intune - Microsoft Intune | Microsoft Learn
canonicalUrl: https://learn.microsoft.com/en-us/intune/device-security/microsoft-tunnel/ref-file-commands
author: OluchiCCharlotteChristenson-MSFT
ms.author: ochukwunyereCharlotteChristenson-MSFT
breadcrumb_path: /intune/breadcrumb/toc.json
uhfHeaderId: MSDocsHeader-Intune
feedback_system: Standard
ms.reviewer: ochukwunyere
ms.subservice: protect
description: Find file and command-line references for tools you use to install or manage the Microsoft Tunnel Gateway, a VPN server that runs on Linux.
ms.date: 2025-03-27T00:2026-11-16T00:00:00.0000000Z
ms.topic: reference
ai-usage: ai-assisted
ms.custom: msecd-doc-authoring-1032
locale: en-us
document_id: 93ff03fc-3ea4-c349-1a6a-cf936cb3f282
document_version_independent_id: 93ff03fc-3ea4-c349-1a6a-cf936cb3f282
Mst-cli is a command-line tool for use with Microsoft Tunnel Gateway. This tool is available on the Linux server after the tunnel completes installation and is found at /usr/sbin/mst-cli. Some tasks you can use this tool to complete include:
Get information about the tunnel server.
Diagnose known prerequisite and configuration problems, including logging requirements.
Set or update the configuration of the tunnel server.
Restart the tunnel server.
Uninstall the tunnel server.
agent- Operate on the agent component.server- Operate on the server component.diagnose- Check known prerequisites and configuration requirements. See Run diagnostics.uninstall- Uninstall the Microsoft Tunnel.eula- Show the End-User License Agreement (EULA).import_cert- Import or update the TLS certificate.show cookies all- Alias for show sessions all.show cookies valid- Alias for show sessions valid.
Run diagnostics
Run the following command on the Linux server where Microsoft Tunnel is installed:
mst-cli diagnose
The command checks known prerequisites and configuration requirements, including those required for logging. Logging checks report a pass or fail status and the expected result. The output includes fixes for some common failures. Checks and corrective steps vary by operating system and installation.
For the procedure, diagnostic report location, and limitations, see Run diagnostics on the Tunnel server.
Environment variables
Following are environment variables you might want to configure when you install the Microsoft Tunnel Gateway software on the Linux server. These variables are found in the environment file /etc/mstunnel/env.sh:
@@ -2,8 +2,8 @@ layout: Conceptual title: File and command reference for Microsoft Tunnel Gateway, a VPN solution for Microsoft Intune - Microsoft Intune | Microsoft Learn canonicalUrl: https://learn.microsoft.com/en-us/intune/device-security/microsoft-tunnel/ref-file-commands-author: OluchiC-ms.author: ochukwunyere+author: CharlotteChristenson-MSFT+ms.author: CharlotteChristenson-MSFT breadcrumb_path: /intune/breadcrumb/toc.json uhfHeaderId: MSDocsHeader-Intune feedback_system: Standard@@ -14,8 +14,10 @@ ms.collection: ms.reviewer: ochukwunyere ms.subservice: protect description: Find file and command-line references for tools you use to install or manage the Microsoft Tunnel Gateway, a VPN server that runs on Linux.-ms.date: 2025-03-27T00:00:00.0000000Z+ms.date: 2026-11-16T00:00:00.0000000Z ms.topic: reference+ai-usage: ai-assisted+ms.custom: msecd-doc-authoring-1032 locale: en-us document_id: 93ff03fc-3ea4-c349-1a6a-cf936cb3f282 document_version_independent_id: 93ff03fc-3ea4-c349-1a6a-cf936cb3f282@@ -49,6 +51,7 @@ The information in this reference for Microsoft Tunnel Gateway is provided to su **Mst-cli** is a command-line tool for use with Microsoft Tunnel Gateway. This tool is available on the Linux server after the tunnel completes installation and is found at **/usr/sbin/mst-cli**. Some tasks you can use this tool to complete include:
- Get information about the tunnel server.
+- Diagnose known prerequisite and configuration problems, including logging requirements.
- Set or update the configuration of the tunnel server.
- Restart the tunnel server.
- Uninstall the tunnel server.
@@ -63,6 +66,7 @@ The following are common command line uses of the tool.
- `agent` - Operate on the agent component.
- `server` - Operate on the server component.
+ - `diagnose` - Check known prerequisites and configuration requirements. See Run diagnostics.
- `uninstall` - Uninstall the Microsoft Tunnel.
- `eula` - Show the End-User License Agreement (EULA).
- `import_cert` - Import or update the TLS certificate.
@@ -131,6 +135,18 @@ The following are common command line uses of the tool. - `show cookies all` - Alias for show sessions all.
- `show cookies valid` - Alias for show sessions valid.
+### Run diagnostics
+
+Run the following command on the Linux server where Microsoft Tunnel is installed:
+
+```bash
+mst-cli diagnose
+```
+
+The command checks known prerequisites and configuration requirements, including those required for logging. Logging checks report a pass or fail status and the expected result. The output includes fixes for some common failures. Checks and corrective steps vary by operating system and installation.
+
+For the procedure, diagnostic report location, and limitations, see [Run diagnostics on the Tunnel server](monitor#run-diagnostics-on-the-tunnel-server).
+
## Environment variables
Following are environment variables you might want to configure when you install the Microsoft Tunnel Gateway software on the Linux server. These variables are found in the environment file **/etc/mstunnel/env.sh**: