But, before we do that, let’s start with a quick overview of all the components in your FreedomFi enabled network. Here’s a picture of the components.
Network Management System (NMS) – The NMS is the webUI that lets you interact with your network.
eNB Radio – The eNB Radio is the base station transmitter of your LTE or 5G network.
UE – The UE (or User Equipment) is the end user device. These are usually smartphones or home router type devices. But UEs can take many forms.
The first step is to set up a new Network in your orchestrator. Networks in Magma share common properties including:
1. Broadcast PLMN
2. Subscriber / SIM data base
NOTE: Network ID must be made up of lowercase letters, numbers, and underscore characters only.
NOTE: For the majority of FreedomFi customers network type = LTE will be the right choice. If you think you need an alternative please contact support.
NOTE: WAN connection should have DHCP service to give your gateway an IP address + DNS server. This way your gateway can see the internet and the orchestrator.
NOTE: Place the ‘freedomfi.lic’ file in the root directory of the thumbdrive. This just means not inside any folders on the thumb drive. Also, don’t rename the file, that may confuse us
NOTE: Gateway initial provisioning takes 10-20 minutes with most internet connections. It is important you allow 10-20 minutes with power and internet connected to the gateway at this step as we update SW and configure your gateway. Any power interruption during that time may require bash terminals and support calls and other such nerdery to recover.
NOTE: If you jumped the gun and already powered the gateway up a while ago, no worries, put the thumb drive in and wait for the beep. You’ll be on the 2nd beep above at that point. We check for that file every couple of minutes until we find it.
OK, now that you have everything plugged in we need to tell the orchestrator which network to add your gateway to. You may only have one network right now, but in the future you may have more. The FreedomFi Gateway zero-touch provisioning process brings all of your new gateways into a simple drop down list. From there, you can easily add each new Gateway to your desired network.
Here are the steps to add your gateway to your network:
NOTE: We are going to use many of the same values when we created your network. Depending on your network, you may want to provide different values here that would override the matching parameter configured at the Network level. For a single Gateway network, we will keep all values the same.
NOTE: Gateways in this list will be identified by their Private IP address and/or the public IP address they use to help you identify gateways when you have more than one registered but not assigned to a network.
NOTE: this will autofill the HW ID and ChallengeKey values unique to this gateway.
NOTE 2: If you get here and your list is empty, that means your gateway is still working on provisioning. Refresh your browser window in 5 minutes and try again.
NOTE: Lowercase letters, numbers, and underscores only can be used for Gateway ID field. Also Gateway ID cannot be changed once saved without deleting and re-adding gateway. So you know, pick a good one.
Also note, leave version blank, we’ll fill that in automagically when the gateway checks in with orchestrator.
NOTE: For now accept the defaults, we’ll come back after we add your eNB and change these settings to match.
Now that we have your gateway, let’s add the radio to the orchestrator.
NOTE: Similar to gateway name, this cannot be edited once chosen without deleting and re-adding radio. So pick a good one!
NOTE: These values must match what you have configured in your radio webUI. In particular TAC value must match to allow S1AP connection. The Cell ID must match to enable MME Connected status display in NMS (in Baicells this is called ECI or Cell ID). IP address must match S1 IP (sometimes called WAN IP) to track eNB bandwidth stats. You can update it later if unsure or if it changes.
An Access Point Name (or APN) is used to route traffic to a specific data network and apply Quality of Service (QoS) policy to that data like bandwidth limits, and priority. We will start by making a basic APN to be used as your default. You can always get fancier later.
NOTE: Your APN can be any name, internet is a very common default that devices use, so it’s a good choice for your default.
NOTE: APNs have rate limits. By default these are set to 1Mbps. We like to increase them to 100Mbps to make sure our cell is working well. You can come back anytime and reset your APN rate limits lower or higher with the same steps.
NOTE: This extra button appears to save the number as a number, not text. It is important to save this setting using the checkbox the arrow is pointing to.
Whew! You did it! We know editing JSON is scary. We are working on a pretty pop-up for APNs. Until then, this guide is always here to remind you how to edit them.
Last step in the setup is to make sure that orchestrator knows about your SIM card and has the security keys needed to make the super secure connection to your UE.