v2.29.0

Author: jdhitsolutions

PSScriptTools.psd1

@@ -50,6 +50,23 @@ Uninstall-Module PSScriptTools -allversions
 
 ## General Tools
 
+### [Copy-PSFunction](docs/Copy-PSFunction.md)
+
+This command is designed to solve the problem when you want to run a function loaded locally on a remote computer. Copy-PSFunction will copy a PowerShell function that is loaded in your current PowerShell session to a remote PowerShell session. The remote session must already be created. The copied function only exists remotely for the duration of the remote PowerShell session.
+
+```powershell
+$s = new-pssession -ComputerName win10 -cred $art
+Copy-PSFunction Get-Status -Session $s
+```
+
+Once copied, you might use `Invoke-Command` to run it.
+
+```powershell
+Invoke-Command { get-status -asstring } -session $s
+```
+
+If the function relies on external or additional files, you will have to copy them to the remote session separately.
+
 ### [Get-PSProfile](docs/Get-PSProfile.md)
 
 This command is designed for Windows systems and make it easy to identify all possible PowerShell profile scripts. Including those for hosts such as VSCode or the PowerShell ISE. The command writes a custom object to the pipeline which has defined formatting. The default view is a table.
@@ -354,7 +371,7 @@ New-PSDrivehere \\ds416\backup\ Backup
 
 ### [Get-MyVariable](docs/Get-MyVariable.md)
 
-This function will return all variables not defined by PowerShell or by this function itself. The default is to return all user-created variables from the global scope but you can also specify a scope such as script, local or a number 0 through 5.
+This function will return all variables not defined by PowerShell or by this function itself. The default is to return all user-created variables from the global scope but you can also specify a scope such as `script`, `local` or a number 0 through 5.
 
 ```text
 PS C:\> Get-MyVariable
@@ -1048,7 +1065,7 @@ This is a handy command when traveling and your laptop is using a locally derive
 It can be tricky sometimes to see a time in a foreign location and try to figure out what that time is locally. This command attempts to simplify this process. In addition to the remote time, you need the base UTC offset for the remote location.
 
 ```text
-PS C:\> Get-TimeZone -ListAvailable | Where-Object id -match hawaii
+PS C:\> Get-TimeZone -ListAvailable | Where-Object id -match Hawaii
 
 
 Id                         : Hawaiian Standard Time
