Documentation

wakeonlan - Send a magic Wake-on-LAN (WoL) broadcast packet

New in version 2.2.

Synopsis

  • The wakeonlan module sends magic Wake-on-LAN (WoL) broadcast packets.

Options

parameter required default choices comments
broadcast
no 255.255.255.255
Network broadcast address to use for broadcasting magic Wake-on-LAN packet.
mac
yes
MAC address to send Wake-on-LAN broadcast packet for.
port
no 7
UDP port to use for magic Wake-on-LAN packet.

Examples

- name: Send a magic Wake-on-LAN packet to 00:00:5E:00:53:66
  wakeonlan:
    mac: '00:00:5E:00:53:66'
    broadcast: 192.0.2.23
  delegate_to: localhost

- wakeonlan:
    mac: 00:00:5E:00:53:66
    port: 9
  delegate_to: localhost

Notes

Note

  • This module sends a magic packet, without knowing whether it worked
  • Only works if the target system was properly configured for Wake-on-LAN (in the BIOS and/or the OS)
  • Some BIOSes have a different (configurable) Wake-on-LAN boot order (i.e. PXE first) when turned off

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.