From 70bfaef8b4d99d8ef74c5c2c0f93c81b392ebe37 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 4 Oct 2018 09:38:12 +0200 Subject: [PATCH] Update switch Wake on Lan configuration variable (#6489) * Update switch Wake on Lan configuration variable Update style of switch wake on lan documentation to follow new configuration variables description. Note: the numbered list, I assume that it should remain as the code is now? Related to #6385. * Update switch.wake_on_lan.markdown Added default for name * Adjustment to the name since the default is set * :pencil2: Corrects two types * :pencil2: Tweak --- .../_components/switch.wake_on_lan.markdown | 31 ++++++++++++++----- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 931befede70..3d77f533463 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -31,13 +31,30 @@ switch: mac_address: "00-01-02-03-04-05" ``` -Configuration variables: - -- **mac_address** (*Required*): MAC address to send the wake up command to. -- **name** (*Optional*): The name of the switch. Default is 'Wake on LAN'. -- **host** (*Optional*): The IP address or hostname to check the state of the device (on/off). -- **turn_off** (*Optional*): Defines an [action](/getting-started/automation/) to run when the switch is turned off. -- **broadcast_address** (*Optional*): The IP address of the host to send the magic packet to (default 255.255.255.255). +{% configuration %} +mac_address: + description: MAC address to send the wake up command to. + required: true + type: string +name: + description: The name of the switch. + required: false + default: Wake on LAN + type: string +host: + description: The IP address or hostname to check the state of the device (on/off). + required: false + type: string +turn_off: + description: Defines an [action](/getting-started/automation/) to run when the switch is turned off. + required: false + type: string +broadcast_address: + description: The IP address of the host to send the magic packet to. + required: false + default: 255.255.255.255 + type: string +{% endconfiguration %} ## {% linkable_title Examples %}