@@ -1628,7 +1645,7 @@ OperatingSystem : Microsoft Windows 10 Pro
 Runtime         : 40.21:12:01
 ```
 
-If you run this command within VS Code and specify `-Passthru`, the resulting file will be opened in your editor.
+If you run this command from Visual Studio Code and specify `-Passthru`, the resulting file will be opened in your editor.
 
 ### [Test-IsPSWindows](docs/Test-IsPSWindows.md)
 
@@ -1815,4 +1832,4 @@ If you find this module useful, you might also want to look at my PowerShell too
 
 Where possible these commands have been tested with PowerShell 7, but not every platform. If you encounter problems, have suggestions or other feedback, please post an [issue](https://github.com/jdhitsolutions/PSScriptTools/issues). It is assumed you will __not__ be running these commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
 
-Last Updated *2020-09-11 12:18:44Z*
+Last Updated *2020-09-29 12:53:26Z*

PSScriptToolsManual.pdf

@@ -1,5 +1,11 @@
 # ChangeLog for PSScriptTools
 
+## v2.29.0
+
++ Modified `Get-WindowsVersion` to not use remoting when connecting to the local computer. (Issue #90)
++ Updated help documentation for `Get-WindowsVersion` and `Get-WindowsVersionString`.
++ Added command `Copy-PSFunction` with an alias of `cpfun`.
+
 ## v2.28.0
 
 + Added `Compare-Script` thanks to @cohdjn.

README.md

@@ -0,0 +1,104 @@
+---
+external help file: PSScriptTools-help.xml
+Module Name: PSScriptTools
+online version: https://github.com/jdhitsolutions/PSScriptTools/blob/master/docs/Copy-PSFunction.md
+schema: 2.0.0
+---
+
+# Copy-PSFunction
+
+## SYNOPSIS
+
+Copy a local PowerShell function to a remote session.
+
+## SYNTAX
+
+```yaml
+Copy-PSFunction [-Name] <String[]> -Session <PSSession> [-Force] [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+This command is designed to solve the problem when you want to run a function loaded locally on a remote computer. Copy-PSFunction will copy a PowerShell function that is loaded in your current PowerShell session to a remote PowerShell session. The remote session must already be created. The copied function only exists remotely for the duration of the remote PowerShell session.
+
+If the function relies on external or additional files, you will have to copy them to the remote session separately.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+PS C:\> "Get-LastBoot","Get-DiskFree" | Copy-PSFunction -session $S
+```
+
+Copy the local functions Get-LastBoot and Get-DiskFree to a previously created PSSession saved as $S. You could then run the function remotely using Invoke-Command.
+
+## PARAMETERS
+
+### -Force
+
+Overwrite an existing function with the same name. The default behavior is to skip existing functions.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Name
+
+Enter the name of a local function.
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -Session
+
+Specify an existing PSSession.
+
+```yaml
+Type: PSSession
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### System.String[]
+
+## OUTPUTS
+
+### Deserialized.System.Management.Automation.FunctionInfo
+
+## NOTES
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+## RELATED LINKS
+
+[Copy-Item]()

changelog.md

@@ -22,6 +22,8 @@ Get-WindowsVersion [[-Computername] <String[]>] [-Credential <PSCredential>]
 
 This is a PowerShell version of the winver.exe utility. This command uses PowerShell remoting to query the registry on a remote machine to retrieve Windows version information. The parameters are the same as in Invoke-Command.
 
+If you are querying the local computer, all other parameters will be ignored.
+
 ## EXAMPLES
 
 ### EXAMPLE 1
@@ -68,7 +70,7 @@ Windows Server 2016 Standard   ServerStandardEval   1607       14393  2/6/2020 5
 Evaluation
 ```
 
-Get windows version information from remote computers using an alternate credential.
+Get Windows version information from remote computers using an alternate credential.
 
 ### Example 3
 
@@ -183,7 +185,7 @@ The default value is Default.
 
 CredSSP authentication is available only in Windows Vista, Windows Server 2008, and later versions of the Windows operating system.
 
-For information about the values of this parameter, see the description of the AuthenticationMechanismEnumeration (http://go.microsoft.com/fwlink/?LinkID=144382) in theMicrosoft Developer Network (MSDN) library.
+For information about the values of this parameter, see the description of the AuthenticationMechanismEnumeration (http://go.microsoft.com/fwlink/?LinkID=144382) in the Microsoft Developer Network (MSDN) library.
 
 CAUTION: Credential Security Support Provider (CredSSP) authentication, in which the user's credentials are passed to a remote computer to be authenticated, is designed for commands that require authentication on more than one resource, such as accessing a remote network share.
 This mechanism increases the security risk of the remote operation. If the remote computer is compromised, the credentials that are passed to it can be used to control the network session.

docs/Copy-PSFunction.md

@@ -23,6 +23,8 @@ Get-WindowsVersionString [[-Computername] <String[]>]
 
 This is a PowerShell version of the winver.exe utility.T his command uses PowerShell remoting to query the registry on a remote machine to retrieve Windows version information. The parameters are the same as in Invoke-Command. The command writes a string of version information.
 
+If you are querying the local computer, all other parameters will be ignored.
+
 ## EXAMPLES
 
 ### EXAMPLE 1
@@ -141,7 +143,7 @@ The default value is Default.
 
 CredSSP authentication is available only in Windows Vista, Windows Server 2008, and later versions of the Windows operating system.
 
-For information about the values of this parameter, see the description of the AuthenticationMechanismEnumeration (http://go.microsoft.com/fwlink/?LinkID=144382) in theMicrosoft Developer Network (MSDN) library.
+For information about the values of this parameter, see the description of the AuthenticationMechanismEnumeration (http://go.microsoft.com/fwlink/?LinkID=144382) in the Microsoft Developer Network (MSDN) library.
 
 CAUTION: Credential Security Support Provider (CredSSP) authentication, in which the user's credentials are passed to a remote computer to be authenticated, is designed for commands that require authentication on more than one resource, such as accessing a remote network share.
 This mechanism increases the security risk of the remote operation. If the remote computer is compromised, the credentials that are passed to it can be used to control the network session.