Documentation for wolproxypy module

main

The main module of the wolproxypy application.

run()

Run wake on lan as a CLI application.

wol(mac, ip='255.255.255.255', port=9, interface=None)

Wake up computers having any of the given mac addresses.

Wake on lan must be enabled on the host device. Leverages the PyPy package wakeonlan.

Parameters:

  • mac (str) – One or more mac addresses of machines to wake. Acceptable formats are: 'AA:BB:CC:DD:EE:FF' or 'AA-BB-CC-DD-EE-FF' or 'AABBCCDDEEFF' or 'AABBCC.DDEEFF'.
Returns:

  • status – "success" if the magic packet was sent successfully; "failure" otherwise.