High-level design for Wake-on-LAN feature in SONiC #1508

lizhijianrd · 2023-10-31T13:57:20Z

High-level design for Wake-on-LAN feature in SONiC.

Description	Repo	PR title	State
Add `wol` script in sonic-utilities	sonic-utilities	sonic-net/sonic-utilities#3048	Merged
Implement `SonicWolService` gNOI service	sonic-gnmi		Todo

venkatmahalingam · 2023-11-07T08:04:54Z

doc/wol/Wake-on-LAN-HLD.md

+
+The `wol` command is used to send magic packet to target device.
+
+This command requires root privilege because it'll modify the power-mode of target device.


SONiC device just need to send the magic packet to target device(s), right? not sure why we need root privilege at the SONiC device for command execution.

Yes, SONiC device just send the magic packet. As the doc mentioned, the magic packet will modify the power-mode of the target device, so it's considered as an OPERATION command and requires root.

Thanks for point this out, I think we can remove this root privilege requirement since SONiC only need to send a packet. I've update the doc.

venkatmahalingam · 2023-11-07T08:07:40Z

doc/wol/Wake-on-LAN-HLD.md

+admin@sonic:~$ wol Ethernet10 00:11:22:33:44:55
+admin@sonic:~$ wol Ethernet10 00:11:22:33:44:55 -b
+admin@sonic:~$ wol Vlan1000 00:11:22:33:44:55 -p 00:22:44:66:88:aa
+admin@sonic:~$ wol Vlan1000 00:11:22:33:44:55 -p 192.168.1.1 -c 3 -i 2000


Which module is building the Magic packet for SONiC CLI and gNOI interfaces?

Also, capture the validations e.g interface not present, down, socket errors..etc.

Thanks for your comments!

Added a Component section with some pictures to illustrate that.

Added CLI unit test plan to cover these validation.

prvattem · 2023-11-07T08:09:21Z

doc/wol/Wake-on-LAN-HLD.md

+### Example
+
+```
+admin@sonic:~$ wol Ethernet10 00:11:22:33:44:55


These commands need to be executed in root mode.
Please update the example accordingly.

Thanks for your comment! After consideration, we removed the root privilege requirement.

prvattem · 2023-11-07T08:18:05Z

doc/wol/Wake-on-LAN-HLD.md

+
+Below diagram describes a common usage of WoL on SONiC switch, this HLD will focus on the green part:
+
+![WoL Background](./wol-background.png)


Please expand SONIC Switch in the diagram and explain the components involved in generating the Magic Packet

Thanks, I added a Component section with some pictures to illustrate that.

zhangyanzhao · 2023-11-07T16:07:27Z

Community review recording https://zoom.us/rec/share/Cfvbr6CAmItpfgei_yhS1yJIYs5e2qL--G8Vf7rBUfzJg6sV09lt26Sv4ScxWio.B4ytA8vMPsMCxj7M

prvattem · 2023-11-07T16:24:10Z

doc/wol/Wake-on-LAN-HLD.md

+wol <interface> <target_mac> [-b] [-p password] [-c count] [-i interval]
+```
+
+- `interface`: SONiC interface name.


Are PortChannel intfs supported apart from Ethernet and Vlan?

Yes, PortChannel will be supported.

venkatmahalingam · 2023-11-07T16:32:49Z

doc/wol/Wake-on-LAN-HLD.md

+      20 | Target MAC (repeat 16 times, 96 bytes)  |           PAYLOAD
+         +-----------------------------------------+
+     116 |    Password (optional, 4 or 6 bytes)    |
+         +-----------------------------------------+


Wake on LAN - IP packet (UDP dest port -9) is not a requirement?

The wol utility will construct and send an Ethernet frame. It doesn't require the packet is an IP packet.

rathnasabapathyv · 2023-11-07T23:56:29Z

doc/wol/Wake-on-LAN-HLD.md

+| :- | :- |
+| Input a valid SONiC interface name. | Parameter validation pass, send magic packet |
+| Input an invalid SONiC interface name. | Parameter validation Fail |
+| Input a valid SONiC interface name, but the interface status is not `up`. | Return `Error: interface not up` |


As discussed in the community-meeting, this error can be thrown only when the input interface is ethernet-interface by validating the interface-status as UP.

If the input interface is VLAN, then actual host can be connected on any of the VLAN-member-ports and that actual target-device connected interface status can be down at that point. But since the VLAN-interface-status can be up, user will not see any error and user might think actual target device is woken up successfully, but in reality due to transient actual interface-status down/up flap, magic-pkt might not have reached target-host.

