Skip to main content

Small library for shutting down and starting up local server

Project description

This library handles rather specific remote power management scenario.

  • Server can be woken up with wake-on-lan (WOL)
  • SSH access with public key authentication to the server (for shutting it down)
  • Server responds to ping (checking whether the server is running)

Installation:

pip install manage_server_power

or clone the repository and use

python setup.py install

Configuration and notes

On the server side:

  • Enable WOL (from BIOS/… settings).
  • Take note of relevant MAC address.
  • Add new user to server (say, powermanagement).
  • Edit sudoers (visudo) and add powermanagement ALL=NOPASSWD: /sbin/poweroff

On the management computer:

  • Generate ssh public key pair (ssh-keygen)
  • Copy public key to powermanagement user on server (add it to .ssh/authorized_keys)
  • Connect to server to check that public key works properly and to add server host key to known_hosts.

Notes:

  • At least with some devices/networks, WOL won’t work if broadcast_ip is not set to local network’s broadcast, instead of 255.255.255.255.

Usage

import manage_server_power
sp = manage_server_power.ServerPower(server_hostname="example.com",
                                     server_mac="61:a3:18:1c:84:4b",
                                     server_port=22,  # optional, default is 22
                                     ssh_username="powermanagement",
                                     broadcast_ip="192.168.1.255",  # optional, default is 255.255.255.255
                                     socket_timeout=0.5,  # optional
                                     wol_port=9,  # optional, default is 9
                                     )
print sp.is_alive()
# SERVER_DOWN, SERVER_UP or SERVER_UP_NOT_RESPONDING
print sp.wake_up()  # send WOL packet
print sp.shutdown()  # ssh in and run "sudo poweroff"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
manage_server_power-0.0.6-py2.py3-none-any.whl (5.2 kB) Copy SHA256 hash SHA256 Wheel 2.7 Apr 25, 2016
manage_server_power-0.0.6.tar.gz (3.1 kB) Copy SHA256 hash SHA256 Source None Apr 25, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page