Support OpenSSH options for PSRP over SSH commands #12802

BrannenGH · 2020-05-26T22:50:54Z

PR Summary

Add an -Options parameter to Invoke-Command and Start-PSSession to pass SSH options

Options parameter added to Invoke-Command
Options parameter added to Start-PSSession
Options parameter added to Enter-PSSession
Options parameter added to SSHConnection Hashtable

PR Context

PSRP over SSH uses OpenSSH to connect to remote machines. It would be helpful if we could pass OpenSSH options to cmdlets that support PSRP over SSH.

PR Checklist

msftclas · 2020-05-26T22:51:07Z

All CLA requirements met.

PaulHigin

These changes look good to me, but can you also update the Enter-PSSession command? SSH remoting is supported by Invoke-Command, New-PSSession, and Enter-PSSession.
https://github.com/PowerShell/PowerShell/blob/master/src/System.Management.Automation/engine/remoting/commands/PushRunspaceCommand.cs#L51

PaulHigin

LGTM

iSazonov · 2020-06-01T17:37:32Z

@BrannenGH Are you ready to remove WIP?

BrannenGH · 2020-06-02T01:07:02Z

@PaulHigin @iSazonov Thanks for reviewing this so quickly! WIP is removed. I'll take a look at the docs later this week. Let me know if you need anything else.

iSazonov · 2020-06-02T03:25:47Z

src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs

