close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 7 and Version 8 of Old/WiMAX/16


Ignore:
Timestamp:
Dec 9, 2010, 7:21:44 PM (10 years ago)
Author:
hmussman
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Old/WiMAX/16

    v7 v8  
    6565-       Returns XML with appropriate parameters on success, “nok” otherwise.
    6666
     67= Slice Manager API Specification (User Exposed) =
    6768
     69The slice manager API are further classified into
     70  1. VM control functions and
     71  2. Client control functions.
     72
     73== SLICE (VM) Control Functions ==
     74
     75These set of functions are responsible for managing context isolation of multiple slices through the use of virtual machines.
     76
     77=== createSLICE ===
     78This function is invoked from a gateway machine by the slice user to instantiate its slice for experimentation.
     79
     80{{{
     81createSLICE(used_id, passwd, image_type)
     82  - user_id is username used in slice creation.
     83  - passwd is password used for slice creation.
     84  - image_type is an integer which specifies the distribution to be loaded on the disk of the virtual machine.
     85          image_type = 1 loads a Debian disk image
     86          image_type = 2 loads a Ubuntu disk image
     87          image_type = 3 loads a Fedora disk image
     88  - Return the IP of the SLICE to which the user can log into (when successful)
     89  - Failure returns “nok”, success returns SLICEID.
     90}}}
     91
     92=== destroySLICE  ===
     93This 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.
     94
     95{{{
     96destroySLICE(user_id, passwd, IP)
     97  - user_id is username used in slice creation.
     98  - passwd is password used for slice creation.
     99  - Returns status “ok” if command was executed correctly, “nok” otherwise.
     100}}}
     101
     102=== startSLICE ===
     103This 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. .
     104
     105{{{
     106startSLICE ( SLICEID, user_id, passwd, IP)
     107-       Returns status “ok” if command was executed correctly, “nok” otherwise.
     108}}}
     109
     110=== stopSLICE ===
     111This 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).
     112{{{
     113stopSLICE ( SLICEID, user_id, passwd, IP)
     114-       Returns status “ok” if command was executed correctly, “nok” otherwise.
     115}}}
     116
     117=== setSLICEParams ===
     118Allows 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).
     119{{{
     120setSLICEParams (SLICEID, used_id, passwd, tlv) 
     121-       Successful setting returns “ok”, “nok” otherwise.
     122}}}
     123
     124== Client Control Functions ==
     125
     126These 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.
     127
     128=== addClient ===
     129This function is called by the user to add a client with MAC address MSID to the slice SliceID.
     130{{{
     131addClient (MSID, SliceID)
     132-       Successful execution of this function returns “ok” from the grid service, “no” otherwise
     133}}}
     134
     135=== deleteClient ===
     136Used to remove client with MAC address MSID  from the slice with identifier as Slice ID.
     137{{{
     138deleteClient (MSID, SliceID)
     139-       Successful execution of this function returns “ok” from the grid service, “no” otherwise
     140}}}