{"id":7458,"date":"2020-05-08T15:58:59","date_gmt":"2020-05-08T19:58:59","guid":{"rendered":"https:\/\/jdhitsolutions.com\/blog\/?p=7458"},"modified":"2020-05-08T16:15:07","modified_gmt":"2020-05-08T20:15:07","slug":"a-powershell-remote-function-framework","status":"publish","type":"post","link":"https:\/\/jdhitsolutions.com\/blog\/powershell\/7458\/a-powershell-remote-function-framework\/","title":{"rendered":"A PowerShell Remote Function Framework"},"content":{"rendered":"\n

The other day I shared a PowerShell function to query the registry on remote computers to find installed versions of PowerShell<\/a>. The function leveraged PowerShell remoting with the flexibility of using a computer name with an optional credential or existing PSSessions. The more I thought about it, the more I realized that the structure could be re-used for any command that I wanted to run on a remote computer. I think this is a terrific way to use PowerShell. With a little re-work, I came up with what I'm calling a remote function framework.<\/p>\n\n\n\n

The majority of the function's parameters are based on what you would use to create a PSSession. The function uses the session to run a scriptblock remotely. Because I wanted to support PowerShell 7 which can use SSH for remoting, I wanted to add the necessary parameters like Hostname. Those parameters are only available on PowerShell 7 so I'm defining them as dynamic parameters with their own parameter set. Although, you could just as easily define the parameters in the Param block.<\/p>\n\n\n\n

The function creates temporary sessions as needed one at a time.I did this so that I could better handle exceptions. The code also had to account for values being passed by a parameter or from the pipeline. To simplify things, I removed the default value for $Computername and made it mandatory.<\/p>\n\n\n\n

To create your own command from my framework, all you really need to do is define the scriptblock, and any optional parameters you might need.<\/p>\n\n\n\n

The framework function is on Github.<\/p>\n