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

Note

This module is part of the community.windows collection (version 2.4.0).

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.windows.

To use it in a playbook, specify: community.windows.win_wakeonlan.

Synopsis

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

  • For non-Windows targets, use the community.general.wakeonlan module instead.

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

Notes

Note

  • This module sends a magic packet, without knowing whether it worked. It always report a change.

  • 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).

See Also

See also

community.general.wakeonlan

The official documentation on the community.general.wakeonlan module.

Examples

- name: Send a magic Wake-on-LAN packet to 00:00:5E:00:53:66
  community.windows.win_wakeonlan:
    mac: 00:00:5E:00:53:66
    broadcast: 192.0.2.23

- name: Send a magic Wake-On-LAN packet on port 9 to 00-00-5E-00-53-66
  community.windows.win_wakeonlan:
    mac: 00-00-5E-00-53-66
    port: 9
  delegate_to: remote_system

Authors

  • Dag Wieers (@dagwieers)