Skip to content

Commit f70bc1b

Browse files
it-praktykSean Wheeler
authored andcommitted
Replace Windows PowerShell with PowerShell (#2776)
* resolves 5817 (#2148) add Path alias to DestinationPath for Save-Help add Path alias to SourcePath for Update-Help add Path alias to BinaryPathName for New-Service add Path alias to FilePath for Start-Process, Set-TraceSource, Tee-Object, Trace-Command, Invoke-WSManAction, New-WSManInstance, and Set-WSManInstance * Bringing even with staging (#2191) * Merging latest changes to Live (#2144) * Updates configurations.md (#1855) Two set of changes made. - Example scripts e.g. MyDscConfiguration.ps1 define the configuration inside them and call the configuration at the end line. Removed the call to the configuration at the end. Since the article demonstrates dot-sourcing the file and calling the configuration explicitly. - Fixed typo in the file name (TEST-PC1.mof to localhost.mof ), since the ComputerName was not specified it should default to using 'localhost' as the default argument for it. P.S. - There is a comment on the web-page regarding the fixes made * Fix typo in comment (#1854) * Updating the help content for v6. (#1853) * Updating the help content for v6. * Address code review comments * Fix broken links * Fix example numbers in about_Transactions.md (#1859) Example number '7' is duplicated. * Update Alias-Provider.md (#1831) 1. Removed statement that an alias is to an executable, the definition cotnains the path. It may - but does not need to be. For example: Try Set-Alias np Notepad then look at the definition. 2. Clarified that an alias can also be to a powershell script (ps1 file). 3. Tidied up the language removing multiple 'And,' clauses to improve readability. * Add documentation of new -AsHashtable switch for ConvertFrom-Json introduced by PR #5043 (#1858) * add documentation of new -AsHashTable switch for ConvertFrom-Json and also document the behaviour in case of duplicate strings. * correct casing of -AsHashtable switch. * Address PR comments about -AsHashtable switch for ConvertFrom-Json.md * Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md * Revert "Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md" Accidentally change the wrong field. This reverts commit 6e76191. * Accept pipeline input: False for -AsHashtable switch in ConvertFrom-Json.md * Fix example numbers in Invoke-WebRequest.md (#1862) Example number '4' is duplicated. * reformatting and integrating changes from PR#1831 (#1860) * Fix example numbers in Get-Help.md (#1869) Example number 12 and 13 are missing. * Fix example numbers in Import-Module.md (#1868) Example number '10' is duplicated. * Fix example number in ConvertTo-Html.html (#1867) Example number '10' is duplicated. * Update dscCiCd.md (#1865) Missing a period on line 378. Should be `$(Build.ArtifactStagingDirectory)\` not `$(BuildArtifactStagingDirectory)\`. * Web Cmdlets 6.0.0 Documentation Refresh (#1870) * Web Cmdlets 6.0.0 Documentation Refresh * Address PR Feedback * Merge Example 4 and 5 in Get-Member.md (#1874) Example 4 and 5 in Get-Member.md v3.0 and v4.0 are almost the same. They should be merged as with v5.0. * Remove hash algorithms unsupported in v6.0 (#1873) MACTripleDES and RIPEMD160 are no longer supported in v6.0. * Update outputs of Get-Verb (#1872) Since v6.0, `Get-Verb` returns not MemberDefinition but VerbInfo that has Verb and Group properties. * Fix typo in ConvertTo-Html.md (UTF-x) (#1879) * Fix "Accept wildcard characters" in Get-Service.md v6 (#1878) * Fixed "False" -> "True" (`DisplayName`, `Exclude`, `Include`, and `Name`) * Removed `InformationAction` and `InformationVariable` * Fixed Get-WindowsFeature cmdlet HyperLink (#1877) * Fixed Get-WindowsFeature cmdlet HyperLink Minor edit. Update Get-WindowsFeature cmdlet HyperLink to https://technet.microsoft.com/library/jj205469(v=wps.630).aspx * Changed URL to new docs.microsoft.com location The TechNet URL did not work. TechNet and MSDN are being retired. * Update Get-WinEvent.md (#1876) Removed future tense in a couple of places to improve readability. Minor edit. * Update Example 8 in Get-Process.md (find the owner of a process) (#1875) * Update Example 8 in Get-Process.md (Find the owner of a process) * Update to attempt to avoid build errors It seems that the build system does not accept multiple script blocks per one Example header. * updated localmachine\Root to LocalMachine\My (#1880) The example where we import the PFX on the target node should import the cert into Personal store and not root. * Update Group property example in Get-Verb.md (#1881) * adding missing space (#1885) * removing stray character (#1886) * Update Example 9 in Get-Process.md (#1888) * powershell -> pwsh (only v6.0) * Windows PowerShell -> PowerShell * Remove "About ISE" files of v6.0 (#1891) * Remove "About ISE" files of v6.0 ISE is no longer bundled with PowerShell 6.0. * Remove links for "About ISE" files of v6.0 * Update Get-Process.md (#1890) Fixed name parameter details to show it accepts wildcards in the name * Update productincompat.md (#1892) The list of compatible systems should include Skype For Business Server 2015 and Lync Server 2013. * Update unapproved verbs examples in Get-Verb.md (#1896) * Updated Example 4 * Removed Example 5 * Removing extra space in the Example 5A script (#1894) It was highlighting as string in the documentation, I was trying to remove all the extra space. * fixing merge conflict * updates to style and contrib * tweak format * tweak format 2 * fix typo * fix number list example * adding review feedback * fix broken links * incorporating feedback from zach * reformatting About_* for 80 columns - part 1 * reformat about_* * reformatting About_* topics - Part 2 * fixing broken links * fixing more broken links * more broken links fixed * Fix parameter's position in Get-Random.md (#1901) * Fix parameter's position in Measure-Command.md (#1905) * Fix parameter's position in Trace-Command.md (#1904) * Actually call the configuration in the example (#1906) On line 74, it says... "The last line of the example containing only the name of the configuration, calls the configuration." This change actually makes that call. * reformatting About_* for 80 columns - part 3 (#1902) * reformatting About_* * reformatting About_* part 3 * fixing broken links * fixing more broken links * one more time with the links * reformatting About_* for 80 columns - part 4 * Adding PreRelease versioning info for PSGallery & PSGet (#1903) * PowerShellGet PreRelease Support Adding descriptive doc for pre-release versioning support * Correcting typos in pre-release doc Minor typos and case issues fixed * Updated prerelease info based on feedback Mostly cosmetic updates. Functional change: added line 28, stating we only support 3-segment module versions. * Adding prerelease to module install update find save commands * Updating PSGet -Script commands for Prerelease support * Hyphen listed as optional rather than preferred in Prereleasestring * Minor corrections from Rebro review * Addressing @sdwheeler feedback on links and double slashes * Fixing broken link * Update PreReleaseScript.md * Style tweaks in STYLE.md (#1913) * Fix YAML metadata on "Understanding Concepts" (#1911) I'm not quite sure what this means, but it certainly looks terrible on docs.microsoft.com when it's malformed. (To be perfectly honest, I only managed to even figure out it's called "YAML metadata" by peeking at the DOM of github's HTML.) * Fix parameter's position in Join-Path.md (#1909) * typo correction on line 85 (#1916) E:\Windows\Sytem32 sould be E:\Windows\System32 * Fix parameter's position in Get-TraceSource.md (#1917) * Changed required PSGet version to 1.6.0 (#1920) * Update Example 5 in Get-Process.md (#1923) * fixing backlashes reported in PR1921 (#1924) * fixing backlashes reported in PR1921 * found more backslashes * reformatting About_* for 80 columns - part 5 * reformatting About_* for 80 columns - part 6 * incorporating review feedback * reformatting About_* for 80 columns - part 7 * Fixed formatting of output per issue #808 * Fix typo in syntax description (#1931) * Fix parameter's position in ConvertTo-Xml.md (#1929) * Remove descriptions about ComputerName parameter in Get-Process.md v6.0 (#1928) * Line 192 Single Quote Breaks Example (#1930) * Line 192 Single Quote Breaks Example * clarified the example for -Regex * Update Example 2 in Get-Alias.md (ineffective Exclude) (#1935) `-Exclude Get-*` is ineffective because there are no aliases that begin with `Get-`. * Fix formatting: DESCRIPTION section in ConvertTo-Xml.md (#1934) * Fix typo in Unregister-ScheduledJob (#1932) * Update Unregister-ScheduledJob.md * Update Unregister-ScheduledJob.md * Update Unregister-ScheduledJob.md * Update Unregister-ScheduledJob.md * Fix parameter's position in ConvertFrom-Csv.md (#1937) * fix typo on metaConfig.md (#1936) fixed typo * Quick edits (#1938) * Changed required PSGet version to 1.6.0 * Fixes to PSGet TOC and WMF 5.1 compat page * Update Get-Item.md (#1942) Proof-read some of the examples. The first two were wrong entirely: The user must be in the ps-test folder for the result shown to happen. * Add description about Format-Hex -InputObject (#1939) * Fix parameter's position in Add-Member.md (#1946) * Fix parameter's position in Select-Object.md (#1945) * Correcting add to hash table example (#1944) * Update about_Hash_Tables.md corrected add to hash table example in 3.0 * Update about_Hash_Tables.md corrected add to hash table examples in 4.0 * Update about_Hash_Tables.md corrected add to hash table example in 5.0 * Update about_Hash_Tables.md corrected add to hash table example in 5.1 * Update about_Hash_Tables.md corrected add to hash table example in 6 * Fix Set-TraceSource -ListenerOption parameter (#1949) * Fixed the value of "Accepted values:" * Fixed minor differences in formatting and wording * Fix Trace-Command -ListenerOption parameter (#1948) * Fixed the value of "Accepted values:" * Fixed minor differences in formatting and wording * Fix parameter's position in Select-Xml.md (#1953) * Fix Get-Alias -Name parameter (#1952) * Position: 0 * Default value: All aliases * Accept wildcard characters: True * Fixed minor differences in formatting and wording And also removed InformationAction/InformationVariable in v6.0. * Wmf 5.1 cleanup (#1950) * Changed required PSGet version to 1.6.0 * Fixes to PSGet TOC and WMF 5.1 compat page * Add note explaining WMF does not ship in Windows * Typo fix ("you will are not" -> "you will not"). (#1951) * Typo fix ("you will are not" -> "you will not"). * Changed from passive voice to active voice * added article about formatting code samples * fixing typos * fixed typos and incorporated feedback * updating metadata tags in docfx.json * fixing filename spelling * Fix parameter's position in Get-Content.md (#1959) * Fix parameter's position in Get-Member.md (#1958) * Update PSGallery "Items Tab" (for the new prerelease feature) (#1957) * Fix link for about_WorkflowCommonParameters in New-PSWorkflowExecutionOption.md (#1962) * Fix link for about_Types.ps1xml in Update-TypeData.md (#1961) * Fix parameter's position in Group-Object.md (#1966) * Fix hex values in about_Arithmetic_Operators.md (#1965) * Indent headers as subheaders (#1967) * Update minor typo in Limit-EventLog.md (#1968) * Update Example 3 in Get-FileHash.md (#1969) * Fix parameter's position in Tee-Object.md (#1970) * fixing output example per issue 1933 * fix -Path metadata to reflect wildcard support * fixing issue 1640 * fixing issue 1651 * Fix link for about_Remote_Requirements (#1976) * Split parameter set in Sort-Object.md v6.0 (#1975) Since v6.0, Sort-Object cmdlet has two parameter sets, "Default" and "Bottom". * Fix link for about_Preference_Variables (#1982) http://... -> relative path * Fix broken headers in Get-CimSession.md v6.0 (#1981) * Update Example 1 in Import-Counter.md (#1980) * move $OFS to prefs article added note about read-only (#1978) * Update decisionMaker.md (#1984) Slight, but critical corrections to the definition of DevOps. * Update configurations.md (#1985) * Fix parameter's position in Restart-Service.md (#1993) * Fix link for logical operators in about_Operator_Precedence.md (#1992) * Update scriptResource.md (#1986) Match specified GetScript rule * Bad link (#1988) The link "http://go.microsoft.com/fwlink/?LinkId=119096" is supposed to point to a page or a document about "Code-Signing Best Practices". However, it points to a video about "Understanding Extension INFs and Component INFs". I watched the whole video and there is nothing inside about "Code-Signing Best Practices". The best match I have found is the following one: http://download.microsoft.com/download/a/f/7/af7777e5-7dcd-4800-8a0a-b18336565f5b/best_practices.doc It would be a very good idea to make a web page from this document. Pieces of advice it contains are still accurate. * Update Example 1 of Protect-CmsMessage (#1987) The existing example did not specify you needed to create the INF. This not only says so but does so using a script block piped to out-file * Small edits for mispellings (#1989) * Corrected command (#1990) The CanPauseAndContinue property is a boolean so the correct comparison to use is $true rather than "True". * removing module ref for modules that do not ship in v6-rc2 (#1996) * Fix parameter's position in Resume-Service.md (#1998) * Fix link for about_Providers (#1999) * Help doc enhancement for ConvertFrom-StringData cmdlet (#2002) * Help doc correction Removed an unwanted * from Notes section Corrected intenting for last example Removed unwanted ... from example 2 * Help doc wnhancements in all versions for ConvertFrom-StringData Removed an unwanted * from Notes section Corrected intenting for last example Removed unwanted ... from example 2 * PowerShell 6 logging on Windows, Linux, and MacOS (#1922) * First draft of PowerShell 6 logging * Fix style guideline issues. * Document logging settings in PowerShellProperties.json * Address PR Feedback Limit lines to 80 columns, when possible Insert <br> in selected locations to improve readability of rendered markdown. * Reformatted tables Reformatted tables to work with new processing of About_* topics * Adding calling the ComputerName parameter to the example (#1964) * Adding calling the ComputerName parameter to the example * Changing quotes to brackets * Removed unused variable in Example 1 (#2004) The variable was declared but not used. It also appears in the same place in Example 2 but is used later on. * Made surrounding text agree with sample code. (#2003) * Reformatting v4 About_ topics missed in first pass (#2006) * v4 about scrub missed files * fixing broken links * fix broken link * Reformatting v3 About_ topics missed in first pass (#2005) * v3 about scrub missed files * fixing broken links * fix broken link * Reformatting v5 About_ topics missed in first pass (#2008) * v5 about scrub missed files * fixing broken links * v5.1 about scrub missed files (#2009) * Reformatting v6 About_ topics missed in first pass (#2010) * v6 about scrub missed files * fixing broken links and removing non-v6 content * final pass on About_ topic reformat (#2011) * Corrected Example 3 (#2014) * Corrected Example 3 Example 3 is an example to remove the user from the group but instead it was removing the group completely. This change adds the correct syntax to perform what was intended. See #2001 * minor edits for spacing and metadata * Enable running pandoc on about topic files (#2012) * Enable running pandoc on about topic files * Remove extra line * Removed --ascii parameter from pandoc as it is not required * Creates output directory as pandoc needs it (#2018) * remove alias `sc` to match PSCore6 (#2021) * Cmdlet help for ConvertFrom-Clixml and ConvertTo-Clixml (#2022) * Cmdlet help for ConvertFrom-Clixml and ConvertTo-Clixml for Powershell#3898 * minor edits - Removed -information* common parameters - reformat code blocks - renumbered example * minor updates - reformatted examples - removed common paramters * update link to about topic * minor edits - removed common parameters - formatted code blocks * minor edits - reformatted code blocks - removed common parameters * fix broken link (#2024) * Adding more info to Contributor Guide (#2023) * adding notes about OPS extensions * added notes about OPS extensions and linking * fix typo * fix typo * Support lifecycle doc (#1994) * first pass of support lifecycle doc * add notes on MIT license * address slee's comments on support lifecycle * respond to lifecycle feedback from Sean * add lifecycle image * Fixed spelling typo * add lifecycle to TOC * respond to feedback on lifecycle * Removed en-us from URLs You need to remove locale paths from URLs. Including en-us forces the reader to English rather than being redirected to the localized version of the article that matches their locale. * add note on 12 months, fix en-us * Fixed typo * Move setup/install and remoting docs into PowerShell-Docs (#2026) This creates a couple new topics around WSMan remoting, SSH remoting, and installing/configuring PowerShell Core. It also adds a topic on using VS Code with PowerShell. * PowerShell Core 6.0 release notes (#2020) What's New in PowerShell Core 6.0 * update TOC and change title of setup mac/linux article (#2030) * update TOC and change title of setup mac/linux article * fix typos * attempt to fix images (#2033) * attempt to fix images * update to docfx to support images * Update docfx to add image support (#2040) * attempt to fix images * update to docfx to support images * update root docfx for images * update docfx for image support * Update Installing-PowerShell-Core-on-Windows.md (#2042) The original paged rendered badly - this edit is a move of a 'to do' comment in the MD so as to not break the sentence. * Fix $PSVersionTable.OS in What's New 6.0 (#2039) $PSVersionTable.OS is: x [System.Environment]::OSVersion.VersionString o [System.Runtime.InteropServices.RuntimeInformation]::OSDescription * Update WSMan-Remoting-in-PowerShell-Core.md (#2038) The current example doesn't work for me when specifying the full file path. It just outputs the file location rather than running the script. I had to move to the location of the file and run it from there. The parameter PowerShellVersion also doesn't appear to exist anymore so I have removed that. I've also changes file paths to match the 6.0.0 GA release rather than the previous alpha 9. * Update Get-FormatData.md (#2034) Updated Get-FormatData Markdown. Fixes #1895 * Update Get-FormatData Markdown (#2035) Updated Get-FormatData Markdown. Fixes #1895 * Updated Get-Runspace Help (#2032) Updated Get-Runspace Markdown. Fixes #1883 * updated docfx to try to fix images (#2043) * attempt to fix images * update to docfx to support images * update root docfx for images * update docfx for image support * update docfx for images * Add resource per version in docfx.json (#2046) * Change 'PowerShellProperties.json' to 'powershell.config.json' in about_logging (#2050) * OPS Build config changes and minor article edits (#2051) * clean up warnings from build log * clean up moniker mapping and add image types to config * removing unneeded index pages * fixing typos * Update New-PSSessionOption.md (#2052) Missing "are" between "they" and "effective". * Update Add-Member.md example layouts (#2055) * Update Add-Member.md fixed layout of examples 1,2 ,3 * fixed format of example 5 * Removes unnecessary description about the RunAsAdministrator parameter (#2057) There is no need to have documentation for functions which do not exists in the product. There is no need to specify in which version this feature was added. Otherwise we need to add such remarks to many other features as well * Fix Example 2 in Set-PSReadlineKeyHandler.md (#2058) * Fix Example 1 in Remove-PSReadlineKeyHandler.md (#2059) * Fix minor Markdown syntax error (#2060) "Backwards compatibility with Windows PowerShell" anchor reference had incorrect Markdown syntax. * Update secureMOF.md (#2061) Update "On the Target Node: create and export the certificate" section * remove eric and jp from metadata * update docs to reflect change by https://github.com/PowerShell/PowerShell/pull/5923y (#2064) * Fix release links/names (6.0.0) (#2056) Corrected links and names to match the 6.0.0 release * Removes unexistent RunAsAdministrator parameter from the Syntax section (#2066) * Fixed path inconsistencies in Set-ItemProperty Example 2 (#2072) * Corrected path error in Example 2 * Corrected path error in Example 2 * Corrected error in Example 2 * Updated About documentation links to relative paths (#2071) * Gallery ui manifest (#2073) * Changed required PSGet version to 1.6.0 * New doc explaining how manifests affect Gallery UI * Adding new topic to TOC * Escapes angle brackets in about_Requires (#2075) This change makes content in this brackets displayable * add links for topics * About_Windows_PowerShell_5.1 #1171 * fix typo * about_Type_Operators issues #1915 * fix typos * add note about reboot (#2076) * Removed empty bullet point below notes. (#2078) A minor typo. * change PowerShellProperties.json to powershell.config.json (#2079) * Update metaConfig.md (#2081) * Update metaConfig.md * Update metaConfig.md * Fix typo in code example (#2082) * Fix example VB code (#2084) * Fix example VB code This VB code writen in a line is not compilable. `VBFromFilePublic` also requires a space. * Fix example 4 VB code for all versions * Remove the mentioning of version 2.0 * Adds missing SslProtocol parameter from Invoke-WebRequest cmdlet. (#2085) * Add SslProtocol parameter. * Add libcurl note to Certificate parameter. * Import-Csv Update examples, and UseCulture (#2086) * address example formatting Also includes some update to wording that I'll expand on in PR. * Start on update formatting for 3.0 doc * More formatting * Correcting examples and format of them. * 3.0 update format example 1 * 3.0 update to example 2 * 3.0 update example 4 * 4.0 update example 1-4 * 5.0 update example 3 and 4 * 5.1 update example 4 paragraph format * 3.0 update example 5 * 4.0 update example 5 * 5.0 update example 5 * 5.1 update example 5 * 5.1 update example 6 * 5.0 update example 6 * 4.0 update example 6 * 3.0 update example 6 * 3.0 update format of param Delimiter and Encoding * 4.0 update format of param Delimiter and Encoding * 5.0 update format of param Encoding * 5.1 update format of param Encoding * 5.0 update param header * 4.0 update param header info * 3.0 update param header info * 5.1 update remaining parameter format * 5.0 update remaining parameter format * 4.0 update remaining parameter format * 3.0 update remaining parameter format * 3.0 update remaining parameter format * 5.1 update notes format and add related link * 5.0 update notes format and add related link * 4.0 update notes format and add related link * 3.0 update notes format and add related link * update to example 1 across 3.0 to 5.1 * 6.0 Updates to description and example 1 * 4.0 update to example 1 * 3.0 - 5.1 update case of file name * 6.0 update example 2 and 3 * 3.0 - 5.1 update case of file name * 6.0 working on updating example 4 This example does not give same results I have on 6.0.1. Think other examples are going to be bad as well, have to go back and test those. * update example 4 * update example 5 * 6.0 example 6 and parameter format * addtional touchups on format * Use a working URL in Clipboard examples (#2087) * Fixed bad link in about_Hash_Tables.md docs (#2090) Links to about_Object_Creation.md were malformed in all references versions. * restoring changes made in PR#1870 (#2089) * Remove repeat description (#2093) * remove duplicate sentences (#2094) * add escape \ for the delimiter (#2095) * Fix typos in Invoke-WebRequest.md. (#2099) * Small typo in Get-PfxCertificate.md fixed (#2101) * Modify incorrect link (#2102) There is no MacOS part in linux.md, now * Update pull server documentation (#2097) * improve clarity on pull service * remove line at top of page * add community references * remove extra lines * fixed line break in bolded text This should remove the build warning. * fix toc title (#2105) * Merging changes to TOC into Staging (#2107) * refactoring TOC (#2096) * refactoring TOC * fix typo in TOC * adding redirects for deleted files (#2106) * refactoring TOC * fix typo in TOC * adding redir for deleted files * fix broken links * Fix about_Switch.md. (#2109) * fix about_Switch.md. * Fix formatting. * Fix Windows-PowerShell-Glossary.md. (#2110) * Add info on POWERSHELL_TELEMETRY_OPTOUT environment variable. (#2111) * Add details of where to look (#2112) Add details of where to look for version information. * Update Stop-Process.md (#2113) Clean up unordered list formatting. * Add ValidateDrive and ValidateUserDrive attributes information. (#2114) * Update Installing-Windows-PowerShell.md (#2118) PowerShell 6.0 has already been released. * Update Add-Member.md (#2121) Fixed Layout of Example 3 * fixing example 4 per Issue #2122 * Update Write-Debug.md (#2120) * Added new line to powershell output Added new line to clarify that the new line is a command vs output of previous command `$DebugPreference` * Added newline break to clarify between PowerShell output and command * fix typo (#2124) fix typo of invoke-command session parameter * Typo in Windows-PowerShell-Integrated-Scripting-Environment--ISE-.md (#2127) Remove duplicated 'the'. * Fixing issue 1585 - removing Information* parameters * added missing H3 for -Name param * Fixing issue 1434 * Fix issue 1434 * Minor typo fix in Format-List.md (#2129) Checked "Accept wildcard characters" from "False" to "True" for "-Property". Example 4 clearly shows that this parameter accepts wildcards. * Added missing bullet (#2133) * Fixed empty bullet (#2132) * fix broken yaml blocks in content * Adds foreach & where method added in PowerShell v4 (#2139) Adding details about foreach & where methods being added in PowerShell v4 and that they aren't available downlevel (for historical purposes) and also points to using the Pipeline methods with the resulting Foreach-Object & Where-Object cmdlets * Missing y in Active Directory (#2137) For copy and paste reasons (also it would now make a bit more sense) * #5816 add message and msg alias to Write-Information and Write-Host (#2141) * update links to published content * removed "Windows" per zach * Test-Connection Default Count value is 4 not None (#2171) * Fix inconsistency in Test-Connection Count default Currently the text description clearly describes the default functionality: four pings are sent. The documentation for the Count's Default value stated that None was default which was false. * Fix Test-Connection inconsistency for 5.0 Default value is 4, not None * Fix Test-Connection inconsistency for 6.0 Default value is 4, not None * Incorrect Whitespace (#2170) - Incorrect whitespace * Clarify the docs regarding libcurl for installation on openSUSE (#2169) - Explicitly mention the conflict error and the solution. - Make the command that looks for libcurl more precise, since the goal is to find the specific package that places the lib in the place where the RHEL PS package looks for it. Ref: PowerShell/PowerShell#6184 * Update modulewithpseditionsupport.md (#2167) typos corrected * Adding DSC Extension history (#2175) * Adding DSC Extension history * Link and JSON cleanup * Update docfx.json (#2176) * Fixing breadcrumb configs and converting TOC to YAML (#2177) * converted TOC to Yaml * converting all TOC to yaml and fixing breadcrumb warning * fixed breadcrumb for ref content * fixing broken links * Fix automation link and lint cleanup (#2180) * Fix automation link and lint cleanup * Fixed semantic lines * Fixing links and various changes (#2181) * Fixing links and various changes * Requested changes and minor fixes * Really fix the link this time * Added notes on OnRemove event (#2174) * Added notes on OnRemove event * Update Remove-Module.md * Update Remove-Module.md * Update Remove-Module.md * Update Remove-Module.md * Close fenced code block (#2184) Add "```" at the end to close the last fenced code block. * Update azureDscexthistory.md (#2182) Remove duplicated Version 2.19 section. Fix typos. * Returning 2.19 to Latest Versions in History (#2185) * Update authoringResourceMofDesigner.md (#2188) * Fixed "about_Updatable_Help" link (#2186) * Document 6.1.0 Web Cmdlets -Resume Feature (#2220) * Update Invoke-RestMethod Syntax * Add -Resume documentation to Invoke-RestMethod * Update Syntax for Invoke-WebRequest * Add -Resume documentation to Invoke-WebRequest * Document New -Form Parameter for Web Cmdlets (#2233) * Add example to Invoke-RestMethod * Document -Form Feature in Invoke-RestMethod * Add Simplified Mulitpart/Form-Data example to Invoke-WebRequest * Document -Form Feature on Invoke-WebRequest * Update docs with the info about session configurations created by Enable-PSRemoting cmdlet. (#2252) * Document PowerShell/PowerShell#6018 * update documentation to reflect that -ConfigurationName can be used with SSH (#2318) * update doc to reflect change in telemety opt out (#2316) * Add -Not Feature to Where-Object (#2292) Fix #2199 * Update docs for support of new hostname format (#2321) * update remote cmdlets for new hostname syntax * update Enter-PSSession as well * update doc on new -workingdirectory parameter (#2320) * Fix typo. (#2326) * clarify that disconnect only works with WSMan (#2344) * Web Cmdlets .NET Core 2.1 and PowerShell 6.1.0 Refresh (#2411) * Update docs to reflect new -Subsystem parameter (#2339) * update docs to reflect new -Subsystem for PSSession cmdlets * address Paul's feedback * update SSH remoting doc in regards to MFA (#2350) * add instructions to install preview for macOS addresses #2573 * change wording to match other locations * Modification for Measure-Object help file for -AllStats switch. Modification for Measure-Object help file for -AllStats switch. * update registration of MSFT repo using .deb pkg * Replace Windows PowerShell with PowerShell
1 parent e27444a commit f70bc1b

37 files changed

+561
-97
lines changed

reference/6/Microsoft.PowerShell.Core/About/about_Remote_Disconnected_Sessions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ continue to run while the session is disconnected.
2121

2222
The Disconnected Sessions feature is available only when the computer at the
2323
remote end of a connection is running Windows PowerShell 3.0 or a later
24-
version of Windows PowerShell.
24+
version of Windows PowerShell and using the WSMan transport.
2525

2626
The Disconnected Sessions feature allows you to close the session in which a
2727
PSSession was created, and even close Windows PowerShell, and shut down the

reference/6/Microsoft.PowerShell.Core/About/about_Session_Configurations.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,9 @@ supported versions of Windows, you must change the security descriptors of the
195195
session configurations to allow remote access.
196196

197197
To enable remote access to the session configurations on the computer, use the
198-
Enable-PSRemoting cmdlet.
198+
Enable-PSRemoting cmdlet. This cmdlet creates two session configurations:
199+
- with the name defined as: "PowerShell." + "current PowerShell version"
200+
- with name "PowerShell.6", untied to any specific PowerShell version.
199201

200202
Also, by default, only members of the Administrators group on the computer
201203
have Execute permission to the default session configurations, but you can

reference/6/Microsoft.PowerShell.Core/About/about_pwsh.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ pwsh[.exe]
3131
[-NoProfile]
3232
[-OutputFormat {Text | XML}]
3333
[-WindowStyle <style>]
34+
[-WorkingDirectory <DirectoryPath>]
3435
[-File <FilePath> [<Args>]]
3536
[-Command { - | <script-block> [-args <arg-array>]
3637
| <string> [<CommandParameters>] } ]
@@ -107,6 +108,13 @@ Determines how output from PowerShell is formatted. Valid values are "Text"
107108
Sets the window style for the session. Valid values are Normal, Minimized,
108109
Maximized and Hidden.
109110

111+
#### -WorkingDirectory <DirectoryPath>
112+
113+
Sets the initial working directory when starting PowerShell. Any valid
114+
PowerShell file path is supported.
115+
116+
To start PowerShell in your home directory, use: pwsh -WorkingDirectory ~
117+
110118
#### -Command
111119

112120
Executes the specified commands (and any parameters) as though they were typed
@@ -146,8 +154,9 @@ pwsh -Version
146154
# Example using a script block
147155
pwsh -Command {Get-Command -Name Get-Item}
148156
149-
# Example using a string
157+
# Examples using a string
150158
pwsh -Command "Get-Command -Name Get-Item"
159+
pwsh -Command "& {Get-Command -Name Get-Command}"
151160
152161
# Example using a command as the last parameter
153162
pwsh -Command Get-Command -Name Get-Item

reference/6/Microsoft.PowerShell.Core/Disconnect-PSSession.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ The **Disconnect-PSSession** cmdlet disconnects a Windows PowerShell session (**
4545
As a result, the **PSSession** is in a disconnected state.
4646
You can connect to the disconnected **PSSession** from the current session or from another session on the local computer or a different computer.
4747

48+
Note that this capability only works with PSSessions using the WSMan transport.
49+
4850
The **Disconnect-PSSession** cmdlet disconnects only open **PSSessions** that are connected to the current session.
4951
**Disconnect-PSSession** cannot disconnect broken or closed **PSSession** objects, or interactive **PSSession** objects started by using the Enter-PSSession cmdlet, and it cannot disconnect **PSSession** objects that are connected to other sessions.
5052

reference/6/Microsoft.PowerShell.Core/Enter-PSSession.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ Enter-PSSession -ContainerId <String> [-ConfigurationName <String>] [-RunAsAdmin
6868

6969
### HostName
7070
```
71-
Enter-PSSession [-HostName] <string> [-Port <int>] [-UserName <string>] [-KeyFilePath <string>] [-SSHTransport] [<CommonParameters>]
71+
Enter-PSSession [-HostName] <string> [-Port <int>] [-UserName <string>] [-KeyFilePath <string>] [-SSHTransport]
72+
[-Subsystem <String>] [<CommonParameters>]
7273
```
7374

7475
## DESCRIPTION
@@ -154,14 +155,14 @@ You can also use the **Exit** keyword to end the interactive session.
154155

155156
### Example 6: Start an interactive session using SSH
156157
```
157-
PS C:\> Enter-PSSession -HostName LinuxServer01 -UserName UserA
158+
PS C:\> Enter-PSSession -HostName UserA@LinuxServer01
158159
```
159160

160161
This example shows how to start an interactive session using Secure Shell (SSH). If SSH is configured on the remote computer to prompt for passwords then you will get a password prompt. Otherwise you will have to use SSH key based user authentication.
161162

162163
### Example 7: Start an interactive session using SSH and specify the Port and user authentication key
163164
```
164-
PS C:\> Enter-PSSession -HostName LinuxServer02 -UserName UserA -Port 22 -KeyFilePath c:\<path>\userAKey_rsa
165+
PS C:\> Enter-PSSession -HostName UserA@LinuxServer02:22 -KeyFilePath c:\<path>\userAKey_rsa
165166
```
166167

167168
This example shows how to start an interactive session using SSH. It uses the *Port* parameter to specify the port to use and the *KeyFilePath* parameter to specify an RSA key used to authenticate the user on the remote computer.
@@ -304,6 +305,9 @@ Specifies the session configuration that is used for the interactive session.
304305
Enter a configuration name or the fully qualified resource URI for a session configuration.
305306
If you specify only the configuration name, the following schema URI is prepended: http://schemas.microsoft.com/powershell.
306307
308+
When used with SSH, this specifies the subsystem to use on the target as defined in sshd_config.
309+
The default value for SSH is the `powershell` subsystem.
310+
307311
The session configuration for a session is located on the remote computer.
308312
If the specified session configuration does not exist on the remote computer, the command fails.
309313

@@ -419,6 +423,10 @@ Accept wildcard characters: False
419423
### -HostName
420424
Specifies a computer name for a Secure Shell (SSH) based connection.
421425
This is similar to the *ComputerName* parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM.
426+
This parameter supports specifying the user name and/or port as part of the host name parameter value using
427+
the form `user@hostname:port`.
428+
The user name and/or port specified as part of the host name takes precedence over the `-UserName` and `-Port` parameters, if specified.
429+
This allows passing multiple computer names to this parameter where some have specific user names and/or ports, while others use the user name and/or port from the `-UserName` and `-Port` parameters.
422430

423431
This parameter was introduced in PowerShell 6.0.
424432

@@ -621,6 +629,27 @@ Accept pipeline input: False
621629
Accept wildcard characters: False
622630
```
623631

632+
### -Subsystem
633+
Specifies the SSH subsystem used for the new **PSSession**.
634+
635+
This specifies the subsystem to use on the target as defined in sshd_config.
636+
The subsystem starts a specific version of PowerShell with predefined parameters.
637+
If the specified subsystem does not exist on the remote computer, the command fails.
638+
639+
If this parameter is not used, the default is the 'powershell' subsystem.
640+
641+
```yaml
642+
Type: String
643+
Parameter Sets: HostName
644+
Aliases:
645+
646+
Required: False
647+
Position: Named
648+
Default value: powershell
649+
Accept pipeline input: True (ByPropertyName)
650+
Accept wildcard characters: False
651+
```
652+
624653
### -UserName
625654
Specifies the user name for the account used to create a session on the remote computer. User authentication method will depend on how Secure Shell (SSH) is configured on the remote computer.
626655

reference/6/Microsoft.PowerShell.Core/Invoke-Command.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ Invoke-Command [-ConfigurationName <String>] [-ThrottleLimit <Int32>] [-AsJob] [
116116

117117
### HostName
118118
```
119-
Invoke-Command -ScriptBlock <scriptblock> -HostName <string[]> [-Port <int>] [-AsJob]
120-
[-HideComputerName] [-UserName <string>] [-KeyFilePath <string>] [-SSHTransport] [-RemoteDebug]
121-
[-InputObject <psobject>] [-ArgumentList <Object[]>] [<CommonParameters>]
119+
Invoke-Command [-Subsystem <String>] -ScriptBlock <scriptblock> -HostName <string[]> [-Port <int>]
120+
[-AsJob] [-HideComputerName] [-UserName <string>] [-KeyFilePath <string>] [-SSHTransport] [-RemoteDebug]
121+
[-InputObject <psobject>] [-ArgumentList <Object[]>] [<CommonParameters>]
122122
```
123123

124124
### FilePathHostName
@@ -491,21 +491,21 @@ To get the results of commands and scripts that run in disconnected sessions, us
491491

492492
### Example 17: Run a command on a remote computer using SSH
493493
```
494-
PS C:\> Invoke-Command -HostName LinuxServer01 -UserName UserA -ScriptBlock { Get-MailBox * }
494+
PS C:\> Invoke-Command -HostName UserA@LinuxServer01 -ScriptBlock { Get-MailBox * }
495495
```
496496

497497
This example shows how to run a command on a remote computer using Secure Shell (SSH). If SSH is configured on the remote computer to prompt for passwords then you will get a password prompt. Otherwise you will have to use SSH key based user authentication.
498498

499499
### Example 18: Run a command on a remote computer using SSH and specify a user authentication key
500500
```
501-
PS C:\> Invoke-Command -HostName LinuxServer01 -UserName UserA -ScriptBlock { Get-MailBox * } -KeyFilePath c:\<path>\userAKey_rsa
501+
PS C:\> Invoke-Command -HostName UserA@LinuxServer01 -ScriptBlock { Get-MailBox * } -KeyFilePath c:\<path>\userAKey_rsa
502502
```
503503

504504
This example shows how to run a command on a remote computer using SSH and specifying a key file for user authentication. You will not get a password prompt unless the key authentication fails and the remote computer is configured to allow basic password authentication.
505505

506506
### Example 19: Run a script file on multiple remote computers using SSH as a job
507507
```
508-
PS C:\> $sshConnections = @{ HostName="WinServer1"; UserName="domain\userA"; KeyFilePath="c:\users\UserA\id_rsa" }, @{ HostName="LinuxServer5"; UserName="UserB"; KeyFilePath="c:\UserB\<path>\id_rsa }
508+
PS C:\> $sshConnections = @{ HostName="WinServer1"; UserName="domain\userA"; KeyFilePath="c:\users\UserA\id_rsa" }, @{ HostName="UserB@LinuxServer5"; KeyFilePath="c:\UserB\<path>\id_rsa }
509509
PS C:\> $results = Invoke-Command -FilePath c:\Scripts\CollectEvents.ps1 -SSHConnection $sshConnections
510510
```
511511

@@ -703,6 +703,9 @@ Specifies the session configuration that is used for the new **PSSession**.
703703
Enter a configuration name or the fully qualified resource URI for a session configuration.
704704
If you specify only the configuration name, the following schema URI is prepended: http://schemas.microsoft.com/PowerShell.
705705

706+
When used with SSH, this specifies the subsystem to use on the target as defined in sshd_config.
707+
The default value for SSH is the `powershell` subsystem.
708+
706709
The session configuration for a session is located on the remote computer.
707710
If the specified session configuration does not exist on the remote computer, the command fails.
708711

@@ -1168,6 +1171,10 @@ Accept wildcard characters: False
11681171

11691172
### -HostName
11701173
Specifies an array of computer names for a Secure Shell (SSH) based connection. This is similar to the ComputerName parameter except that the connection to the remote computer is made using SSH rather than Windows WinRM.
1174+
This parameter supports specifying the user name and/or port as part of the host name parameter value using
1175+
the form `user@hostname:port`.
1176+
The user name and/or port specified as part of the host name takes precedence over the `-UserName` and `-Port` parameters, if specified.
1177+
This allows passing multiple computer names to this parameter where some have specific user names and/or ports, while others use the user name and/or port from the `-UserName` and `-Port` parameters.
11711178

11721179
This parameter was introduced in PowerShell 6.0.
11731180

@@ -1221,6 +1228,27 @@ Accept pipeline input: False
12211228
Accept wildcard characters: False
12221229
```
12231230

1231+
### -Subsystem
1232+
Specifies the SSH subsystem used for the new **PSSession**.
1233+
1234+
This specifies the subsystem to use on the target as defined in sshd_config.
1235+
The subsystem starts a specific version of PowerShell with predefined parameters.
1236+
If the specified subsystem does not exist on the remote computer, the command fails.
1237+
1238+
If this parameter is not used, the default is the 'powershell' subsystem.
1239+
1240+
```yaml
1241+
Type: String
1242+
Parameter Sets: HostName
1243+
Aliases:
1244+
1245+
Required: False
1246+
Position: Named
1247+
Default value: powershell
1248+
Accept pipeline input: True (ByPropertyName)
1249+
Accept wildcard characters: False
1250+
```
1251+
12241252
### -UserName
12251253
Specifies the user name for the account used to run a command on the remote computer. User authentication method will depend on how Secure Shell (SSH) is configured on the remote computer.
12261254

@@ -1245,9 +1273,10 @@ Accept wildcard characters: False
12451273
```
12461274

12471275
### -SSHConnection
1248-
This parameter takes an array of hashtables where each hashtable contains one or more connection parameters needed to establish a Secure Shell (SSH) connection (HostName, Port, UserName, KeyFilePath).
1276+
This parameter takes an array of hashtables where each hashtable contains one or more connection parameters needed to establish a Secure Shell (SSH) connection (HostName, Port, UserName, KeyFilePath, Subsystem).
12491277

12501278
The hashtable connection parameters are the same as defined for the HostName parameter set.
1279+
Note that the order of the keys in the hashtable result in user name and port being used for the connection where the last one specified is used. For example, if you use `@{UserName="first";HostName="second@host"}`, then the user name `second` will be used. However, if you use `@{HostName="second@host:22";Port=23}`, then port 23 will be used.
12511280

12521281
The SSHConnection parameter is useful for creating multiple sessions where each session requires different connection information.
12531282

reference/6/Microsoft.PowerShell.Core/New-PSSession.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,21 +215,21 @@ The value of the SessionOption parameter is the **SessionOption** object in the
215215

216216
### Example 12: Create a session using SSH
217217
```
218-
PS C:\> New-PSSession -HostName LinuxServer01 -UserName UserA
218+
PS C:\> New-PSSession -HostName UserA@LinuxServer01
219219
```
220220

221221
This example shows how to create a new **PSSession** using Secure Shell (SSH). If SSH is configured on the remote computer to prompt for passwords then you will get a password prompt. Otherwise you will have to use SSH key based user authentication.
222222

223223
### Example 13: Create a session using SSH and specify the port and user authentication key
224224
```
225-
PS C:\> New-PSSession -HostName LinuxServer01 -UserName UserA -Port 22 -KeyFilePath c:\<path>\userAKey_rsa
225+
PS C:\> New-PSSession -HostName UserA@LinuxServer01:22 -KeyFilePath c:\<path>\userAKey_rsa
226226
```
227227

228228
This example shows how to create a **PSSession** using Secure Shell (SSH). It uses the *Port* parameter to specify the port to use and the *KeyFilePath* parameter to specify an RSA key used to identify and authenticate the user on the remote computer.
229229

230230
### Example 14: Create multiple sessions using SSH
231231
```
232-
PS C:\> $sshConnections = @{ HostName="WinServer1"; UserName="domain\userA"; KeyFilePath="c:\users\UserA\id_rsa" }, @{ HostName="LinuxServer5"; UserName="UserB"; KeyFilePath="c:\UserB\<path>\id_rsa }
232+
PS C:\> $sshConnections = @{ HostName="WinServer1"; UserName="domain\userA"; KeyFilePath="c:\users\UserA\id_rsa" }, @{ HostName="UserB@LinuxServer5"; KeyFilePath="c:\UserB\<path>\id_rsa }
233233
PS C:\> New-PSSession -SSHConnection $sshConnections
234234
```
235235

@@ -372,6 +372,9 @@ Specifies the session configuration that is used for the new **PSSession**.
372372
Enter a configuration name or the fully qualified resource URI for a session configuration.
373373
If you specify only the configuration name, the following schema URI is prepended: http://schemas.microsoft.com/PowerShell.
374374
375+
When used with SSH, this specifies the subsystem to use on the target as defined in sshd_config.
376+
The default value for SSH is the `powershell` subsystem.
377+
375378
The session configuration for a session is located on the remote computer.
376379
If the specified session configuration does not exist on the remote computer, the command fails.
377380

reference/6/Microsoft.PowerShell.Core/Save-Help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Do not specify a file name or file name extension.
189189
```yaml
190190
Type: String[]
191191
Parameter Sets: Path
192-
Aliases:
192+
Aliases: Path
193193

194194
Required: True
195195
Position: 0

reference/6/Microsoft.PowerShell.Core/Update-Help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ For more information, see about_Group_Policy_Settings (http://go.microsoft.com/f
365365
```yaml
366366
Type: String[]
367367
Parameter Sets: Path
368-
Aliases:
368+
Aliases: Path
369369
370370
Required: False
371371
Position: 1

reference/6/Microsoft.PowerShell.Core/Where-Object.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ Selects objects from a collection based on their property values.
2121
Where-Object [-InputObject <PSObject>] [-Property] <String> [[-Value] <Object>] [-EQ] [<CommonParameters>]
2222
```
2323

24+
### NotSet
25+
```
26+
Where-Object [-Property] <string> -Not [-InputObject <psobject>] [<CommonParameters>]
27+
```
28+
2429
### ScriptBlockSet
2530

2631
```
@@ -924,6 +929,25 @@ Accept pipeline input: False
924929
Accept wildcard characters: False
925930
```
926931

932+
### -Not
933+
Indicates that this cmdlet gets objects if the property does not exist or has a value of null or false.
934+
935+
For example: `Get-Service | where -Not "DependentServices"`
936+
937+
This parameter was introduced in Windows PowerShell 6.1.
938+
939+
```yaml
940+
Type: SwitchParameter
941+
Parameter Sets: Not
942+
Aliases:
943+
944+
Required: True
945+
Position: Named
946+
Default value: None
947+
Accept pipeline input: False
948+
Accept wildcard characters: False
949+
```
950+
927951
### -NotContains
928952

929953
Indicates that this cmdlet gets objects if none of the items in the property value is an exact match for the specified value.

0 commit comments

Comments
 (0)