Changes between Version 10 and Version 11 of Old/WiMAX/16

Timestamp:

Dec 9, 2010, 7:31:11 PM (13 years ago)

Author:

hmussman

Comment:

—

Old/WiMAX/16

@@ -1 @@
-[[TOC(Internal/WiMAX/WiMAXAPI*, depth=2)]]
+[[PageOutline]]
 
 = A.  APIs =
 
-== A.1  API Classification and Usage ==
+== A.1  API Classification  ==
 
 
 The APIs are primarily classified as:
   * User exposed
-    * [wiki:WiMAX/16/3 Slice management service]
-    * [wiki:WiMAX/16/4 Radio management service]
+    * [wiki:WiMAX/55 Slice management service]
+    * [wiki:WiMAX/57 Radio management service]
 
   * Internal
-   * [wiki:WiMAX/16/1 System Administration API]
-   * [wiki:WiMAX/16/5 SM-Datapath API]
+   * [wiki:WiMAX/50 System Administration API]
+   * [wiki:WiMAX/59 SM-Datapath API]
    * [wiki:WiMAX/WiMAXAPI/05RMDpApi RM-Datapath API]
    * [wiki:WiMAX/WiMAXAPI/06BSFBDpApi BSFB-Datapath API]
@@ -25 +25 @@
   * setters – responsible for setting the specified control information. 
 
-=== A.1.1 Sample Experiment Setup Using API ===
+== A.2  API Usage  ==
+
+=== A.2.1 Sample Experiment Setup Using API ===
 
 A sample usage of the API for experiment setup is as shown in the Figure below.
@@ -38 +40 @@
 The addclient() API has an optional service class parameter that the user can specify. If the user does not specify the service class id, a default service class is allocated that has a single best effort type of service flow. After this sequence is complete, the user can direct traffic to the local virtual interface in the VM with the appropriate MAC address, and traffic will be automatically sent to the correct wireless client.
 
-=== A.1.2 Sample Experiment: Custom Service Class Control ===
+=== A.2.2 Sample Experiment: Custom Service Class Control ===
 To demonstrate how the user could possibly create custom service classes we show an 
 example of how system components will interact in the Figure below.
@@ -48 +50 @@
 
 
-== A.2 System Administrator API Specification (Internal) ==
+== A.3 System Administrator API Specification (Internal) ==
 These set of functions are exposed to the system administrator for managing and monitoring slice quotas from a virtualization perspective. More administrative functionality is provided on the RF side as discussed in the BS-RF API.
 
-=== A.2.1 VM Administration ===
-
-=== setSliceParams(SLICEID, disk_quota, cpu) ===
+=== A.3.1 VM Administration ===
+
+==== setSliceParams(SLICEID, disk_quota, cpu) ====
 -       This function is provided to the administrator for setting up slice level parameters such as total disk / cpu quota assigned to a slice. 
 -       Successful setting of these parameters returns “ok”
-=== getSliceParams(SLICEID) === 
+
+==== getSliceParams(SLICEID) ==== 
 -       This function is provided to the administrator for getting slice level parameters such as total disk/CPU quota assigned to a slice.  
 -       Online information such as current usage is also be made available.
 -       Returns XML with appropriate parameters on success, “nok” otherwise.
-== getTotalParams(SLICEID) ===
+
+==== getTotalParams(SLICEID) ====
 -       This function is provided to the administrator for getting information on total available resources, such as disk space/ cpu quota available for allocation.
 -       This function is typically used by the administrator before the use of  setSliceParams() function.
 -       Returns XML with appropriate parameters on success, “nok” otherwise.
 
-= Slice Manager API Specification (User Exposed) =
+== A.4 Slice Manager API Specification (User Exposed) ==
 
 The slice manager API are further classified into 
@@ -71 +75 @@
   2. Client control functions.
 
-== SLICE (VM) Control Functions ==
+=== A.4.1 SLICE (VM) Control Functions ===
 
 These set of functions are responsible for managing context isolation of multiple slices through the use of virtual machines.
 
-=== createSLICE ===
+==== createSLICE ====
 This function is invoked from a gateway machine by the slice user to instantiate its slice for experimentation.
 
@@ -90 +94 @@
 }}}
 
-=== destroySLICE  ===
+==== 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.
 
@@ -100 +104 @@
 }}}
 
-=== startSLICE ===
+==== startSLICE ====
 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. .
 
@@ -108 +112 @@
 }}}
 
-=== stopSLICE ===
+==== 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).
 {{{
@@ -115 +119 @@
 }}}
 
-=== setSLICEParams ===
+==== 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).
 {{{
@@ -122 +126 @@
 }}}
 
-== Client Control Functions ==
+=== A.4.2 Client Control Functions ===
 
 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 ===
+==== addClient ====
 This function is called by the user to add a client with MAC address MSID to the slice SliceID. 
 {{{
@@ -133 +137 @@
 }}}
 
