community.general.wakeonlan module – Send a magic Wake-on-LAN (WoL) broadcast packet
Note
This module is part of the community.general collection (version 8.6.4).
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
The
wakeonlan
module sends magic Wake-on-LAN (WoL) broadcast packets.
Aliases: remote_management.wakeonlan
Parameters
Parameter |
Comments |
---|---|
Network broadcast address to use for broadcasting magic Wake-on-LAN packet. Default: |
|
MAC address to send Wake-on-LAN broadcast packet for. |
|
UDP port to use for magic Wake-on-LAN packet. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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).
See Also
See also
- community.windows.win_wakeonlan
Send a magic Wake-on-LAN (WoL) broadcast packet.
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