+            {
+                foreach (DictionaryEntry pair in this.Options) 
+                {
+                    startInfo.ArgumentList.Add(string.Format(CultureInfo.InvariantCulture, @"-o {0}={1}", pair.Key, pair.Value));


Since we get this through public API should we make additional validations?
I mean that Key and Value could contain composite values.
/cc @PaulHigin

I see your point, right now the Format method will just try to convert whatever is passed in to a string, would we want to handle composite values any other way?

I also could try to add some validation to ensure that we're only passing options that OpenSSH would consider valid, but that would be a lot to maintain as well. Please let me know your thoughts.

iSazonov · 2020-06-02T03:31:33Z

test/SSHRemoting/SSHRemoting.Basic.Tests.ps1

+        It "Verifies explicit Options parameter" {
+            $options = @{"Port"="22"}
+            $script:session = New-PSSession -HostName localhost -Options $options -ErrorVariable err
+            $err | Should -HaveCount 0
+            VerifySession $script:session
+        }


This test checks that the parameter is only recognized, but does not verify that it is being applied.

I can definitely add more integration tests, it will take me a few days to get those done though.

ghost · 2020-06-13T02:00:17Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Mainainer, Please provide feedback and/or mark it as Waiting on Author

* Options parameter added to Invoke-Command * Options parameter added to Start-PSSession * Options parameter added to SSHConnection Hashtable

ghost · 2021-09-23T02:00:59Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

iSazonov · 2022-01-19T06:38:37Z

/rebase

iSazonov · 2022-01-19T06:38:50Z

@PaulHigin Is it ready to merge?

PaulHigin · 2022-01-21T20:52:20Z

@iSazonov Yes, I feel this is ready to merge.

pull-request-quantifier-deprecated · 2022-01-22T06:23:53Z

This PR has 54 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Small
Size       : +50 -4
Percentile : 21.6%

Total files changed: 6

Change summary by file extension:
.cs : +45 -4
.ps1 : +5 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detetcted.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

iSazonov · 2022-01-22T06:24:03Z

/rebase

iSazonov · 2022-01-22T07:00:50Z

@BrannenGH Thanks for your contribution!

ghost · 2022-02-24T23:33:52Z

🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

ghost assigned iSazonov May 26, 2020

iSazonov requested a review from PaulHigin May 27, 2020 07:22

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label May 27, 2020

iSazonov added this to the 7.1.0-preview.4 milestone May 27, 2020

iSazonov requested review from SteveL-MSFT and anmenaga May 27, 2020 07:25

PaulHigin suggested changes May 29, 2020

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 29, 2020

ghost removed this from the 7.1.0-preview.4 milestone May 29, 2020

BrannenGH force-pushed the feature/SSHOptions branch from f5402fe to 07d61eb Compare May 31, 2020 01:24

iSazonov requested a review from PaulHigin May 31, 2020 04:30

iSazonov added Review - Needed The PR is being reviewed and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels May 31, 2020

BrannenGH mentioned this pull request Jun 1, 2020

SSH Options: Add documentation for the Options parameter in PowerShell remoting over SSH MicrosoftDocs/PowerShell-Docs#6046

Closed

12 tasks

PaulHigin approved these changes Jun 1, 2020

View reviewed changes

ghost removed the Review - Needed The PR is being reviewed label Jun 1, 2020

BrannenGH changed the title ~~WIP: Support OpenSSH options for PSRP over SSH commands~~ Support OpenSSH options for PSRP over SSH commands Jun 2, 2020

iSazonov reviewed Jun 2, 2020

View reviewed changes

BrannenGH changed the title ~~Support OpenSSH options for PSRP over SSH commands~~ WIP: Support OpenSSH options for PSRP over SSH commands Jun 5, 2020

ghost added the Review - Needed The PR is being reviewed label Jun 13, 2020

SteveL-MSFT added the Backport-7.2.x-Consider label Dec 15, 2020

matsmcp mentioned this pull request Mar 15, 2021

add jumphost support for SSH PSSessions #8950

Closed

SteveL-MSFT changed the title ~~WIP: Support OpenSSH options for PSRP over SSH commands~~ Support OpenSSH options for PSRP over SSH commands Jul 21, 2021

BrannenGH added 3 commits July 21, 2021 13:45

Add Options parameter to PSRP over SSH commands

3cdf4a6

* Options parameter added to Invoke-Command * Options parameter added to Start-PSSession * Options parameter added to SSHConnection Hashtable

Add Options parameter to Enter-PSSession

e26ba2a

Fix CodeFactor style issues

9ca1e59

fix merge conflict

2a2d149

SteveL-MSFT force-pushed the feature/SSHOptions branch from 07d61eb to 2a2d149 Compare July 21, 2021 21:33

adityapatwardhan removed the Backport-7.2.x-Consider label Sep 15, 2021

ghost removed the Review - Needed The PR is being reviewed label Sep 15, 2021

ghost added the Review - Needed The PR is being reviewed label Sep 23, 2021

ghost removed the Review - Needed The PR is being reviewed label Jan 19, 2022

iSazonov closed this Jan 22, 2022

iSazonov reopened this Jan 22, 2022

pull-request-quantifier-deprecated bot added the Small label Jan 22, 2022

iSazonov merged commit 0302b1f into PowerShell:master Jan 22, 2022

ghost mentioned this pull request Feb 24, 2022

Support passing options to SSH through cmdlets that allow remoting over SSH #12762

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support OpenSSH options for PSRP over SSH commands #12802

Support OpenSSH options for PSRP over SSH commands #12802

BrannenGH commented May 26, 2020 •

edited

msftclas commented May 26, 2020 •

edited

PaulHigin left a comment

PaulHigin left a comment

iSazonov commented Jun 1, 2020

BrannenGH commented Jun 2, 2020

iSazonov Jun 2, 2020

BrannenGH Jun 3, 2020

iSazonov Jun 2, 2020

BrannenGH Jun 3, 2020

ghost commented Jun 13, 2020

ghost commented Sep 23, 2021

iSazonov commented Jan 19, 2022

iSazonov commented Jan 19, 2022

PaulHigin commented Jan 21, 2022

pull-request-quantifier-deprecated bot commented Jan 22, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

iSazonov commented Jan 22, 2022

iSazonov commented Jan 22, 2022

ghost commented Feb 24, 2022

Support OpenSSH options for PSRP over SSH commands #12802

Support OpenSSH options for PSRP over SSH commands #12802

Conversation

BrannenGH commented May 26, 2020 • edited

PR Summary

PR Context

PR Checklist

msftclas commented May 26, 2020 • edited

PaulHigin left a comment

Choose a reason for hiding this comment

PaulHigin left a comment

Choose a reason for hiding this comment

iSazonov commented Jun 1, 2020

BrannenGH commented Jun 2, 2020

iSazonov Jun 2, 2020

Choose a reason for hiding this comment

BrannenGH Jun 3, 2020

Choose a reason for hiding this comment

iSazonov Jun 2, 2020

Choose a reason for hiding this comment

BrannenGH Jun 3, 2020

Choose a reason for hiding this comment

ghost commented Jun 13, 2020

ghost commented Sep 23, 2021

iSazonov commented Jan 19, 2022

iSazonov commented Jan 19, 2022

PaulHigin commented Jan 21, 2022

pull-request-quantifier-deprecated bot commented Jan 22, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

iSazonov commented Jan 22, 2022

iSazonov commented Jan 22, 2022

ghost commented Feb 24, 2022

BrannenGH commented May 26, 2020 •

edited

msftclas commented May 26, 2020 •

edited