= Basic Support Services =

= REVAMP THIS PAGE 6/22/2012 NP =

[[TOC(WiMAX/17*, depth=2, heading=WiMAX RF Aggregate Manager)]]

== /info - Configuration Info ==

Get the information about configuration parameters of the Base Station

{{{
<service name="bs/info">
  <info>Get information about the Base Station</info>
</service>
}}}

== bs/arq - ARQ parameters ==
{{{
<service name="bs/arq">
   <info>Set ARQ parameters</info>
      <args>
         <arg name="sltmo" isRequired="false">
            <info>Sync loss timeout [] (10000)</info>
         </arg>
         <arg name="dlvrorder" isRequired="false">
            <info>Delivery in order: true/false (true)</info>
         </arg>
         <arg name="wsize" isRequired="false">
            <info>ARQ window size [0..1024] (1024)</info>
         </arg>
         <arg name="rxpurgetmo" isRequired="false">
            <info>RX purge timeout [] (5000)</info>
         </arg>
         <arg name="rtmotx" isRequired="false">
            <info>TX retry timeout [] (1000)</info>
         </arg>
         <arg name="bloksize" isRequired="false">
            <info>ARQ block size [0..(ARQ windows size/2)] (256)</info>
         </arg>
         <arg name="rtmorx" isRequired="false">
            <info>RX retry timeout [] (1000)</info>
         </arg>
         <arg name="enable" isRequired="false">
            <info>Enable ARQ: true/false (false)</info>
         </arg>
         <arg name="ackproctime" isRequired="false">
            <info>ACK proc time [] (0)</info>
         </arg>
         <arg name="blockltm" isRequired="false">
            <info>ARQ block lifetime [] (5000)</info>
         </arg>
         <arg name="txackdelay" isRequired="false">
            <info>Tx ACK delay [] (100)</info>
         </arg>
      </args>
</service>
}}}

== bs/harq - HARQ parameters ==
{{{
<service name=bs/harq>
<info>
Set HARQ parameters</info>
<args>
<arg name=dldelay isRequired=false>
<info>
Frame offset of DL ACK delay wrt to DL Burst [1,2,3] (1)</info>
</arg>
<arg name=mimoul isRequired=false>
<info>
MIMO HARQ support: true/false (IGNORED - mimo support not available for this BS)</info>
</arg>
<arg name=pdusn isRequired=false>
<info>
PDU SN extended subheader reordering enabled: true/false (true)</info>
</arg>
<arg name=mret isRequired=false>
<info>
Maximum number of retransmissions [0..255] (4)</info>
</arg>
<arg name=burst isRequired=false>
<info>
Maximum number of HARQ bursts per frame [0..255] (17)</info>
</arg>
<arg name=enable isRequired=false>
<info>
Enable HARQ: true/false (false)</info>
</arg>
<arg name=uldelay isRequired=false>
<info>
Frame offset of UL ACK delay wrt to UL Burst [2,3] (3)</info>
</arg>
</args>
</service>
}}}

== /asngw - ASNGW parameters ==

{{{
<service name=bs/asngw>
<info>
Set ASNGW parameters</info>
<args>
<arg name=rettimeout isRequired=false>
<info>
Retransmission timeout for each control packet (2)</info>
</arg>
<arg name=retretry isRequired=false>
<info>
Number of control packet retransmissions (3)</info>
</arg>
</args>
</service>
}}}

== bs/config/list - Displays list of base station configuration profiles available in database ==
{{{
<service name="bs/config/list">
   <info>This service lists names of all BS configurations from database.</info>
</service>
}}}

== bs/config/show - Display contents of a base station configuration profile ==
{{{
<service name="bs/config/show">
   <info>Show named BS configuration from database.</info>
   <args>
      <arg name="name" isRequired="true">
         <info>Name of configuration.</info>
      </arg>
   </args>
</service>
}}}

== bs/config/save - Save current base station parameter values in a configuration profile ==
{{{
<service name="bs/config/save">
   <info>This service saves current BS configuration to database.</info>
   <args>
      <arg name="name" isRequired="true">
         <info>Name of configuration.</info>
      </arg>
   </args>
</service>
}}}

== bs/config/load - Load an available configuration profile ==
{{{
<service name="bs/config/load">
   <info>This service load BS configuration from database.</info>
   <args>
      <arg name="name" isRequired="true">
         <info>Name of configuration.</info>
      </arg>
   </args>
</service>
}}}

