You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

New in version 2.4.

Synopsis
Options
Examples
Notes
- Status

Synopsis ¶

The win_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
  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
  win_wakeonlan:
    mac: 00-00-5E-00-53-66
    port: 9
  delegate_to: remote_system

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

Status ¶

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

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