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.

Source Distribution

manage_server_power-0.0.6.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

manage_server_power-0.0.6-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file manage_server_power-0.0.6.tar.gz.

File metadata

File hashes

Hashes for manage_server_power-0.0.6.tar.gz
Algorithm Hash digest
SHA256 8274382b6d8e4e9f398e2d040b750f31f65183db917d2e1f4cff4ea9b40ba2aa
MD5 51269ca8f7ee28d074f1dca8f6f25f77
BLAKE2b-256 55c883aec0e525cd29042e3336d51a36ff059d4f6416c3973e144b099a13b3de

See more details on using hashes here.

File details

Details for the file manage_server_power-0.0.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for manage_server_power-0.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 200579224181a4b219f8df4f0d5cad63bf804996a09ba82e7a1f62dda7cedb4b
MD5 10923b4a9ed104d566ee26309fbc826d
BLAKE2b-256 1401aa37a5570e9f8b1454d2b482ad3740d17bd7049b89920b08bc0053bd6d52

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page