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

Timestamp:

Feb 18, 2010, 2:12:48 AM (14 years ago)

Author:

seskar

Comment:

—

Internal/WiMAX/WiMAXAPI/aSliceMgmt

@@ +1 @@
+Go back --> [wiki:Internal/WiMAX/WiMAXAPI/ GENI WiMAX API]
+
 = Slice Manager API Specification (User Exposed) =
 
@@ -39 +41 @@
 
 === startSLICE ===
-This function is used to start the slice; can be invoked only after the the createSLICE() call is made.
+This function is used to start the slice for which IP is assigned; can be invoked only after the the createSLICE() call is made and is successful only if the instance is owned by the issuing user. .
 
 {{{
 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 ===
-
+This function is used to stop the instance of the SLICE for which IP is assigned (SLICE instance is stopped only if the instance is owned by the issuing user).
 {{{
 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) ===
--       Allows the user to set all controllable parameters for creation of SLICE.
--       Features include the amount of disk space per SLICE template, percentage of CPU resources.
--       Number of parameters supported as a part of this API may vary with underlying virtualization technology.
+=== setSLICEParams ===
+Allows the user to set all controllable parameters for creation of SLICE. Features include the amount of disk space per SLICE template, percentage of CPU resources (number of parameters supported as a part of this API may vary with underlying virtualization technology).
+{{{
+setSLICEParams (SLICEID, used_id, passwd, tlv)  
 -       Successful setting returns “ok”, “nok” otherwise.
-
+}}}
 
 == Client Control Functions ==
@@ -68 +66 @@
 These set of functions allow the datapath controller to determine which WiMAX clients can associate with the BTS and vice-versa. These API are internal and are based on the input provided by the slice user.
 
-=== addClient (MSID, SliceID) ===
--       This API is called by the user to add a client with MAC address MSID to the slice SliceID.      
+=== addClient ===
+This function is called by the user to add a client with MAC address MSID to the slice SliceID. 
+{{{
+addClient (MSID, SliceID) 
 -       Successful execution of this function returns “ok” from the grid service, “no” otherwise
-=== deleteClient (MSID, SliceID)===
--       Used to remove client with MAC address MSID  from the slice with identifier as Slice ID.
+}}}
+
+=== deleteClient ===
+Used to remove client with MAC address MSID  from the slice with identifier as Slice ID.
+{{{
+deleteClient (MSID, SliceID)
 -       Successful execution of this function returns “ok” from the grid service, “no” otherwise
+}}}