community.general.wakeonlan (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• 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
  community.general.wakeonlan:
    mac: '00:00:5E:00:53:66'
    broadcast: 192.0.2.23
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

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

• community.windows.win_wakeonlan