giordyb/rundeck-powershell-plugin

rundeck-powershell-plugin

Description

A Rundeck Node Executor plugin that allow to execute commands on local or remote nodes via native Powershell.

Tested on Centos 7.3 with Rundeck 2.8.4 and Powershell 6.0b4

The idea is to replace the WinRM ruby plugin with the native Linux Powershell implementation.

A note about the remote node authentication: the plugin supports both Basic and Negotiate(NTLM) types of authentication (tested on Windows Server 2012R2/2016). For security reasons, please use the "Negotiate" authentication type (encrypted) instead of basic (unencrypted)

Setup Powershell for Linux NTLM Authentication

In order to configure NTLM on Linux, on top of the powershell binaries you will need to install the following packages:

• epel-release
• krb5-workstation
• krb5-devel
• gssntlmssp (requires epel-release to be installed beforehand)

Installation

• Copy the zip file in $RDECK_BASE/libext
• Edit your project and select "Powershell Executor" as the default node executor and "Powershell script runner" as the Default Node Copier
• In the Default Node Executor section add the username and password (only used when invoking commands against a remote host) and select the Authentication Type.
• Edit your rundeck resources.xml and for each remote node add:
  • node-executor="PSExe" file-copier="PSScript"
• if you want to run Powershell against your Rundeck Server you also need to add
  • local-node-executor="PSExe" file-copier="PSScript"

Configuration on Windows (only needed for Basic Auth)

winrm set winrm/config/client/auth @{Basic="true"}
winrm set winrm/config/service/auth @{Basic="true"}
winrm set winrm/config/service @{AllowUnencrypted="true"}

Details

This plugin can handle both remote commands and inline scripts.

If the script/command is run agains the local Rundeck host it will just run the command or the script in the local powershell environment

if the script/command is run against a remote node it will run an invoke-command.

The script copier doesn't actually copy anything, it just handles the creation and deletion of the temp script files which get then either executed locally or added to invoke-command with the -filepath parameter

Credits

Much of this work has been inspired by the Rundeck Telnet Plugin and the Rundeck WinRM Plugin

rundeck-powershell-plugin's Issues

Issue : Script won't run

Hello @giordyb

After running a command successfully I have tried to run this script on the same host:

I have this output:

Could you help me ?

Thank you

Question : How to override user and password ?

Hello @giordyb

Could you tell me how to override user and password in job definition ? because I have tested with option winrmuser and winrmpass like in Rundeck powershell ruby plugin but it doesn't work.

Error:

Thank you for your support !

Issue : FailFast: Object reference not set to an instance of an object.

Hi giordyb,

I have an issue when I execute a simple command-line like write-host "Hello" or a simple script :

My Rundeck version is 2.10.0
OS : CentOS 7

I have followed the installation instruction without error.

My Rundeck XML ressource file contain for each node like frap050 :

I'm using negotiate in Auth type

Could you help me ?

Thank you.