mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 16:01:55 +00:00
d487734fea
replace batch of redundant to_native() occurrences (#11098)
* replace batch of redundant to_native() occurrences
* add changelog frag
(cherry picked from commit 634be713bb)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
134 lines
3.6 KiB
Python
134 lines
3.6 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2016, Dag Wieers <dag@wieers.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
DOCUMENTATION = r"""
|
|
module: wakeonlan
|
|
short_description: Send a magic Wake-on-LAN (WoL) broadcast packet
|
|
description:
|
|
- The C(wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets.
|
|
extends_documentation_fragment:
|
|
- community.general.attributes
|
|
attributes:
|
|
check_mode:
|
|
support: full
|
|
diff_mode:
|
|
support: none
|
|
options:
|
|
mac:
|
|
description:
|
|
- MAC address to send Wake-on-LAN broadcast packet for.
|
|
required: true
|
|
type: str
|
|
broadcast:
|
|
description:
|
|
- Network broadcast address to use for broadcasting magic Wake-on-LAN packet.
|
|
default: 255.255.255.255
|
|
type: str
|
|
port:
|
|
description:
|
|
- UDP port to use for magic Wake-on-LAN packet.
|
|
default: 7
|
|
type: int
|
|
todo:
|
|
- Add arping support to check whether the system is up (before and after)
|
|
- Enable check-mode support (when we have arping support)
|
|
- Does not have SecureOn password support
|
|
notes:
|
|
- 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 (in other words, PXE first).
|
|
seealso:
|
|
- module: community.windows.win_wakeonlan
|
|
author:
|
|
- Dag Wieers (@dagwieers)
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- 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
|
|
"""
|
|
|
|
RETURN = r"""
|
|
# Default return values
|
|
"""
|
|
import socket
|
|
import struct
|
|
import traceback
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def wakeonlan(module, mac, broadcast, port):
|
|
"""Send a magic Wake-on-LAN packet."""
|
|
|
|
mac_orig = mac
|
|
|
|
# Remove possible separator from MAC address
|
|
if len(mac) == 12 + 5:
|
|
mac = mac.replace(mac[2], "")
|
|
|
|
# If we don't end up with 12 hexadecimal characters, fail
|
|
if len(mac) != 12:
|
|
module.fail_json(msg=f"Incorrect MAC address length: {mac_orig}")
|
|
|
|
# Test if it converts to an integer, otherwise fail
|
|
try:
|
|
int(mac, 16)
|
|
except ValueError:
|
|
module.fail_json(msg=f"Incorrect MAC address format: {mac_orig}")
|
|
|
|
# Create payload for magic packet
|
|
data = b""
|
|
padding = f"FFFFFFFFFFFF{mac * 20}"
|
|
for i in range(0, len(padding), 2):
|
|
data = b"".join([data, struct.pack("B", int(padding[i : i + 2], 16))])
|
|
|
|
# Broadcast payload to network
|
|
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
|
|
|
|
if not module.check_mode:
|
|
try:
|
|
sock.sendto(data, (broadcast, port))
|
|
except socket.error as e:
|
|
sock.close()
|
|
module.fail_json(msg=f"{e}", exception=traceback.format_exc())
|
|
|
|
sock.close()
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
mac=dict(type="str", required=True),
|
|
broadcast=dict(type="str", default="255.255.255.255"),
|
|
port=dict(type="int", default=7),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
mac = module.params["mac"]
|
|
broadcast = module.params["broadcast"]
|
|
port = module.params["port"]
|
|
|
|
wakeonlan(module, mac, broadcast, port)
|
|
|
|
module.exit_json(changed=True)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|