mark pod.py as running on python2
[pingofdeath.git] / README
1 Planetlab Ping-of-Death (POD)
2 -----------------------------
3 The Planetlab POD is a Linux kernel patch that creates the feature
4 of resetting and rebooting a computer when a particularily
5 formatted ICMP "ping" commmand is received.
6
7 A PlanetLab node's kernel gets a host, mask and hash value through
8 sysctl's that are performed on the node.  The node then looks
9 for an ICMP packet from a host matching the host/mask and, if the
10 packet payload is the hash value, the node forces an immediate
11 reboot.
12
13 From a controlling host's side, one invokes commands on the
14 remote node to set the host, mask and hash values and remembering
15 the hash value.  When the rebooting of a remote node is required,
16 the remembered hash value is looked up and sent to the node
17 in a specially constructed ICMP packet.
18
19 This POD system uses the same packet definition as EMULAB and uses
20 the some code from EMULAB to generate and transmit the packet.
21 No reason to invent something new.
22
23 Contolling host tools:
24 pod.py    Used to send both ICMP and UDP based POD packets. Requires
25           the hostname to send the packet do, and the configured
26           hash/key for the specified node.