add sample connection properties (#4173)

* add sample connection properties

* add examples

* alphabetize list

* break the examples out into their own section

* adjust examples

* update wording

* more changes to example section and remove a little redundancy

* acrolinx

* tech review

* acrolinx

* change location of troubleshooting step

* wording

* removed connection id

Co-authored-by: TylerMSFT <[email protected]>

Author: TylerMSFT

docs/linux/connect-to-your-remote-linux-computer.md

@@ -1,7 +1,7 @@
 ---
 title: "Connect to your target Linux system in Visual Studio"
 description: "How to connect to a remote Linux machine or Windows Subsystem for Linux from inside a Visual Studio C++ project."
-ms.date: "01/8/2021"
+ms.date: 03/14/2022
 ---
 # Connect to your target Linux system in Visual Studio
 
@@ -94,6 +94,8 @@ If `ssh` isn't already set up and running on your Linux system, follow these ste
 
    If you use key files for authentication, make sure the target machine's SSH server is running and configured properly.
 
+   If you have trouble connecting to WSL on `localhost`, see [Fix WSL `localhost` connection problems](#fix-wsl-localhost-connection-problems).
+
 ::: moniker-end
 
 ::: moniker range=">=msvc-160"
@@ -229,6 +231,25 @@ To configure your WSL installation to work with Visual Studio, you need the foll
 sudo apt install g++ gdb make ninja-build rsync zip
 ```
 
+### Fix WSL `localhost` connection problems
+
+When connecting to Windows Subsystem for Linux (WSL) on `localhost`, you may run into a conflict with the Windows `ssh` client on port 22. In WSL, change the port that `ssh`expects requests from to 23 in `/etc/ssh/sshd_config`:
+
+```bash
+Port 23
+```
+
+If you're connecting using a password, ensure that the following is set in `/etc/ssh/sshd_config`:
+
+```bash
+# To disable tunneled clear text passwords, change to no here!
+PasswordAuthentication yes
+```
+
+After making these changes, restart the SSH server (`sudo service ssh restart` on Ubuntu).
+
+Then retry your connection to `localhost` using port 23.
+
 For more information, see [Download, install, and set up the Linux workload](download-install-and-setup-the-linux-development-workload.md).
 
 To configure an MSBuild project for WSL, see [Configure a Linux project](configure-a-linux-project.md). To configure a CMake project for WSL, see [Configure a Linux CMake project](cmake-linux-project.md). To follow step-by-step instructions for creating a simple console application with WSL, check out this introductory blog post on [C++ with Visual Studio 2019 and the Windows Subsystem for Linux (WSL)](https://devblogs.microsoft.com/cppblog/c-with-visual-studio-2019-and-windows-subsystem-for-linux-wsl/).

docs/linux/connectionmanager-reference.md

@@ -1,7 +1,7 @@
 ---
 title: "ConnectionManager reference"
-description: "How to manage your remote SSH connections from a command-line tool."
-ms.date: "10/7/2020"
+description: "How to manage your remote SSH connections from the command-line tool ConnectionManager.exe."
+ms.date: 03/14/2022
 f1_keywords: ["ConnectionManager"]
 helpviewer_keywords: ["ConnectionManager program"]
 ---
@@ -31,82 +31,82 @@ The functionality of ConnectionManager.exe is also available in Visual Studio. T
 
   Authenticates and adds a new connection. By default, it uses port 22 and password authentication. (You'll be 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*]]
+- **`clean`**
+
+  Deletes header cache for connections that no longer exist.
+
+- **`help`**
+
+  Displays a help screen.
+
+- **`list`** \[**`--properties`**]
+
+  Displays information, IDs, and properties of all stored connections.<br>For examples, see [Commonly used properties](#commonly-used-properties).
 
-  Removes a connection. If no arguments are specified, you're prompted to specify which connection to remove.
-  
 - **`modify`** \[*default* \| *connection_id* \| *user\@host* \[**`--port`** *port*]] \[**`--property`** *key=value*]
 
   Defines or modifies a property on a connection.\
   If *value* is empty, then the property *key* is deleted.\
   If authentication fails, no changes will be made.\
   If no connection is specified (what is meant by *default*, above), the user's default remote connection is used.
 
-- **`remove-all`**
-
-  Removes all stored connections.
-  
-- **`clean`**
-
-  Deletes header cache for connections that no longer exist.
+- **`remove`** \[*connection_id* \| *user\@host* \[**`--port`** *port*]]
 
-- **`list`** \[**`--properties`**]
+  Removes a connection. If no arguments are specified, you're prompted to specify which connection to remove.
 
-  Displays information, IDs, and properties of all stored connections.
+- **`remove-all`**
 
-- **`help`**
+  Removes all stored connections.
+    
+- **`update`** \[*default* \| *all* \| *connection_id* \| *user\@host* \[**`--port`** *port*]] \[**`--previous`**] [**`--fingerprint`**]
 
-  Displays a help screen.
+  Added in Visual Studio 16.10. Updates the host key fingerprint of the specified connection(s).
 
 - **`version`**
 
   Displays version information.
-  
-- **`update`** \[*default* \| *all* \| *connection_id* \| *user\@host* \[**`--port`** *port*]] \[**`--previous`**] [**`--fingerprint`**]
-
-  Added in Visual Studio 16.10. Updates the host key fingerprint of the specified connection(s).
 
 ### Options
 
-- **`-q`**, **`--quiet`**
+- **`--file`** *filename*
 
-  Prevents output to `stdout` or `stderr`.
+  Read connection information from the provided *filename*.
 
-- **`--no-prompt`**
+- **`--fingerprint`**
 
-  Fail instead of prompt, when appropriate.
+  The host key fingerprint presented by the server. Use this option with **`list`** to view a connection's fingerprint.
 
-- **`--no-verify`**
+- **`-i`**
 
-  Add or modify a connection without authentication.
+  Same as **`--privatekey`**.
 
-- **`--file`** *filename*
+- **`-n`**, **`--dry-run`**
 
-  Read connection information from the provided *filename*.
+  Does a dry run of the command.
+
+- **`--no-prompt`**
+
+  Fail instead of prompt, when appropriate.
 
 - **`--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`**
+- **`--no-verify`**
 
-  Does a dry run of the command.
+  Add or modify a connection without authentication.
 
 - **`--p`**
 
   Same as **`--password`**.
-
-- **`-i`**
-
-  Same as **`--privatekey`**.
 
 - **`--previous`**
 
   Indicates that the connection(s) will be read from the previous version of connection manager, updated, and written to the new version.
 
-- **`--fingerprint`**
+- **`-q`**, **`--quiet`**
 
-  The host key fingerprint presented by the server. Use this option with **`list`** to view a connection's fingerprint.
+  Prevents output to `stdout` or `stderr`.
 
 ## Examples
 
@@ -122,11 +122,21 @@ This command removes the connection that has ID 1975957870 from the list of conn
 ConnectionManager.exe remove 1975957870
 ```
 
-This command overrides the choice of shell for the connection with connection ID 21212121. Supported shells are: **`sh, csh, bash, tcsh, ksh, zsh, dash`**. If the shell found on the Linux system isn't supported, then we fall back to explicitly use **`sh`** for all commands.
-
-```cmd
-ConnectionManager.exe modify 21212121 --property shell=csh
-```
+### Commonly used properties
+
+| Property | Description |
+|--|--|
+| authentication type | The type of authentication used for the connection such as: `"password"`, `"privatekey"`.<br/>To create a connection with the authentication type set to `"privatekey"`: `ConnectionManager.exe add [email protected] --privatekey "%USERPROFILE%\.ssh\id_rsa"`|
+| `default` | A boolean indicating whether this is the default connection. The default connection is used when there's more than one connection available and the one to use isn't specified.<br/>To set the specified connection to be the default connection: `ConnectionManager.exe modify -21212121 --property default=true` |
+| `host` | The name or IP address of the remote computer.<br/>To change the host for the specified connection to another machine, in this case, local host: `ConnectionManager.exe modify -21212121 --property host=127.0.0.1` |
+| `isWsl` | Returns true if the remote session is running Windows Subsystem for Linux. |
+| `password` | The password for the connection. Change the password for the specified connection with: `ConnectionManager.exe modify -21212121 --property password="xyz"`|
+| `platform` | The platform of the remote computer such as `"ARM"`, `"ARM64"`, `"PPC"`, `"PPC64"`, `"x64"`, `"x86"`.|
+| `port` | The port used for the connection.<br/>Change the port for the specified connection: `ConnectionManager.exe modify -21212121 --property port=22`|
+| `shell` | The preferred shell to use on the remote system. Supported shells are `sh, csh, bash, tcsh, ksh, zsh, dash`<br/>To set the preferred shell to be zsh for the remote machine on the specified connection: `ConnectionManager.exe modify -21212121 --property shell=zsh`<br/>If the shell found on the Linux system isn't supported, then **`sh`** is used for all commands. |
+| `systemID` | The remote system type, such as `"OSX"`, `"Ubuntu"`. |
+| `timeout` | The connection timeout in milliseconds. Change the timeout for the specified connection with: `ConnectionManager.exe modify -21212121 --property timeout=100`
+| `username` | The name of the user logged into the remote computer.<br/>To add a connection for a user named `"user"` on localhost: `ConnectionManager.exe add [email protected]`|
 
 ## See also