https://github.com/powershell/remotely
Enable remote execution of scripts. Works with Pester.
https://github.com/powershell/remotely
Last synced: about 1 month ago
JSON representation
Enable remote execution of scripts. Works with Pester.
- Host: GitHub
- URL: https://github.com/powershell/remotely
- Owner: PowerShell
- License: mit
- Archived: true
- Created: 2015-05-08T20:11:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-27T23:12:39.000Z (almost 8 years ago)
- Last Synced: 2025-01-21T12:35:56.142Z (10 months ago)
- Language: PowerShell
- Size: 33.2 KB
- Stars: 75
- Watchers: 19
- Forks: 26
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Synopsis
============
Executes a script block against a remote runspace. Remotely can be used with Pester for executing script blocks on a remote system.
Description
======================
The contents on the Remotely block are executed on a remote runspace. The connection information of the runspace is supplied in a CSV file of the format:
```
ComputerName,Username,Password
ComputerName1,Username1,Password1
ComputerName2,Username2,Password2
```
The filename must be `machineConfig.csv`.
The CSV file is expected to be placed next to this file.
If the CSV file is not found or username is not specified, the machine name is ignored and runspace to localhost
is created for executing the script block.
If the password has a ',' then it needs to be escaped by using quotes like:
```
ComputerName,Username,Password
ComputerName1,Username1,Password1
ComputerName2,Username2,"Some,other,password"
```
To get access to the streams, use GetVerbose, GetDebugOutput, GetError, GetProgressOutput,
GetWarning on the resultant object.
Example
============
Usage in Pester:
```powershell
Describe "Add-Numbers" {
It "adds positive numbers" {
Remotely { 2 + 3 } | Should Be 5
}
It "gets verbose message" {
$sum = Remotely { Write-Verbose -Verbose "Test Message" }
$sum.GetVerbose() | Should Be "Test Message"
}
It "can pass parameters to remote block" {
$num = 10
$process = Remotely { param($number) $number + 1 } -ArgumentList $num
$process | Should Be 11
}
}
```
Links
============
* https://github.com/PowerShell/Remotely
* https://github.com/pester/Pester
Running Tests
=============
Pester-based tests are located in ```/Remotely.Tests.ps1```
* Ensure Pester is installed on the machine
* Run tests:
.\Remotely.Tests.ps1
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.