Skip to content

Commit c025ef2

Browse files
authored
Update upgrade-in-box-openssh-to-latest-openssh-release.md
Edit review per CI 8618
1 parent 2a901e7 commit c025ef2

1 file changed

Lines changed: 24 additions & 24 deletions

File tree

support/windows-server/system-management-components/upgrade-in-box-openssh-to-latest-openssh-release.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ This article explains the difference between the in-box and GitHub versions, how
2626
> [!NOTE]
2727
> Upgrading temporarily stops the OpenSSH Server service and disconnects any active SSH sessions.
2828
29-
- In case the service restarts, have alternate access methods (such as RDP or console) available.
29+
- In case the service restarts, have alternative access methods (such as RDP or console) available.
3030
- Make sure you have the correct permissions to modify C:\ProgramData\ssh and install MSI packages.
3131
- Before you install a new release in a production environment, test it in a staging environment first.
3232

3333
## Understanding in-box versus GitHub OpenSSH
3434

35-
By default, you use Windows Update to install and maintain the in-box OpenSSH feature. Typically, it resides in C:\Windows\System32\OpenSSH. The in-box version is Microsoft-supported and stable, but it updates only when Windows itself updates.
35+
By default, you use Windows Update to install and maintain the in-box OpenSSH feature. Typically, the software resides in C:\Windows\System32\OpenSSH. The in-box version is Microsoft-supported and stable, but it updates only when Windows itself updates.
3636

3737
The GitHub version, known as Win32-OpenSSH, installs in C:\Program Files\OpenSSH, and has the newest features and fixes. However, you have to manually update it.
3838

@@ -49,7 +49,7 @@ The following table lists the files and their default folder locations
4949
| C:\\ProgramData\\ssh\\ssh_host\_\*\_key | Host identity keys |
5050
| C:\\Users\\\<UserName>\\.ssh\\authorized_keys | Per-user keys |
5151

52-
To copy these files, open a Windows PowerShell command prompt and run a cmdlet that resembles the following cmdlet:
52+
To copy these files, open a Windows PowerShell command prompt, and run a cmdlet that resembles the following cmdlet:
5353

5454
```powershell
5555
Copy-Item "C:\ProgramData\ssh" -Destination "C:\Backup\ssh_backup" -Recurse
@@ -66,7 +66,7 @@ Copy-Item "C:\ProgramData\ssh" -Destination "C:\Backup\ssh_backup" -Recurse
6666
6767
## Step 2: Upgrade OpenSSH
6868
69-
Select one of the following methods for upgrading OpenSSH:
69+
Select one of the following methods to upgrade OpenSSH:
7070
7171
- [Option 1: Use an MSI installer to upgrade OpenSSH to the latest GitHub release](#option-1-use-an-msi-installer-to-upgrade-openssh-to-the-latest-github-release)
7272
- [Option 2: Use a ZIP file to upgrade OpenSSH to the latest GitHub release](#option-2-use-a-zip-file-to-upgrade-openssh-to-the-latest-github-release)
@@ -77,22 +77,22 @@ Select one of the following methods for upgrading OpenSSH:
7777
> [!NOTE]
7878
> Depending on your processor, OpenSSH installs in either C:\Program Files\OpenSSH or C:\Program Files\OpenSSH-Win64. The installer automatically registers the OpenSSH services and updates the PATH environment variable.
7979
80-
1. To download the MSI installer, go to [Win32-OpenSSH releases page on GitHub](https://github.com/PowerShell/Win32-OpenSSH/releases) and download the latest OpenSSH-Win64.msi or Win32 build.
80+
1. To download the MSI installer, go to [Win32-OpenSSH releases page on GitHub](https://github.com/PowerShell/Win32-OpenSSH/releases), and download the latest OpenSSH-Win64.msi or Win32 build.
8181
8282
1. To install all components of the new version, open an administrative PowerShell command prompt window and run a cmdlet that resembles the following cmdlet:
8383
8484
```powershell
8585
msiexec /i OpenSSH-Win64-v9.x.x.x.msi
8686
```
8787
88-
1. To install only the client or server component, open an administrative PowerShell command prompt window and run a cmdlet that resembles the one of the following cmdlets, as appropriate:
88+
1. To install only the client or server component, open an administrative PowerShell command prompt window, and run a cmdlet that resembles the one of the following cmdlets, as appropriate:
8989

9090
```powershell
9191
msiexec /i OpenSSH-Win64-v9.x.x.x.msi ADDLOCAL=Client
9292
msiexec /i OpenSSH-Win64-v9.x.x.x.msi ADDLOCAL=Server
9393
```
9494

95-
1. To configure the OpenSSH Server service and then start it, run the following cmdlets on the computer where you installed the server component.
95+
1. To configure the OpenSSH Server service and then start it, run the following cmdlets on the computer where you installed the server component:
9696

9797
```powershell
9898
Start-Service sshd
@@ -105,13 +105,13 @@ Select one of the following methods for upgrading OpenSSH:
105105
PowerShell.exe -ExecutionPolicy Bypass -File "C:\Program Files\OpenSSH\install-sshd.ps1"
106106
```
107107

108-
### Option 2: Use a ZIP file to upgrade OpenSSH to the latest GitHub release
108+
### Option 2: Use a .zip file to upgrade OpenSSH to the latest GitHub release
109109

110-
If you don't want to use the MSI package to install the upgrade, you can use a ZIP archive file.
110+
If you don't want to use the MSI package to install the upgrade, you can use a .zip archive file.
111111

112-
1. To download the latest ZIP file, go to [Win32-OpenSSH releases page on GitHub](https://github.com/PowerShell/Win32-OpenSSH/releases) and download the appropriate file.
112+
1. To download the latest .zip file, go to [Win32-OpenSSH releases page on GitHub](https://github.com/PowerShell/Win32-OpenSSH/releases), and download the appropriate file.
113113

114-
1. Extract the ZIP file to C:\Program Files\OpenSSH.
114+
1. Extract the .zip file to C:\Program Files\OpenSSH.
115115

116116
1. Open an administrative PowerShell window, change to the C:\Program Files\OpenSSH folder, and then run the following command:
117117

@@ -137,23 +137,23 @@ If you don't want to use the MSI package to install the upgrade, you can use a Z
137137
Remove-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0
138138
```
139139

