ConnectionManager.exe ref

Colin Robertson · Colin Robertson · commit e39de7b86ffe · 2020-01-17T15:24:14.000-08:00
diff --git a/docs/build/reference/connectionmanager-reference.md b/docs/build/reference/connectionmanager-reference.md
@@ -0,0 +1,96 @@
+---
+title: "ConnectionManager Reference"
+ms.date: "11/04/2016"
+f1_keywords: ["ConnectionManager"]
+helpviewer_keywords: ["ConnectionManager program"]
+ms.assetid: 14e65747-d000-4343-854b-8393bf01cbac
+---
+# ConnectionManager Reference
+
+ConnectionManager.exe is a command-line utility to manage remote development connections outside of Visual Studio. You may find it useful for tasks such as provisioning a new development machine, or setting up Visual Studio for continuous integration. It's available in Visual Studio 2019 version 16.5 and later.
+
+ConnectionManager.exe is installed automatically when you choose the Connection Manager component in the Visual Studio Installer. By default, it's installed in *%VCIDEInstallDir%\\Linux\\bin\\ConnectionManager.exe*. You can use it in a Developer Command Prompt window. For more information about the Developer Command Prompt, see [Use the Microsoft C++ toolset from the command line](..\building-on-the-command-line.md).
+
+The functionality of ConnectionManager.exe is also available in Visual Studio. To manage remote development connections in the IDE, on the menu bar, choose **Tools** > **Options** to open the Options dialog. In the Options dialog, select **Cross Platform** > **Connection Manager**.
+
+## Syntax
+
+> **ConnectionManager.exe** *command* \[*arguments*] \[*options*]
+
+### Commands and arguments
+
+- **add** *user@host* \[**--port** *port*] \[**--password** *password*] \[**--privatekey** *privatekey_file*]
+
+  Authenticates and adds a new connection. By default, it uses port 22 and password authentication. (You are prompted to enter a password). Use both **--password** and **--privatekey** to specify a password for a private key.
+
+- **remove** \[*connection_id* \| *user@host* \[**--port** *port*]]
+
+  Removes a connection. If no arguments are specified, you are prompted to specify which connection to remove.
+
+- **remove-all**
+
+  Removes all stored connections.
+
+- **list**
+
+  Displays information and ids of all stored connections.
+
+- **help**
+
+  Displays a help screen.
+
+- **version**
+
+  Displays version information.
+
+### Options
+
+- **-q**, **--quiet**
+
+  Do not output to stdout or stderr.
+
+- **--no-prompt**
+
+  Fail instead of prompt, when appropriate.
+
+- **--no-verify**
+
+  Add or modify a connection without authentication.
+
+- **--file** *filename*
+
+  Read connection information from the provided *filename*.
+
+- **--no-telemetry**
+
+  Disable sending usage data back to Microsoft. Usage data is collected and sent back to Microsoft unless the **--no-telemetry** flag is passed.  
+
+- **-n**, **--dry-run**
+
+  Perform a dry-run of the command.
+
+- **-p**
+
+  Same as **--password**.
+
+- **-i**
+
+  Same as **--privatekey**.
+
+## Examples
+
+This command adds a connection for a user named "user" on localhost. The connection uses a key file for authentication, found in *%USERPROFILE%\.ssh\id_rsa*.
+
+```cmd
+ConnectionManager.exe add user@127.0.0.1 --privatekey "%USERPROFILE%\.ssh\id_rsa"
+```
+
+This command removes the connection that has ID 1975957870 from the list of connections.
+
+```cmd
+ConnectionManager.exe remove 1975957870
+```
+
+## See also
+
+[XML Documentation](xml-documentation-visual-cpp.md)
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -1143,6 +1143,8 @@
           items: 
             - name: Additional MSVC build tools
               href: build/reference/c-cpp-build-tools.md
+            - name: ConnectionManager reference
+              href: build/reference/connectionmanager-reference.md
             - name: NMAKE reference
               expanded: false
               items: 