== bs/config/delete - Delete a base station configuration profile from database ==
{{{
<service name="bs/config/delete">
   <info>This service deletes BS configuration from database.</info>
   <args>
      <arg name="name" isRequired="true">
         <info>Name of configuration.</info>
      </arg>
   </args>
</service>
}}}

== bs/dlprofile - downlink modulation schemes ==
{{{
<service name=bs/dlprofile>
<info>
Set down link modulation scheme</info>
<args>
<arg name=dlprof8 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 5/6 (21))</info>
</arg>
<arg name=dlprof3 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (16-QAM (CTC) 1/2 (16))</info>
</arg>
<arg name=dlprof9 isRequired=false>
<info>
 DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))</info>
</arg>
<arg name=dlprof4 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (16-QAM (CTC) 3/4 (17))</info>
</arg>
<arg name=dlprof10 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))</info>
</arg>
<arg name=dlprof5 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 1/2 (18))</info>
</arg>
<arg name=dlprof11 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))</info>
</arg>
<arg name=dlprof6 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 2/3 (19))</info>
</arg>
<arg name=dlprof1 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (QPSK (CTC) 1/2 (13))</info>
</arg>
<arg name=dlprof12 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))</info>
</arg>
<arg name=dlprof7 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 3/4 (20))</info>
</arg>
<arg name=dlprof2 isRequired=false>
<info>
DL FEC code and modulation type of each burst profile on DCD message. (QPSK (CTC) 3/4 (15))</info>
</arg>
</args>
</service>
}}}

== bs/ulprofile - uplink modulation schemes ==
{{{
<service name=bs/ulprofile>
<info>
Set up link modulation scheme</info>
<args>
<arg name=ulprof6 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (No Modulation (255))</info>
</arg>
<arg name=ulprof1 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (QPSK (CTC) 1/2 (13))</info>
</arg>
<arg name=ulprof7 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (No Modulation (255))</info>
</arg>
<arg name=ulprof2 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (QPSK (CTC) 3/4 (15))</info>
</arg>
<arg name=ulprof8 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (No Modulation (255))</info>
</arg>
<arg name=ulprof3 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (16-QAM (CTC) 1/2 (16))</info>
</arg>
<arg name=ulprof9 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (No Modulation (255))</info>
</arg>
<arg name=ulprof4 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (16-QAM (CTC) 3/4 (17))</info>
</arg>
<arg name=ulprof10 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (No Modulation (255))</info>
</arg>
<arg name=ulprof5 isRequired=false>
<info>
UL FEC code and modulation type of each burst profile on UCD message. (No Modulation (255))</info>
</arg>
</args>
</service>
}}}

== /status - Get Current Status ==

{{{
<service name="bs/status">
  <info>Get status of WiMAX RF  service</info>
</service>
}}}

== /get - Get Basestation Parameter ==

{{{
<service name="bs/get">
<info>Get Basestation Static Parameter</info>
</service>
}}}

== /set - Set Basestation Parameter ==

{{{
<service name="bs/set">
  <info>Set Basestation Static Parameter</info>
</service>
}}}

== /restart - Restart the Base Station ==

{{{
<service name="bs/restart">
  <info>Restart the Base Station</info>
</service>
}}}


== /default - Reset to Default Parameters ==
###
{{{
<service name="defaults">
  <info>Restore Base Station parameters from default configuration</info>
</service>
}}}

== /restore - Restore Base Station Config ==
###
{{{
<service name="restore">
  <info>Restore Base Station parameters from saved configuration</info>
</service>
service name="uploadr"/>
}}}

== Example usage of services from sandbox ==
To reset base station's datapath configuration back to defaults:
{{{
$ wget -qO- http://cons-wm-01:5052/wimaxrf/datapath/clean
$ wget -qO- http://cons-wm-01:5052/wimaxrf/datapath/config/load?name=defaults
}}}

To view all clients loaded under current datapath configuration:
{{{
$ wget -qO- http://cons-wm-01:5052/wimaxrf/datapath/clients/status
}}}

To reset base station's configuration back to defaults:
{{{
$ wget -qO- http://cons-wm-01:5052/wimaxrf/bs/config/load?name=defaults
}}}

To restart base station:
{{{
$ wget -qO- http://cons-wm-01:5052/wimaxrf/bs/restart
}}}