Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

A small python module for wake on lan.

Project description

Pypi version Supported Python versions Build Status Documentation Status Code coverage

A small python module for wake on lan.

For more information on the wake on lan protocol please take a look at Wikipedia.

Usage

To wake up a computer using wake on lan it must first be enabled in the BIOS settings. Please note the computer you are trying to power on does not have an ip address, but it does have a mac address. The package needs to be sent as a broadcast package.

As a python module

  • Import the module
>>> from wakeonlan import send_magic_packet
  • Wake up a single computer by its mac address
>>> send_magic_packet('ff.ff.ff.ff.ff.ff')
  • Wake up multiple computers by their mac addresses.
>>> send_magic_packet('ff.ff.ff.ff.ff.ff', '00-00-00-00-00-00',
...                   'FFFFFFFFFFFF')
  • An external host may be specified. Do note that port forwarding on that host is required. The default ip address is 255.255.255.255 and the default port is 9.
>>> send_magic_packet('ff.ff.ff.ff.ff.ff',
...                   ip_address='example.com',
...                   port=1337)

As a standalone script

usage: wakeonlan [-h] [-i ip] [-p port] mac address [mac address ...]

Wake one or more computers using the wake on lan protocol.

positional arguments:
  mac address  The mac addresses or of the computers you are trying to wake.

optional arguments:
  -h, --help   show this help message and exit
  -i ip        The ip address of the host to send the magic packet to.
               (default 255.255.255.255)
  -p port      The port of the host to send the magic packet to (default 9)

Dependencies

  • Python2.x or Python3.x

License

MIT

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
wakeonlan-1.1.6-py2.py3-none-any.whl (6.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Mar 25, 2018
wakeonlan-1.1.6.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None Mar 25, 2018

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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page