https://github.com/xebialabs-community/xlr-powershell-plugin
Execute Powershell scripts from within XL Release
https://github.com/xebialabs-community/xlr-powershell-plugin
overthere powershell xl-release xlr xlr-powershell-plugin xlrelease
Last synced: 23 days ago
JSON representation
Execute Powershell scripts from within XL Release
- Host: GitHub
- URL: https://github.com/xebialabs-community/xlr-powershell-plugin
- Owner: xebialabs-community
- Created: 2016-05-09T19:36:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-05-15T08:56:50.000Z (9 months ago)
- Last Synced: 2025-05-15T09:42:24.857Z (9 months ago)
- Topics: overthere, powershell, xl-release, xlr, xlr-powershell-plugin, xlrelease
- Language: Java
- Homepage:
- Size: 216 KB
- Stars: 1
- Watchers: 30
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# XLR Powershell Plugin
## Introduction
The XL Release Remote Script plugin allows *XL Release* to execute powershell commands on remote hosts. It does so by using the [Overthere](https://github.com/xebialabs/overthere) framework, a Java library for manipulating files and executing processes on remote hosts.
The **XLR Powershell Plugin** adds one more task to the *Remote Script group as follows:
* **Remote Script:Powershell:** Execute a powershell script on a Microsoft Windows host via WinRM
## CI status ##
[![Build Status][xlr-powershell-plugin-travis-image] ][xlr-powershell-plugin-travis-url]
[![Codacy Status][xlr-powershell-plugin-codacy-image] ][xlr-powershell-plugin-codacy-url]
[![Code climate Status][xlr-powershell-plugin-code-climate-image] ][xlr-powershell-plugin-code-climate-url]
[xlr-powershell-plugin-travis-image]: https://travis-ci.org/xebialabs-community/xlr-powershell-plugin.svg?branch=master
[xlr-powershell-plugin-travis-url]: https://travis-ci.org/xebialabs-community/xlr-powershell-plugin
[xlr-powershell-plugin-codacy-image]: https://api.codacy.com/project/badge/Grade/33143486e49d47728a68ad2251ed4e65
[xlr-powershell-plugin-codacy-url]: https://www.codacy.com/app/joris-dewinne/xlr-powershell-plugin
[xlr-powershell-plugin-code-climate-image]: https://codeclimate.com/github/xebialabs-community/xlr-powershell-plugin/badges/gpa.svg
[xlr-powershell-plugin-code-climate-url]: https://codeclimate.com/github/xebialabs-community/xlr-powershell-plugin
##Windows Powershell Properties##
| Property | Description |
| -------- | ----------- |
| Script | The shell script to execute on the remote host (required) |
| Remote Path | The path on the remote host where the script should be executed (required) |
| Temporary Directory Path | Where to store temporary files; this directory will be removed on connection close |
| Address and Port | Address Telnet or WinRM port of the remote host (required) |
| Username | The Unix host user log-in ID (required) |
| Password | The Unix host user password |
| Private key | The private key to use (verbatim) for authentication |
| Private key file and Passphrase | The file containing a private key, and an optional passphrase for the key it contains |
| CIFS Port | The port on which the CIFS (SMB) server runs |
| Windows path to Windows share mappings | Mapping from Windows paths to Windows share names; for example, `C:\IBM\WebSphere` → `WebSphereShare` |
| Timeout | The WinRM timeout in [XML schema duration format](http://www.w3.org/TR/xmlschema-2/#isoformats); the default value is `PT60.000S` |
| Enable HTTPS for WinRM | Check this if the remote Windows host supports encrypted connections |
## Using advanced Overthere functionality
XL Release uses the Overthere framework, which includes several connection options. While the most common options are available in the XL Release GUI, you can use other options as described in the [Overthere documentation](https://github.com/xebialabs/overthere/blob/master/README.md).
You can change the default values of options that are not exposed in the GUI in the `XLRELEASE_HOME/conf/deployit-defaults.properties` file. For example, if you wish to use 64 bit Powershell instead of x86 (which is required for certain Modules), add the following line: `remotescript.Powershell.powerShellPath=C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe`
If you need to use a different setting for a particular option per task, you can create a type modification in the `XLRELEASE_HOME/conf/synthetic.xml` file for the task types. In the modification, you can add the desired Overthere connection option as a property on the task. These task properties will automatically be used as connection options for Overthere if the name matches.
For example, to make the connection timeout configurable on each task, add this to `synthetic.xml`: