The documentation you're currently reading is for version 3.2dev. Click here to view documentation for the latest stable version.
Windows Runners Configuration¶
Windows runners are DEPRECATED as of version
2.9. These runners are replaced
by WinRM Runners which use a native Python implementation
of the WinRM protocol. Please migrate all existing actions over to these new runners. Any new
code should prefer WinRM Runners over the Windows Runners.
The legacy Windows runners will be REMOVED in version
The server which is running the action runner service used for executing Windows runners actions needs to have the following dependencies installed:
smbclient>= 4.1 - Command line Samba client (
smbclientpackage on Ubuntu and
samba-clientpackage on Fedora).
winexe>= 1.1 - Command line tool for executing commands remotely on Windows hosts.
Samba client is available in standard APT and Yum repositories. To install it on Ubuntu, run:
sudo apt-get install smbclient
To install on RHEL/CentOS, run:
sudo yum install samba-client
winexe is not distributed in normal RHEL/Ubuntu package repositories. You will need to compile it yourself,
or obtain a pre-built binary.
Supported Windows Versions¶
Windows runners have been tested on the following versions of Windows:
Windows Server 2008
Windows Server 2012
The underlying library we use to talk to the Windows hosts also supports other versions (2000/XP/2003/Vista), but we haven’t tested our runners with those versions, so we can’t guarantee it will work.
Configuring your Window Server for Remote Access¶
For StackStorm to be able to run actions on your Windows servers, you need to configure them as described below.
Configuring the Firewall¶
For StackStorm to be able to reach your server, you need to configure Windows Firewall to allow traffic from the server where StackStorm components (notably action runner service) are running.
For safety reasons, you are encouraged to only allow traffic from your StackStorm server, but if you want to allow traffic from all IPs, you can run this command:
netsh firewall set service RemoteAdmin enable
Configuring the Administrator User Account¶
StackStorm requires an administrator account on the Windows host where the actions are executed to be
able to upload and run the scripts there. By default, it tries to use
Administrator account to
log in to your server.
Set the PowerShell execution policy to allow execution of the scripts. See <https://technet.microsoft.com/en-us/library/ee176961.aspx>
Ensure that default
powershell.exeis compatible with the script you are planning to run. To do so, open PowerShell and run this command:
PS C:\> $PSVersionTable Name Value ---- ----- PSVersion 4.0 ...