Changes between Version 2 and Version 3 of Internal/WiMAX/WiMAXAPI/aSliceMgmt

Timestamp:

Feb 17, 2010, 4:56:56 AM (15 years ago)

Author:

seskar

Comment:

—

Internal/WiMAX/WiMAXAPI/aSliceMgmt

@@ -13 +13 @@
 These set of functions are responsible for managing context isolation of multiple slices through the use of virtual machines.
 
-=== createSLICE (used_id, passwd, image_type) ===
+=== createSLICE ===
 This function is invoked from a gateway machine by the slice user to instantiate its slice for experimentation.
--       Uses the slice user_id and passwd to create a new SLICE.
--       image_type is an integer which specifies the distribution to be loaded on the disk of the virtual machine.
-        image_type = 1 loads a Debian disk image
-        image_type = 2 loads a Ubuntu disk image
-        image_type = 3 loads a Fedora disk image
-        - Return the IP of the SLICE to which the user can log into (when successful)
-        - Failure returns “nok”, success returns SLICEID.
 
-=== destroySLICE (user_id, passwd, IP) ===
--       Destroy instance of the SLICE for which IP is assigned
--       SLICE is destroyed only after authentication of  the used_id and passwd.
--       Returns status “ok” if command was executed correctly, “nok” otherwise.
+{{{
+createSLICE(used_id, passwd, image_type)
+  - user_id is username used in slice creation.
+  - passwd is password used for slice creation.
+  - image_type is an integer which specifies the distribution to be loaded on the disk of the virtual machine.
+          image_type = 1 loads a Debian disk image
+          image_type = 2 loads a Ubuntu disk image
+          image_type = 3 loads a Fedora disk image
+  - Return the IP of the SLICE to which the user can log into (when successful)
+  - Failure returns “nok”, success returns SLICEID.
+}}}
 
-=== startSLICE ( SLICEID, user_id, passwd, IP) ===
-This functionality can be invoked after the the createSLICE() call is made.
+=== destroySLICE  ===
+This function is used to destroy instance of the SLICE for which IP is assigned; slice is destroyed only after authentication of  the used_id and passwd.
+
+{{{
+destroySLICE(user_id, passwd, IP)
+  - user_id is username used in slice creation.
+  - passwd is password used for slice creation.
+  - Returns status “ok” if command was executed correctly, “nok” otherwise.
+}}}
+
+=== startSLICE ===
+This function is used to start the slice; can be invoked only after the the createSLICE() call is made.
+
+{{{
+startSLICE ( SLICEID, user_id, passwd, IP)
 -       Start instance of the SLICE for which IP is assigned
 -       SLICE instance is started only if the instance is owned by the issuing user.
 -       Returns status “ok” if command was executed correctly, “nok” otherwise.
+}}}
 
-=== stopSLICE ( SLICEID, user_id, passwd, IP) ===
+=== stopSLICE ===
+
+{{{
+stopSLICE ( SLICEID, user_id, passwd, IP)
 -       Stop instance of the SLICE for which IP is assigned
 -       SLICE instance is stopped only if the instance is owned by the issuing user.
 -       Returns status “ok” if command was executed correctly, “nok” otherwise.
+}}}
 
 === setSLICEParams (SLICEID, used_id, passwd) ===