d98f131c5a
# PR Summary <!-- Summarize your PR between here and the checklist. --> ## PR Context follow-up #12190 ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [x] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
50 lines
2.1 KiB
PowerShell
50 lines
2.1 KiB
PowerShell
# Copyright (c) Microsoft Corporation.
|
|
# Licensed under the MIT License.
|
|
|
|
@{
|
|
|
|
RootModule = './Microsoft.PowerShell.RemotingTools.psm1'
|
|
|
|
ModuleVersion = '0.1.0'
|
|
|
|
GUID = 'e11d52a1-d5a0-4e4d-92cd-e87114bf4a5c'
|
|
|
|
Author = 'Microsoft Corporation'
|
|
CompanyName = 'Microsoft Corporation'
|
|
Copyright = '(c) Microsoft Corporation.'
|
|
|
|
Description = '
|
|
This module contains remoting tool cmdlets.
|
|
|
|
Enable-SSHRemoting cmdlet:
|
|
--------------------------
|
|
PowerShell SSH remoting was implemented in PowerShell 6.0 but requries SSH (client) and SSHD (service) components
|
|
to be installed. In addition the sshd_config configuration file must be updated to define a PowerShell endpoint
|
|
as a subsystem. Once this is done PowerShell remoting cmdlets can be used to establish a PowerShell remoting
|
|
session over SSH that works across platforms.
|
|
|
|
$session = New-PSSession -HostName LinuxComputer1 -UserName UserA -SSHTransport
|
|
|
|
There are a number of requirements that must be satisfied for PowerShell SSH based remoting:
|
|
a. PowerShell 6.0 or greater must be installed on the system.
|
|
Since multiple PowerShell installations can appear on a single system, a specific installation can be selected.
|
|
b. SSH client must be installed on the system as PowerShell uses it for outgoing connections.
|
|
c. SSHD (ssh daemon) must be installed on the system for PowerShell to receive SSH connections.
|
|
d. SSHD must be configured with a Subsystem that serves as the PowerShell remoting endpoint.
|
|
|
|
The Enable-SSHRemoting cmdlet will do the following:
|
|
a. Detect the underlying platform (Windows, Linux, macOS).
|
|
b. Detect an installed SSH client, and emit a warning if not found.
|
|
c. Detect an installed SSHD daemon, and emit a warning if not found.
|
|
d. Accept a PowerShell (pwsh) path to be run as a remoting PowerShell session endpoint.
|
|
Or try to use the currently running PowerShell.
|
|
e. Update the SSHD configuration file to add a PowerShell subsystem endpoint entry.
|
|
|
|
If all of the conditions are satisfied then PowerShell SSH remoting will work to and from the local system.
|
|
'
|
|
|
|
PowerShellVersion = '6.0'
|
|
|
|
FunctionsToExport = 'Enable-SSHRemoting'
|
|
|
|
}
|