pywinrm

pywinrm is a Python client for Windows Remote Management (WinRM). This allows you to invoke commands on target Windows machines from any machine that can run Python.

WinRM allows you to call native objects in Windows. These include, but are not limited to, running batch scripts, powershell scripts and fetching WMI variables. For more information on WinRM, please visit Microsoft's WinRM site.

Requirements

• Linux, Mac OS X or Windows
• CPython 2.6-2.7, 3.2-3.5 or PyPy 1.9
• python-kerberos is optional

Installation

To install pywinrm, simply

$ pip install pywinrm

To use Kerberos authentication you need these optional dependencies

$ sudo apt-get install python-dev libkrb5-dev
$ pip install kerberos

Example Usage

Run a process on a remote host

import winrm

s = winrm.Session('windows-host.example.com', auth=('john.smith', 'secret'))
r = s.run_cmd('ipconfig', ['/all'])
>>> r.status_code
0
>>> r.std_out
Windows IP Configuration

   Host Name . . . . . . . . . . . . : WINDOWS-HOST
   Primary Dns Suffix  . . . . . . . :
   Node Type . . . . . . . . . . . . : Hybrid
   IP Routing Enabled. . . . . . . . : No
   WINS Proxy Enabled. . . . . . . . : No
...
>>> r.std_err

NOTE: pywinrm will try and guess the correct endpoint url from the following formats:

• windows-host -> http://windows-host:5985/wsman
• windows-host:1111 -> http://windows-host:1111/wsman
• http://windows-host -> http://windows-host:5985/wsman
• http://windows-host:1111 -> http://windows-host:1111/wsman
• http://windows-host:1111/wsman -> http://windows-host:1111/wsman

Run Powershell on remote host

import winrm

ps_script = """$strComputer = $Host
Clear
$RAM = WmiObject Win32_ComputerSystem
$MB = 1048576

"Installed Memory: " + [int]($RAM.TotalPhysicalMemory /$MB) + " MB" """

s = winrm.Session('windows-host.example.com', auth=('john.smith', 'secret'))
r = s.run_ps(ps_script)
>>> r.status_code
0
>>> r.std_out
Installed Memory: 3840 MB

>>> r.std_err

Powershell script will be base64 UTF16 little endian encoded prior to sending to Windows host. Error messages are converted from the Powershell CLIXML format to a human readable format as a convenience.

Run process with low-level API

from winrm.protocol import Protocol

p = Protocol(
    endpoint='http://windows-host:5985/wsman',
    transport='plaintext',
    username='john.smith',
    password='secret')
shell_id = p.open_shell()
command_id = p.run_command(shell_id, 'ipconfig', ['/all'])
std_out, std_err, status_code = p.get_command_output(shell_id, command_id)
p.cleanup_command(shell_id, command_id)
p.close_shell(shell_id)

Enable WinRM on remote host

• Enable basic WinRM authentication (Good only for troubleshooting. For hosts in a domain it is better to use Kerberos authentication.)
• Allow unencrypted message passing over WinRM (not secure for hosts in a domain but this feature was not yet implemented.)

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

Contributors (alphabetically)

• Alessandro Pilotti
• Chris Church
• David Cournapeau
• Gema Gomez
• Jijo Varghese
• Juan J. Martinez
• Lukas Bednar
• Manuel Sabban
• Matt Clark
• Nir Cohen
• Matt Davis
• Patrick Dunnigan
• Reina Abolofia

Want to help - send a pull request. I will accept good pull requests for sure.