ansible.builtin.win_wakeonlan (v2.9.27) — module

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

| "added in version" 2.4 of ansible.builtin"

Authors: Dag Wieers (@dagwieers)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

For non-Windows targets, use the M(wakeonlan) module instead.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
mac:
    description:
    - MAC address to send Wake-on-LAN broadcast packet for.
    required: true
    type: str

port:
    default: 7
    description:
    - UDP port to use for magic Wake-on-LAN packet.
    type: int

broadcast:
    default: 255.255.255.255
    description:
    - Network broadcast address to use for broadcasting magic Wake-on-LAN packet.
    type: str

See also