In this case, user initiating this cmd might not be aware they have to retry this cmd again to wake up the target-host again. May be, we can consider throwing warning, if any of the VLAN-member interface-status is down at the time of issuing this cmd and then it's upto the user to fix interface-status and reissue the cmd again.

It's better to explain, how this situation can be handled in HLD.

Hi @rathnasabapathyv, thanks for your question. After consideration, I think if users input VLAN as the interface, then the wol utility will only ensure the packet is delivered to target VLAN, but not guarantee to reach each physical interface. So,

Users should have some monitor mechanism to check if the target device is wake up as expected.

If users want to ensure the magic-packet be sent out from a physical interface, they should specify the physical interface name instead of vlan name as the wol CLI parameter.

skg-net · 2024-01-31T03:45:00Z

@lizhijianrd Can you please update the Quality Metric (Alpha/Beta/GA) for the feature either in this PR comments or in HLD itself based on https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20feature%20quality%20definition.md

lizhijianrd force-pushed the wake-on-lan-hld branch from fc76dfa to 73a9b3d Compare November 1, 2023 12:47

Add HLD for Wake-on-LAN feature

a3e2a86

lizhijianrd force-pushed the wake-on-lan-hld branch 2 times, most recently from 15c69a1 to c3ff044 Compare November 6, 2023 03:25

Fix comments

663f854

lizhijianrd force-pushed the wake-on-lan-hld branch from c3ff044 to 663f854 Compare November 6, 2023 09:50

venkatmahalingam reviewed Nov 7, 2023

View reviewed changes

prvattem reviewed Nov 7, 2023

View reviewed changes

Fix comments

be28f6e

lizhijianrd force-pushed the wake-on-lan-hld branch from 35c2b86 to be28f6e Compare November 7, 2023 14:35

prvattem reviewed Nov 7, 2023

View reviewed changes

venkatmahalingam reviewed Nov 7, 2023

View reviewed changes

rathnasabapathyv reviewed Nov 7, 2023

View reviewed changes

lizhijianrd force-pushed the wake-on-lan-hld branch from 8b1b68a to 0ddf495 Compare November 9, 2023 04:16

fix comments

d48a9de

lizhijianrd force-pushed the wake-on-lan-hld branch from 0ddf495 to d48a9de Compare November 9, 2023 07:38

Blueve approved these changes Nov 9, 2023

View reviewed changes

zhangyanzhao merged commit e2d910b into sonic-net:master Nov 9, 2023
1 check passed

lizhijianrd deleted the wake-on-lan-hld branch November 10, 2023 17:10

lizhijianrd mentioned this pull request Nov 22, 2023

[wol] Implement wol command line utility sonic-net/sonic-utilities#3048

Merged

zhangyanzhao mentioned this pull request Dec 5, 2023

Power over Ethernet (PoE) #1539

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

High-level design for Wake-on-LAN feature in SONiC #1508

High-level design for Wake-on-LAN feature in SONiC #1508

lizhijianrd commented Oct 31, 2023 •

edited

Loading

venkatmahalingam Nov 7, 2023

lizhijianrd Nov 7, 2023

lizhijianrd Nov 7, 2023

venkatmahalingam Nov 7, 2023

venkatmahalingam Nov 7, 2023

lizhijianrd Nov 7, 2023

prvattem Nov 7, 2023

lizhijianrd Nov 7, 2023

prvattem Nov 7, 2023

lizhijianrd Nov 7, 2023

zhangyanzhao commented Nov 7, 2023

prvattem Nov 7, 2023

lizhijianrd Nov 8, 2023

venkatmahalingam Nov 7, 2023 •

edited

Loading

lizhijianrd Nov 8, 2023

rathnasabapathyv Nov 7, 2023

lizhijianrd Nov 8, 2023

skg-net commented Jan 31, 2024


		The `wol` command is used to send magic packet to target device.

		This command requires root privilege because it'll modify the power-mode of target device.


		Below diagram describes a common usage of WoL on SONiC switch, this HLD will focus on the green part:

		![WoL Background](./wol-background.png)

High-level design for Wake-on-LAN feature in SONiC #1508

High-level design for Wake-on-LAN feature in SONiC #1508

Conversation

lizhijianrd commented Oct 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhangyanzhao commented Nov 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skg-net commented Jan 31, 2024

lizhijianrd commented Oct 31, 2023 •

edited

Loading

venkatmahalingam Nov 7, 2023 •

edited

Loading