ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[PR #9309/b57fef20 backport][stable-9] [vw]*: adjust docs (#9325)

Browse source 
[vw]*: adjust docs (#9309)

[vm]*: adjust docs

(cherry picked from commit b57fef201e)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-23 12:22:42 +01:00 • committed by GitHub
parent 3dd1c9d64a
commit 19b6f9ef3f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 353 additions and 507 deletions
Download patch file Download diff file Expand all files Collapse all files

27
plugins/modules/wakeonlan.py
View file

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: wakeonlan
short_description: Send a magic Wake-on-LAN (WoL) broadcast packet
description:
@ -25,17 +24,17 @@ attributes:
options:
mac:
description:
- MAC address to send Wake-on-LAN broadcast packet for.
- 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.
- 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.
- UDP port to use for magic Wake-on-LAN packet.
default: 7
type: int
todo:
@ -43,16 +42,16 @@ todo:
- 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)
- 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).
seealso:
- module: community.windows.win_wakeonlan
- module: community.windows.win_wakeonlan
author:
- Dag Wieers (@dagwieers)
'''
- Dag Wieers (@dagwieers)
"""
EXAMPLES = r'''
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'
@ -63,11 +62,11 @@ EXAMPLES = r'''
mac: 00:00:5E:00:53:66
port: 9
delegate_to: localhost
'''
"""
RETURN = r'''
RETURN = r"""
# Default return values
'''
"""
import socket
import struct
import traceback