W3cubDocs

/Ansible

community.general.wakeonlan module – Send a magic Wake-on-LAN (WoL) broadcast packet

Note

This module is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.wakeonlan.

Synopsis
Parameters
Attributes
Notes
See Also
Examples

Synopsis

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

Parameters

Parameter	Comments
broadcast string	Network broadcast address to use for broadcasting magic Wake-on-LAN packet. Default: `"255.255.255.255"`
mac string / required	MAC address to send Wake-on-LAN broadcast packet for.
port integer	UDP port to use for magic Wake-on-LAN packet. Default: `7`

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

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 (in other words, PXE first).

Examples

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

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

Authors

Dag Wieers (@dagwieers)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/wakeonlan_module.html