This is an old revision of the document!
To ease the upgrade, migration or first installation of gateways, a Magic Link feature can be used.
It is a simple command or a simple script based on wget
that automatically downloads the required embedded software, configures the VPN connection, configures the packet forwarder with the best default configuration, all in one step.
Request has to be made to customer support through support@kerlink.fr or by opening an OTRS Ticket.
A single Magic Link can be reused for as many gateways as necessary (please include them all when requesting the Magic Link from Kerlink support). It is linked to a single WMC instance.
There is a unique and secret token inside the Magic Link command, Magic Link script or USB package.
This is a secret that shouldn't be shared and transmitted in a non-secure way.
A Magic Link looks like this:
/etc/init.d/firewall stop; killall openvpn; sleep 1; wget -O- https://upgrade.wanesy.com/00112233445566778899aabbccddeeff | sh
It can either be given as is, for copy/paste, or as a ZIP package, for USB installation.
The hash (the 32-digit token in the URL above: 00112233445566778899aabbccddeeff
) is secret. Be sure to safely transmit it, and avoid sharing it!
The used connection is HTTPS to upgrade.wanesy.com
(TCP port 443).
An SSH access to the gateway is required, this means that it shouldn't be already connected to WMC (unless for on-premises servers, in which case SSH is possible from the WMC server itself).
Just copy/paste the provided command and wait for about 5 minutes (20 minutes if Wirnet iBTS with FPGA upgrade).
Unzip the provided package on an USB stick and plug it into the Wirnet gateway.
For Wirnet iBTS and Wirnet iFemtoCell, please remove the USB stick after 15 seconds (as soon as the LED blinks). For Wirnet Station, please leave the USB stick plugged in for 20 minutes, or until the gateway is shown as connected on the WMC instance.
Over WMC dashboard, you can use the Magic Link to update a single gateway or a group of gateways.
For WMC, it is less useful to use the Magic Link as the Software Upgrade feature can be used to send any package: new VPN package (migration), megapackage (upgrade), etc.
The advantage though, is that it's no longer required to download the megapackage from this wiki and upload it in the Software update section of the WMC. The gateway will directly download the megapackage and VPN package through the use of the Magic Link.
Use the File Explorer feature of the WMC to upload the Magic Link script to /tmp
or /user
. Then use the Remote Shell feature and type: sh /tmp/magic_link.sh
Then execute the Magic Link script using the remote shell feature:
Since the same command line or script can be used to update a gateway, the Magic Link can be used to update a whole set of gateways. That's the magic of this feature !
It exists 2 ways of using the magic in this context:
First, add your gateways to the Cart:
You can add as many gateways as you want.
Select the Cart icon
Select the Workflow template you want to use:
If the template CreateCommand does not exit, create it by selecting the Templates
item in the Workflow menu:
Select the category: Gateways
, select the CreateGatewayCommand
method in the list and drag and drop it in the Selected window on the righ side of the screen:
Enter the name of your template and a short description (optional) then validate.
The new workflow template is now ready to be executed.
Return to the Cart.
command
.Workflows
> Completed
window:Create 2 templates :
- CreateGatewayPutFIleCommand,
- CreateGatewayCommand.
Take care to put CreateGatewayPutFileCommand as Task #1 and CreateGatewayCommand as Task #2.
Give a name to your template and select the button VALIDATE
.
Go to your Cart and select your new template:
Click on the CHOOSE A FILE
button and select your Magic Link script delivered by the Kerlink Support team:
Set the destination path to /tmp
if you are using a WIrnet Station else set the value of /user
for KerOS product,
Copy/Paste the Magic Link script filename to the command area and prefixe it with the sh /user/
command:
Select the START button.
Go to the Workflows
> Running
window to check the execution of the workflow:
Wait for the workflow execution to complete:
When may want to upgrade several gateways using the Magic Link. In this case, you can use the workflow feature to achieve this.