140-
1. After the uninstall operations finish, restart Windows.
140+
1. After the software is uninstalled, restart Windows.
141141

142-
1. To install the latest release from Windows Update, run the following cmdlets at a PowerShell command prompt.
142+
1. To install the latest release from Windows Update, run the following cmdlets at a PowerShell command prompt:
143143

144144
```powershell
145145
Add-WindowsCapability -Online -Name OpenSSH.Server~~~~0.0.1.0
146146
Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0
147147
```
148148

149-
1. To configure the OpenSSH Server service and then start it, run the following cmdlets.
149+
1. To configure the OpenSSH Server service and then start it, run the following cmdlets:
150150

151151
```powershell
152152
Start-Service sshd
153153
Set-Service sshd -StartupType Automatic
154154
```
155155

156-
## Step 3: Create the firewall rule, if necessary
156+
## Step 3: Create the firewall rule, if it's necessary
157157

158158
1. To check for existing firewall rules, go to your OpenSSH client computer, and run the following cmdlet at a PowerShell command prompt:
159159

@@ -171,11 +171,11 @@ If you don't want to use the MSI package to install the upgrade, you can use a Z
171171

172172
## Step 4: Verify the installation
173173

174-
1. Make sure that C:\ProgramData\ssh still has your previous configuration and keys. If necessary, restore this information from your backup.
174+
1. Make sure that C:\ProgramData\ssh still has your previous configuration and keys. If it's necessary, restore this information from your backup.
175175

176176
1. To check the version, run `ssh -V` at the PowerShell command prompt.
177177

178-
1. To check the service status and connectivity, run the following cmdlets at the PowerShell command prompt:
178+
1. To check the service status and connectivity, run the following cmdlets at a PowerShell command prompt:
179179

180180
```powershell
181181
Get-Service sshd
@@ -185,26 +185,26 @@ If you don't want to use the MSI package to install the upgrade, you can use a Z
185185
> [!NOTE]
186186
> The display name of the service is "OpenSSH SSH Server."
187187
188-
1. To verify that you're using the correct SSH binary, run the following cmdlets at the Windows PowerShell command prompt:
188+
1. To verify that you're using the correct SSH binary, run the following cmdlets at a Windows PowerShell command prompt:
189189

190190
```powershell
191191
Get-Command ssh.exe | Select-Object Source
192192
```
193193

194-
1. To check for errors, open Event Viewer and then select **Applications and Services Logs** > **OpenSSH** > **Operational**.
194+
1. To check for errors, open Event Viewer, and then select **Applications and Services Logs** > **OpenSSH** > **Operational**.
195195

196196
1. Make sure that administrators and users can authenticate.
197197

198-
1. To avoid path conflicts, check for multiple OpenSSH folders (typically in the System32 folder). If multiple OpenSSH folders exist, keep the newest folder and remove any older ones.
198+
1. To avoid path conflicts, check for multiple OpenSSH folders (typically in the System32 folder). If multiple OpenSSH folders exist, keep the newest folder, and remove any older folders.
199199

200-
## Common issue quick reference
200+
## Common issues quick reference
201201

202202
| **Symptom** | **Likely cause** | **Resolution** |
203203
| --- | --- | --- |
204-
| SSH service fails to start | Missing or misconfigured host keys | Restore backed-up keys and restart the service |
205-
| Authentication errors | Improper key file permissions | Make sure only SYSTEM and Administrators can read or write key files |
204+
| SSH service doesn't start | Missing or misconfigured host keys | Restore backed-up keys and restart the service |
205+
| Authentication errors | Improper key file permissions | Make sure that only SYSTEM and Administrators can read or write key files |
206206
| Old binaries still run | PATH still points to System32\OpenSSH | Remove or rename the outdated directory |
207-
| Port 22 unreachable | Firewall rule is missing | Recreate inbound rule for TCP port 22 |
207+
| Port 22 unreachable | Firewall rule is missing | Re-create the inbound rule for TCP port 22 |
208208

209209
## Related articles
210210

0 commit comments

Comments
 (0)