-=== deleteClient ===
+==== deleteClient ====
 Used to remove client with MAC address MSID  from the slice with identifier as Slice ID.
 {{{
@@ -141 +145 @@
 
 
-= Radio Management API (User Exposed) =
+== A.5 Radio Management API (User Exposed) ==
 
 These API define the calls that can be made by the system user for controlling radio-related features of the WiMAX system. These API are further classified based on the functionality they provide.
-== Custom Service Class Suport ==
+
+=== A.5.1 Custom Service Class Support ===
 These APIs will allow the user to create user-defined service flow types apart from the 5 standard service flows supported as a part of the current model.
-=== createServiceFlow(SlideID, direction, priority, classifier-ips, classifier-ports, service_type, service_params) ===
+==== createServiceFlow(SlideID, direction, priority, classifier-ips, classifier-ports, service_type, service_params) ====
 -       Direction – Uplink or downlink for the class.
 -       Priority – priority of the service class 
@@ -156 +161 @@
 -       Note that the service type is created by the Radio management grid service for 
         a specific slice ID and hence it will be specific to that slice.
-=== createServiceClass(SlideID,STIDs{}) ===
+==== createServiceClass(SlideID,STIDs{}) ====
 -       SliceID identifies the requesting slice.
 -       STIDs are the service type ids. 
 -       Success returns the Service class ID (SCID), which can be used in install or remove.
-=== installServiceClass(SlideID,SCID) ===
+==== installServiceClass(SlideID,SCID) ====
 -       SliceID identifies the requesting slice.
 -       Installs all the service flows that are part of the service class SCID.
 -       Success results in end – to – end datapath setup between wireless clients and virtual machine slice.
-=== uninstallServiceClass(SlideID,SCID) ===
+==== uninstallServiceClass(SlideID,SCID) ====
 -       SliceID identifies the requesting slice.
 -       Un-installs all the service flows that are part of the service class SCID.
 -       Success returns ok and nok otherwise.
 
-=== deleteServiceClass(SlideID, SCID) ===
+==== deleteServiceClass(SlideID, SCID) ====
 -       Deletes the service class corresponding to the specification in the request.
 -       Returns success if the service class could be successfully deleted (none of the 
 flows are actively using these service classifiers).
 
-=== deleteServiceFlow(SlideID, STID) ===
+==== deleteServiceFlow(SlideID, STID) ====
 -       Results in deletion of service flow type identified by STID if any such flow type exists.
 -       Success results in “ok” and “nok” otherwise.
 
 
-== Slice Radio Control ==
-
-=== setMinimalMcs(SliceID, MSID, SCID, mcs) ===
+=== A.5.2 Slice Radio Control ===
+
+==== setMinimalMcs(SliceID, MSID, SCID, mcs) ====
 -       Used to set the minimal modulation and coding scheme (MCS) to be used for 
 that service class. An auto rate provision will select a better MCS based on the 
@@ -189 +194 @@
 current understanding, this is difficult.
 
-=== setFixedMcs(SliceID, MSID, SCID, mcs) ===
+==== setFixedMcs(SliceID, MSID, SCID, mcs) ====
 -       Used to set a fixed MCS for a particular service class.
 -       This disables the automatic MCS adjustment using measured CINR.
 -       If possible we wish to set this mcs value per MSID.
 
-=== setRadioResource(SliceID, MSID,  RR) ===
+==== setRadioResource(SliceID, MSID,  RR) ====
 -       Information provided by this function should be consulted during initial ranging and connection setup.
 -       RR  – Radio resource uplink + downlink (set in % - 0 to 100)
 
-=== setBandwithUlDlRatio(bandwidth UL_DL_ratio) ===
+==== setBandwithUlDlRatio(bandwidth UL_DL_ratio) ====
 -       Set supported bandwidth: 10M, 7.5M, 5M Hz 
 -   Based on  RR allocation in set_radio_resource(), this routine allows the user to set 
@@ -204 +209 @@
 -       UL_DL_ratio is used as a key to select one among standard UL_DL ratio supported by the BS. All MS has to use the same ul_dl_ratio
 
-== Slice Radio Monitoring ==
-
-=== getAllClientsInfo( SLICEID ) ===
+=== A.5.3 Slice Radio Monitoring ===
+
+==== getAllClientsInfo( SLICEID ) ====
 -       Returns the number of WiMAX clients associated with a particular SLICEID.
 -       Return value ranges between 0 and maximum number of clients that can be owned by a slice on success, “nok” otherwise
 
-=== getClientInfo(SLICE ID, MSID) ===
+==== getClientInfo(SLICE ID, MSID) ====
 -       Returns detailed information about a single client in the network.
 -       Information for individual MAC address includes the amount of disk quota, disk space used, and the CPU quota (reserved and used).
 -       Returns XML with appropriate parameters on success, “nok” otherwise
 
-=== getSliceResource(SLICEID) ===
+==== getSliceResource(SLICEID) ====
 -       This mechanism allows every slice to monitor its current usage,  and the limits
 -       Values returned may vary based on the virtualization technology used - (disk space, CPU).
@@ -221 +226 @@
 
 
-= SM – Datapath API (Internal) =
+==  A.6 SM – Datapath API (Internal) ==
 
 These set of API are responsible for dealing with the datapath creation after slice initialization and client registration.
-=== addClient(VLAN, MSID) ===
+==== addClient(VLAN, MSID) ====
 -       This function is invoked by the slice manager after the user requests it to add a client to the slice.
 -       The slice manager looks up the appropriate VLAN tag number and requests that the MAC MSID  of the mobile client be added to the VLAN.
 -       This API facilitates half of the datapath creation, which will be completed when the MSID associates with the system.
 
-=== removeClient(VLAN, MSID) ===
+==== removeClient(VLAN, MSID) ====
 -       Compliments  the addClient() function.
 -       On the execution of this call the datapath manager removes the mapping from the slice virtual machine to the wireless mobile client.