Changes between Version 1 and Version 2 of Documentation/OMFCommandReference

Timestamp:

Jul 24, 2019, 3:25:12 PM (6 years ago)

Author:

jkol

Comment:

—

Documentation/OMFCommandReference

@@ -21 +21 @@
 
 Examples:
+
   Return usage/help for the 'exec' command.
     {{{omf exec -h}}}
@@ -43 +44 @@
 
 Examples:
-  {{{omf stat -t all}}}
-
-  {{{omf stat -t node1-1.grid.orbit-lab.org}}}
-
-  {{{omf stat -t [1..2,1..2]}}}
-
-  {{{omf stat -t system:topo:all -c grid}}}
+
+  Get the status of all nodes in the testbed.
+    {{{omf stat -t all}}}
+
+  Get the status of a node.
+    {{{omf stat -t node1-1.grid.orbit-lab.org}}}
+
+  Get the status of a range of nodes.
+    {{{omf stat -t [1..2,1..2]}}}
+
+  Get the status of a topology.
+    {{{omf stat -t system:topo:all -c grid}}}
 
 === omf tell
@@ -71 +77 @@
 
 Examples:
-  {{{omf tell -a reset -t node1-1.grid.orbit-lab.org}}}
-
-  {{{omf tell -a on -t system:topo:all -c grid}}}
-
-  {{{omf tell -a reboot -t node1-1}}}
-
-  {{{omf tell -a offh -t [1..2,1..5]}}}
-
-  {{{omf tell -a offh -t system:topo:all}}}
-
-  {{{omf tell -a reset -t system:topo:imaged}}}
+
+  Reset (soft) a node.
+    {{{omf tell -a reset -t node1-1.grid.orbit-lab.org}}}
+
+  Reboot (hard) a node.
+    {{{omf tell -a reboot -t node1-1}}}
+
+  Turn off (hard) all nodes in a range.
+    {{{omf tell -a offh -t [1..2,1..5]}}}
+
+  Turn off (hard) all nodes in a topology.
+    {{{omf tell -a offh -t system:topo:all}}}
+
+  Reset (soft) all nodes in a topology.
+    {{{omf tell -a reset -t system:topo:imaged}}}
 
 === omf load
@@ -110 +120 @@
 
 Examples:
-  {{{omf load -t all}}}
-
-  {{{omf load -t system:topo:all -i baseline-2.4.ndz}}}
-
-  {{{omf load -t node1-1 -i wireless-2.6.ndz}}}
-
-  {{{omf load -t [1..10,1..5] -i baseline.ndz -o 400}}}
-
-  {{{omf load -t system:topo:circle -i my_Own_Image.ndz}}}
-
-  {{{omf load -t my_Own_Topology -i baseline-2.2.ndz -t 600 -c grid}}}
-
-  {{{omf load -t my_Own_Topology --outpath ./ --outprefix my_Own_Prefix}}}
+
+  Load the default baseline image (baseline.ndz) on all nodes in the testbed.
+    {{{omf load -t all}}}
+
+  Load a image on all nodes in a topology.
+    {{{omf load -t system:topo:all -i baseline-2.4.ndz}}}
+
+  Load an image onto a node.
+    {{{omf load -t node1-1 -i wireless-2.6.ndz}}}
+
+  Load an image onto a range of nodes with a timeout of 400 seconds.
+    {{{omf load -t [1..10,1..5] -i baseline.ndz -o 400}}}
+
+  Load an image onto all nodes in a topology.
+    {{{omf load -t system:topo:circle -i my_Own_Image.ndz}}}
+
+  Load an image onto all nodes in a topology.
+    {{{omf load -t my_Own_Topology -i baseline-2.2.ndz -t 600 -c grid}}}
+
+  ...
+    {{{omf load -t my_Own_Topology --outpath ./ --outprefix my_Own_Prefix}}}
 
 
@@ -141 +159 @@
 }}}
 
-Examples:
-  {{{omf save -n node5-3.grid.orbit-lab.org}}}
-
-  {{{omf save -n node1-1.sb2.orbit-lab.org}}}
+NODE must be specified in FQDN (fully qualified domain name) format (eg. node1-1.sb1.orbit-lab.org).
+
+Examples:
+
+  Save the disk image from a node.
+    {{{omf save -n node5-3.grid.orbit-lab.org}}}
+
+    {{{omf save -n node1-1.sb2.orbit-lab.org}}}
 
 === omf exec