Enable-SSHRemoting bug workaround improvement/modernization - Favor symlink over 8.3 and improve 8.3 fallback command #12107
Description
Prerequisites
- Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
- Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in
Get-Foocmdlet" instead of "Typo." - Verify Version: If there is a mismatch between documentation and the behavior on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.
Links
https://learn.microsoft.com/en-us/powershell/scripting/security/remoting/ssh-remoting-in-powershell
Summary
The documentation for Enable-SSHRemoting has a callout for a bug and a suggested workaround which uses DOS 8.3-style paths.
This won't work on systems or volumes with 8.3 names disabled and is a legacy solution anyway.
Instead, a symlink can be used by creating one at an appropriate path and using that path.
Also, the instructions for determining the 8.3 name aren't quite complete, and can be improved to provide a full path for the user, to make it easier if they need to use that method as a fallback.
I have changes ready to go (PR coming shortly) which introduce the symlink method, modify the 8.3 method to provide the full path to the user's current pwsh.exe, discourage use of the 8.3 names except as a fallback, and explain why it's a fallback.