= 9.  WiMAX RF Aggregate Manager Service =
wimaxrf is an Aggregate Manager (AM) that is used to configure and control WIMAX (Basestation) RF Section.

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

== Installation ==

{{{
   apt-get install omf-wimaxrf-aggmgr-5.2
}}}
Please confirm that the most current packages of the software are installed. You can check it [[BR]]
with the following commands.

{{{
dpkg -l | egrep 'omf-|asn-gw|click'
}}}
Current version for omf-common-5.2 is 4 and [[BR]]
Current version for omf-aggmgr-5.2 is 6
{{{
ii  omf-aggmgr-5.2                      ubuntu6                                  OMF Aggregate Manager
ii  omf-common-5.2                      ubuntu4                                  Common ruby classes for OMF
}}}

'''In case of wrong version''' please remove the two packages and reinstall them.[[BR]]

{{{
apt-get --purge remove omf-aggmgr-5.2 omf-common-5.2
apt-get install omf-aggmgr-5.2
dpkg -l | grep omf-
}}}

== Configuration ==

The configuration file for wimxrf AM is in the same location as for all the other OMF AM services in /etc/omf-agggr-5.2/available/wimaxrf.yaml. The configuration file consists of multiple section sections relating to different components of the services. 

Default parameter values are shown in []; Bold font indicates mandatory parameters.

=== asngw: Section ===

{{{
  asngw:
   if: eth1
   ip: 10.3.0.71
   rcvport: 54321
   sndport: 54321
   id: ASNGW000
   tecnh: 3
   dsc: IP-Config-Mgmt
}}}

=== bs: section ===
{{{
}}}

=== datapath: section ===

Typical configuration:

{{{
  datapath:
    type: simpleclick
    def_gw: 10.41.0.1
    net_mask: 255.255.0.0
    def_ip: 10.41.0.254
}}}

These configuration parameters are temporary -> click is supposed to learn them from client DHCP requests.

 * '''def_gw''': IP address of the default gateway for WiMAX clients [none]
 * '''net_mask''': Network mask for datapath subnet [none]
 * '''def_ip''': IP address that will be given to clients that are not assigned IP address (i.e. unknown clients) [none]
=== auth: Section ===
{{{
  auth:
    database: /var/spool/asnctrl/wimax-clients.sql
    allow_unknown: true
}}}

 * '''database''': Location of the SQLite authentication database [/var/spool/asnctrl/wimax-clients.sql]
 * allow_unknown: If set to true, will allow access for clients that are not registered in the authentication database [false]

=== Oml: Section ===
{{{
   localoml:
       omlServer: oml.orbit-lab.org
}}}

 '''omlServer''': value is the hostname of your OML server. Alternatively if you wish to install the oml2 server on your host[[BR]] locally, please do so by the following commands.

{{{
  apt-get install oml2-server 
}}}
 and then point the omlServer value to localhost.
=== reset:  Section ===
{{{
  reset:
   file: '/defaults/reset.xml'
}}}

  * '''file''': location of the default configuration [none]. The file is an XML file that containes default BS parameters and is used with '''/default''' wimaxrf service

Each of the sections in this file should be modified to reflect your deployment configuration (please keep in mind that this is a YAML file and that it depends heavily on spaces and not TABs). Once the configuration file is ready, you have to enable the service by creating the symbolic link in /etc/omf-aggmgr-5.2/enabled:

{{{
ln -s ../available/wimaxrf.yaml
}}}

and restarting the OMF aggregate manager service:
{{{
/etc/init.d/omf-aggmgr-5.2 restart
}}}

=== Logging ===
OMF aggregate managers  have quite extended logging capabilities. Log messages from all of the enabled services are stored in /var/log/omf-aggmgr-5.2.log