= Basic Support Services =
[[TOC(WiMAX/17*, depth=2, heading=WiMAX RF Aggregate Manager)]]
== /info - Configuration Info ==
Get the information about configuration parameters of the Base Station
{{{
Get information about the Base Station
}}}
== bs/asngw - ASNGW parameters ==
{{{
Set ASNGW parameters
Retransmission timeout for each control packet (2)
Number of control packet retransmissions (3)
}}}
== bs/config/list - Displays list of base station configuration profiles available in database ==
{{{
This service lists names of all BS configurations from database.
}}}
== bs/config/show - Display contents of a base station configuration profile ==
{{{
Show named BS configuration from database.
Name of configuration.
}}}
== bs/config/save - Save current base station parameter values in a configuration profile ==
{{{
This service saves current BS configuration to database.
Name of configuration.
}}}
== bs/config/load - Load an available configuration profile ==
{{{
This service load BS configuration from database.
Name of configuration.
}}}
== bs/config/delete - Delete a base station configuration profile from database ==
{{{
This service deletes BS configuration from database.
Name of configuration.
}}}
== bs/dlprofile - downlink modulation schemes ==
{{{
Set down link modulation scheme
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 5/6 (21))
DL FEC code and modulation type of each burst profile on DCD message. (16-QAM (CTC) 1/2 (16))
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))
DL FEC code and modulation type of each burst profile on DCD message. (16-QAM (CTC) 3/4 (17))
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 1/2 (18))
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 2/3 (19))
DL FEC code and modulation type of each burst profile on DCD message. (QPSK (CTC) 1/2 (13))
DL FEC code and modulation type of each burst profile on DCD message. (No Modulation (255))
DL FEC code and modulation type of each burst profile on DCD message. (64-QAM (CTC) 3/4 (20))
DL FEC code and modulation type of each burst profile on DCD message. (QPSK (CTC) 3/4 (15))
}}}
== bs/mcsProfile - get/set downlink / uplink profile ==
{{{
Set/Get Modulation-coding scheme.
Array of Up link profile specification.
Array of Dl link profile specification.
}}}
== bs/driver - Driver base parameters ==
{{{
Set DRIVER BASE parameters
Block admin on/off (0)
Enable packing mode (0)
Carrier admin on/off (1)
Maxnumber of service flow (600)
Enable crc mode (1)
Fragmenting on/off (0)
Max number of clients (96)
}}}
== bs/maintenance - Maintenance parameters ==
{{{
Set MAINTENANCE parameters
Define event log level. (5)
@@@Text for temp_high@@@ (70)
Low threshold for generating the RSSI alarm (-440)
@@@Text for temp_high_restore@@@ (62)
High threshold for generating the RSSI alarm (-200)
Base Station ID (0x00000000)
@@@Text for temp_low@@@ (-5)
Alarm reset mode (0x01)
@@@Text for temp_low_restore@@@ (0)
}}}
== bs/mimo - MIMO parameters ==
{{{
Set MIMO parameters
@@@Text for mimo_ul@@@ (0)
MIMO on/off (0)
Preferred MIMO matrix - Matrix A. (0)
}}}
== bs/mobile - mobile parameters ==
{{{
Set MOBILE parameters
Trig-condition trigger value [0.255] (2)
@@@Text for scan_iteration@@@ (0)
@@@Text for fa_index@@@ (0)
@@@Text for dlcinr_mean_threshold@@@ (12)
Reporting period for scanning results (units: frames) [1..255] (100)
Support for fast ranging. (0)
@@@Text for trigger_averaging_duration_scn_rep@@@ (128)
Duration for retaining resource information af MS handover. (Units: ms) [0..65335] (0x000A)
Time duration margin for transmission timing in MOB_PAG-ADV. (Units: frames) [0.255] (2)
Support handover/idle mode (1)
DUration time for avergaing metric. (Units: frames) [0.255] (128)
@@@Text for trigger_value_scn_req@@@ (175)
Interval of MOB_NBR-ADV messages. [0..30] (10)
@@@Text for power_saving_class_capability@@@ (1)
Report metric for scanning results. (0x03)
@@@Text for action_time_tbs@@@ (2)
@@@Text for trigger_type_scn_rep@@@ (0)
@@@Text for system_resource_retain_time@@@ (300)
Flag to retain or release resource information of MS after handover. (1)
Time duration for paging interal of BS. (Units: frames) (2)
@@@Text for trigger_averaging_duration_scn_req@@@ (128)
Max number of retransmission MOB_PAG-ADV message. (3)
@@@Text for trf_ind_required@@@ (1)
@@@Text for ho_type_support@@@ (1)
@@@Text for t55@@@ (200)
@@@Text for trigger_function_scn_rep@@@ (3)
@@@Text for target_bs_selection@@@ (0)
Timer until MS decides to retransmit MOB_MSHO-REQ. (Units: frames) [0..255] (100)
Triggering metric type for SCN-REQ & SCN-REP. (0x00)
@@@Text for trigger_type_scn_req@@@ (1)
Time to maintain connection information after BS transmits DREG-CMD. (Units: 100ms) [0..65535] (5)
@@@Text for traffic_triggered_wakening_flag@@@ (0)
Support for association type. (0x01)
@@@Text for scan_duration@@@ (0)
Expiration time for initiation of MS Idle mode in DREG-REQ (Units: frames) [0..255] (10)
@@@Text for recommended_neighbor_bsid@@@ (0x000000000000)
@@@Text for mob_nbr_adv_fragment_size@@@ (50)
Triggering function type for SCN-REQ & SCN-REP (0x03)
@@@Text for trigger_function_scn_req@@@ (6)
Max number of retransmissions in DREQ-CMD. (3)
@@@Text for trf_ind_switch@@@ (1)
@@@Text for ho_mode@@@ (0)
@@@Text for interleaving_interval@@@ (0)
Support for CID update. (0)
@@@Text for dlcinr_threshold_cqich@@@ (0)
Report mode for scanning results. (0)
Support for unsolicitated UL grant or HO-IND (1)
@@@Text for trigger_value_scn_rep@@@ (2)
@@@Text for t46@@@ (250)
@@@Text for communication_monitor_timer@@@ (300)
}}}
== bs/monitor - Monitor ==
{{{
Set MONITOR parameters
Maximum monitoring data size. (0x0080)
Monitoring data type for local file monitoring (0x00)
Management message type to filter (0x43)
}}}
== bs/mpc - MPC parameters ==
{{{
Set MEASUREMENT & POWER CONTROL parameters
@@@Text for dl_cn_list_a@@@ (0x08090A0E0F1417191B1C)
@@@Text for rssi_ave_rep@@@ (0x03)
@@@Text for dl_cn_list_b.7@@@ (25 (64QAM 2/3))
@@@Text for mng_ulburst_pwr_offset@@@ (0)
@@@Text for dl_cn_list.5@@@ (22 (16QAM 3/4))
@@@Text for report_func_select@@@ (1)
@@@Text for dl_cn_list_b.2@@@ (10 (QPSK 1/2))
@@@Text for cinr_correct@@@ (0)
@@@Text for dl_cn_list.0@@@ (8 (QPSK 1/2 x4))
@@@Text for cinr_reuse_factor@@@ (0)
@@@Text for subch_threshold.1@@@ (87 (threshold of class2 after Enty))
@@@Text for dl_cn_list_a.8@@@ (27 (64QAM 3/4))
@@@Text for pdu_sn_wait_time@@@ (10)
Time interval between N+I extended IE. (Units: frames) [0..255] (10)
@@@Text for subch_limit.1@@@ (8 (limit value of class1 after Enty))
@@@Text for dl_cn_list_a.3@@@ (14 (QPSK 3/4))
@@@Text for rate_down_count@@@ (3)
@@@Text for hr_power_mergin@@@ (-24)
@@@Text for dl_cn_list.9@@@ (28 (64QAM 5/6))
@@@Text for pathloss_correct@@@ (0)
@@@Text for dl_cn_list_b.6@@@ (23 (64QAM 1/2))
@@@Text for dl_cn_list.4@@@ (18 (16QAM 1/2))
@@@Text for MIMO_feedback_cycle@@@ (0)
@@@Text for dl_cn_list_b.1@@@ (9 (QPSK 1/2 x2))
@@@Text for rssi_correct@@@ (62)
@@@Text for dl_cn_list@@@ (0x08090A0E121617191B1C)
@@@Text for cinr_measure_priority@@@ (0x0104)
@@@Text for subch_threshold.0@@@ (84 (threshold of class1 after Enty))
@@@Text for dl_cn_list_a.7@@@ (25 (64QAM 2/3))
@@@Text for alpha_p_avg@@@ (0)
Offset value for open loop power control. (Units: db) [-32..31.75] (0)
@@@Text for subch_limit.0@@@ (4 (limit value before Enty))
@@@Text for dl_cn_list_a.2@@@ (10 (QPSK 1/2))
@@@Text for rate_up_count@@@ (7)
@@@Text for dl_cn_list_b.5@@@ (20 (16QAM 3/4))
@@@Text for la_dl@@@ (1)
@@@Text for dl_cn_list.8@@@ (27 (64QAM 3/4))
Report interval for REP-REQ/RSP. (Units: s) [0..60] (0)
@@@Text for dl_cn_list_b.0@@@ (8 (QPSK 1/2 x4))
@@@Text for gtb4_int@@@ (2800)
@@@Text for dl_cn_list.3@@@ (14 (QPSK 3/4))
Update interval of transmitting CQICH allocation IE. (Units: frames) [40,80,160,320,640] (640)
Duration of tx power report. [1..15] (8)
@@@Text for ul_cn_override2@@@ (0x444423221234800C)
@@@Text for cl_power_adjust@@@ (0)
@@@Text for subch_threshold@@@ (0x54575A)
@@@Text for dl_cn_list_a.6@@@ (23 (64QAM 1/2))
@@@Text for dl_cn_list_b.9@@@ (28 (64QAM 5/6))
@@@Text for subch_limit@@@ (0x04080402)
@@@Text for dl_cn_list_a.1@@@ (9 (QPSK 1/2 x2))
@@@Text for matrix_control_interval@@@ (200)
@@@Text for dl_cn_list_b.4@@@ (15 (16QAM 1/2))
@@@Text for la_ul@@@ (0)
@@@Text for dl_cn_list.7@@@ (25 (64QAM 2/3))
Report interval of REP-REQ/RSP. (Units: frames) [0..255] (200)
@@@Text for dl_cn_list_b@@@ (0x08090A0E0F1417191B1C)
@@@Text for gtb2_int@@@ (3800)
@@@Text for dl_cn_list.2@@@ (10 (QPSK 1/2))
Report interval for CQICH. [0..3] (3)
@@@Text for dl_cn_list_a.5@@@ (20 (16QAM 3/4))
Threshold of tx power report. (Units: db) [1..15] (15)
@@@Text for openloop_mode_chg@@@ (2)
@@@Text for subch_limit.3@@@ (2 (limit value of class3 after Enty))
@@@Text for dl_cn_list_b.8@@@ (27 (64QAM 3/4))
@@@Text for dl_cn_list_a.0@@@ (8 (QPSK 1/2 x4))
Update interval for rate control. (Units: frames) [1..1024] (200)
@@@Text for subch_enable@@@ (0)
@@@Text for dl_cn_list.6@@@ (23 (64QAM 1/2))
@@@Text for ni_avg_factor@@@ (0)
@@@Text for dl_cn_list_b.3@@@ (14 (QPSK 3/4))
CINR reports content. (0)
@@@Text for dl_phy_quality@@@ (0)
@@@Text for dl_cn_list.1@@@ (9 (QPSK 1/2 x2))
@@@Text for gtb1_int@@@ (0)
@@@Text for dl_cn_list_a.9@@@ (28 (64QAM 5/6))
@@@Text for subch_threshold.2@@@ (90 (threshold of class3 after Enty))
@@@Text for pwcon_mode@@@ (2)
@@@Text for cl_power_waittime@@@ (10)
@@@Text for dl_cn_list_a.4@@@ (15 (16QAM 1/2))
@@@Text for subch_limit.2@@@ (4 (limit value of class2 after Enty))
}}}
== bs/security - Security parameters ==
{{{
Set SECURITY parameters
Lifetime of a newly assigned TEK. (Units: s) [60..604800] (3600)
@@@Text for cryptographic_suite@@@ (0x00020104)
Grace time before MS acquires another authorization key. (Units: s) [70..604800] (70)
@@@Text for pkm_flow_control@@@ (0)
Grace time for TEK. (Units: 600) [10..3600] (600)
@@@Text for max_security_association@@@ (1)
Timeout value for SA-TEK challenge retranmission. (Units: 100ms) [5..20] (10)
@@@Text for pkm_version_support@@@ (0x02)
Max number of SA-TEK challenge transmissions. (3)
}}}
== bs/wireless - Wireless parameters ==
{{{
Set WIRELESS parameters
@@@Text for dcducd_repetition_cnt@@@ (6)
@@@Text for initrang_interval@@@ (1)
BS transmit power (40)
Number of periodic ranging CDMA codes available [0..255] (64)
@@@Text for gms_enable@@@ (0x06)
Support permutation mode. (0)
@@@Text for initrang_no_subchannel@@@ (6)
@@@Text for periodic_backoff_start@@@ (3)
@@@Text for rx_ho_ranging_max@@@ (0)
Used UL subchannel group. (0x0000000007FFFFFFFF)
Final backoff window size for initial ranging contention, expressed as a power of 2. This is encoded in the UCD message in the MAC layer. [0..15] (15)
@@@Text for fn_randseed@@@ (0)
PRBS_ID for 2nd zone [0..2] (0)
@@@Text for bwreq_no_symbol@@@ (1)
Minimum PHY rate for Extended Real-Time Polling Service (QPSK 1/2 (0))
Receive transmit transition gap (units: PS) (168)
Antenna gain of BS (units: DBi) [0..255] (0)
@@@Text for feedback_st_subchannel@@@ (6)
@@@Text for fairness_mode@@@ (1)
@@@Text for dlmap_repetition_cnt@@@ (6)
@@@Text for harqack_no_subchannel@@@ (2)
Center frequency (2590000)
Number of initial CDMA ranging codes [0..255] (64)
@@@Text for siiadv_interval@@@ (10)
Used DL subchannel group. (0x3F)
@@@Text for initrang_no_symbol@@@ (2)
Final bakoff window size for handoff. (15)
@@@Text for rx_initial_ranging_max@@@ (4)
DL permutation base for 2nd zone. [0..31] (0)
@@@Text for bwreq_st_subchannel@@@ (0)
Initial backoff window size for initial ranging contention, expressed as a power of 2. This is encoded in the UCD message in the MAC layer. [0..15] (3)
@@@Text for ul_pusc_rotation@@@ (0)
@@@Text for feedback_st_symbol@@@ (0)
@@@Text for cqich_bwreq@@@ (1)
Minimum PHY rate for Unsolicited Grant Service (QPSK 1/2 (0))
Transmit Receive transition gap (units: PS) (296)
Bs rx gain (61)
@@@Text for timing_gap_offset@@@ (-748)
Encoding-type of DL map (0)
@@@Text for harqack_no_symbol@@@ (3)
Time interval between UCD and DCD mesages (units: frames) [10..4000] (0x00C8)
Initial value of code group of initial ranging. [0..255] (0)
(0)
@@@Text for initrang_st_subchannel@@@ (0)
Initial backoff window size for handoff. (3)
@@@Text for framesync_mode@@@ (2)
@@@Text for dlulration@@@ (0x00)
@@@Text for bwreq_st_symbol@@@ (2)
@@@Text for min_phy_rate_be@@@ (QPSK 1/2 (0))
@@@Text for pwr_adjust_threshold@@@ (12)
Maximum rx power (-45)
Number of handover ranging codes. [0..255] (64)
@@@Text for bcp_ie_transmit_count@@@ (117)
@@@Text for admission_threshold@@@ (0)
Default RSSI averaging parameter on DCD messages. (0x00)
Contention-based reservation timeout [0..255] (8)
@@@Text for odu_alm_control@@@ (0x10000000)
Compressed map on/off (0)
@@@Text for harqack_st_subchannel@@@ (33)
Final backoff window size for contention bandwidth requests, expressed as a power of 2. This is encoded in the UCD message in the MAC layer. [0..15] (15)
@@@Text for frame_adjust_threshold@@@ (500000)
Segment on/off (0)
@@@Text for initrang_st_symbol@@@ (0)
Minimum PHY rate for Non-Real-Time Polling Service. (QPSK 1/2 (0))
@@@Text for odu_noise_floor@@@ (40)
Bandwidth mode [0 = 10MHz, 1=7MHz, 2=5MHz] (0)
@@@Text for feedback_no_subchannel@@@ (29)
Default CINR averaging parameter on DCD messages. (0x03)
@@@Text for multicast_repetition_cnt@@@ (6)
Number of bandwidth request codes available. [0..255] (64)
BS transmit power offset (0)
@@@Text for mac_version@@@ (6)
@@@Text for harqack_st_symbol@@@ (0)
Number of segments (0)
@@@Text for periodic_backoff_end@@@ (15)
@@@Text for rf_cable_len@@@ (0)
@@@Text for bwreq_no_subchannel@@@ (6)
Preamble number. Set different nunber for each BS and Segment from each other. The cell ID / segment # is derived from this parameter.[0..113] (0)
Initial backoff window size for contention bandwidth requests, expressed as a power of 2. This is encoded in the UCD message in the MAC layer. [0..15] (3)
@@@Text for sdu_max_delay@@@ (5000)
@@@Text for feedback_no_symbol@@@ (3)
Permutation base (0x00)
@@@Text for aging_timeout@@@ (30)
Minimum PHY rate for Real-Time Polling Service (QPSK 1/2 (0))
@@@Text for fairness_count_reset@@@ (2)
}}}
== bs/debug - DEBUG parameters ==
{{{
Set DEBUG parameters
Debug variable 27 (-280)
}}}
== /status - Get Current Status ==
{{{
Get status of WiMAX RF service
}}}
== /get - Get Basestation Parameter ==
{{{
Get Basestation Static Parameter
}}}
== /set - Set Basestation Parameter ==
{{{
Set Basestation Static Parameter
}}}
== /restart - Restart the Base Station ==
{{{
Restart the Base Station
}}}
== 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
}}}