Table of Contents
- API Classification and Usage
- Sample Experiment Setup Using API
- Sample Experiment: Custom Service Class Control
- Accessing the WiMAX Base Station
- Input Command
- Expected Output
- Input Command
- Expected Output
- Input Command
- Expected Output
- Input Command
- Expected Output
- Sample Experiment Script
- Slice Manager API Specification (User Exposed)
- SLICE (VM) Control Functions
- createSLICE
- destroySLICE
- startSLICE
- stopSLICE
- setSLICEParams
- Client Control Functions
- addClient
- deleteClient
- Radio Management API (User Exposed)
- Custom Service Class Suport
- createServiceFlow(SlideID, direction, priority, classifier-ips, …
- createServiceClass(SlideID,STIDs{})
- installServiceClass(SlideID,SCID)
- uninstallServiceClass(SlideID,SCID)
- deleteServiceClass(SlideID, SCID)
- deleteServiceFlow(SlideID, STID)
- Slice Radio Control
- setMinimalMcs(SliceID, MSID, SCID, mcs)
- setFixedMcs(SliceID, MSID, SCID, mcs)
- setRadioResource(SliceID, MSID, RR)
- setBandwithUlDlRatio(bandwidth UL_DL_ratio)
- Slice Radio Monitoring
- getAllClientsInfo( SLICEID )
- getClientInfo(SLICE ID, MSID)
- getSliceResource(SLICEID)
- System Administrator API Specification (Internal)
- VM Administration
- setSliceParams(SLICEID, disk_quota, cpu)
- getSliceParams(SLICEID)
- getTotalParams(SLICEID) =
- SM – Datapath API (Internal)
- addClient(VLAN, MSID)
- removeClient(VLAN, MSID)
- RM – Datapath API (Internal)
- addServiceFlow(MSID, Service class tlv)
- removeServiceFlow(MSID, Service class tlv)
- BSFB – Datapath API (Internal)
- Network Entry Control API Specification
- appendMACAcl
- removeMACAcl
- acceptMAC
- rejectMAC
- clientRegistration
- clientDeregistration
- Radio Level Monitoring
- getAvailableResources
- getMCS
- getThroughput
- getPacketLoss
RM – Datapath API (Internal)
These set of API are internal and used for controlling the datapath from the virtual machines (virtual basestation instances) to the wireless clients.
addServiceFlow(MSID, Service class tlv)
- Currently not supported with only pre-provisioned service classes supported by the BTS.
removeServiceFlow(MSID, Service class tlv)
- This service does not require a physical disconnection but can be based purely on disconnection of the end – to – end datapath from the Slice vlan to the gre representing that service flow.