W3cubDocs

/Ansible

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

# Send a magic Wake-on-LAN packet to 00:00:5E:00:53:66
- local_action: wakeonlan mac=00:00:5E:00:53:66 broadcast=192.0.2.23

- 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

Note

Only works if the target system was properly configured for Wake-on-LAN (in the BIOS and/or the OS)

Note

Some BIOSes have a different (configurable) Wake-on-LAN boot order (i.e. PXE first) when turned off

This is an Extras Module

For more information on what this means please read Extras Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/wakeonlan_module.html