Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Invoke-Command: Improve -SSHConnection and -SSHTransport parameter descriptions #4869

Open
mklement0 opened this issue Oct 2, 2019 · 0 comments

Comments

@mklement0
Copy link
Contributor

commented Oct 2, 2019

  • The -SSHConnection parameter description should note that:

    • The only required key in the hashtable is ComputerName,
    • That the alias for ComputerName is HostName and the alias for KeyFilePath is IdentityFilePath.
    • There is a an additional key, Subsystem, that is currently not documented at all - it corresponds to the -ConfigurationName parameter.
    • See source-code file PSRemotingCmdlet.cs.
  • Worth noting in the description of the -SSHTransport switch that it is implied if -HostName is also specified, so that it is sufficient to use -HostName <host> to target a single host via SSH (with default connection parameters).

Issue Details

Version(s) of document impacted

  • Impacts 7 document
  • Impacts 6 document
  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document

Reason(s) for not selecting all version of documents

  • The documented feature was introduced in selected version of PowerShell
  • This issue only shows up in selected version of the document
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.