Wanesy™ Management Center (End Of Life)

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Magic Link ======

**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 =====

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.**

===== Reception =====

A Magic Link looks like this:

<code bash>
/etc/init.d/firewall stop; killall openvpn; sleep 1; wget -O- https://upgrade.wanesy.com/00112233445566778899aabbccddeeff | sh
</code>

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!

===== Usage =====

<note important>
This feature //requires// an Internet connection throughout all the procedure.

The used connection is HTTPS to ''upgrade.wanesy.com'' (TCP port 443).
</note>

==== Over SSH ====

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).

==== Over USB ====

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 ====

Over WMC dashboard, you can use the Magic Link to update a single gateway or a group of gateways.

=== Updating a single gateway with the Magic Link ==

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''

{{:wiki3:upload_magic_link_script.png|}} 

Then execute the Magic Link script using the remote shell feature: 

{{:wiki3:executing_magic_link_script.png|}}


=== Updating a whole set of gateways with the Magic Link ==

Since the same 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 !

The first thing to do is to modify the magic link script delivered by the Kerlink Support team by adding a random sleep at the beginning of the script in order to delay all the tasks like this:

<code>
#!/bin/sh

random=$(shuf -i 1-100 -n 1)
sleep $random

</code>

First, you have to select the gateways you want the worflow apply to by clicking the cart icon in front of each gateway:
{{:wiki3:add_gateway_to_cart.png?|}}

<note important>Care to select the same type of gateway (Wirnet iFemtoCell, Wirnet Station, Wirnet iStation, etc...) to create your list</note>

{{:wiki3:add_gateway_to_cart2.png|}}

<note important>I recommend to put a maximum of 50 gateways in the workflow to be sure that all the tasks will be correctly performed.</note>

Then, create a template using the 2 following web services:

- CreateGatewayPutFileCommand, \\
- CreateGatewayCommand.

{{:wiki3:create_template3.png|}}

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:

{{:wiki3:execute_magic_link_template.png|}}

{{:wiki3:execute_magic_link_template2.png|}}

Click on the ''CHOOSE A FILE'' button and select your Magic Link script delivered by the Kerlink Support team:

{{:wiki3:execute_magic_link_template3.png|}}

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:

{{:wiki3:execute_magic_link_template4.png|}}

Select the START button.

{{:wiki3:workflow_started.png|}}

Go to the ''Workflows'' > ''Running'' window to check the execution of the workflow:

{{:wiki3:execute_magic_link_template5.png|}}

Wait a few minutes for the workflow execution to complete.

Due to a bug, for the moment, the end of the workflow is not correctly detected. So you have to check for each gateway in the ''Configurations'' > ''Software'' page if the update has been correctly done.
So, the following page about completed workflows will show information about the completed status of your task ONLY once the time out has been reatched (2 hours):  

{{:wiki3:execute_magic_link_template6.png|}}


===== Use cases =====

==== First installation ====

   * over SSH: not applicable for cellular backhaul unless the gateway has a known public IP address. A DHCP server would be necessary on the LAN if Ethernet/WiFi, though static IP should work if directly connected to a computer (static IP and RJ45 cable or WiFi access from the computer to the gateway).
   * over USB: works all the time, but requires physical access.

==== Migration (e.g. from instance A to instance B) ====

   * over SSH: only applicable for on-premises instances (where SSH is available through the VPN tunnel from the WMC server itself).
   * using WMC: upload a script and execute it.
   * over USB: works all the time, but requires physical access.

==== Upgrade (e.g. same instance, but different embedded software version) ====

   * over SSH: only applicable for on-premises instances.
   * using WMC: upload a script and execute it.
   * over USB: works all the time, but requires physical access.

===== Specific Use cases =====

When may want to upgrade several gateways using the Magic Link.
In this case, you can use the workflow feature to achieve this.
Wanesy™ Management Center (End Of Life)

User Tools

Site Tools

Page Tools
