Documentations

Commissioning of a ServiceNav Box

On the page

Do you need help?

Installation process

This procedure describes how to install a ServiceNav box and connect it to your ServiceNav web platform.

ServiceNav supervision can be done in two modes:

  • Virtual Machine
    • VMware
    • Hyper-V
    • Xen Server
  • Box (physical)

The behaviour at the ServiceNav application level is the same.

Installation of a VMware-type VM

Retrieve the last OVF files and import them on the desired hypervisor or the V-Center. Once the VM is imported, you have to allocate resources to it according to the number of elements to supervise.

information icon You can get the OVF files at the following address ftp://software.servicenav.io
Login : <Ask our support>
Password : <ask our support>
warning svgrepo com Starting with version 6.5 it is no longer possible to deploy a Template from an OVF with a fat client. You have to use the Web interface.

You have to select the 3 files .mf, .ovf and .vmdk

If the VM deploys anyway but you are blocked on intiramsf at startup it's because the deployed files are corrupted.  IE is not capable of deploying large files (>4 GB), we strongly recommend using Firefox or Google Chrome for OVF deployment.

Install VMWare tools.

Mount VMWare Tools.

mount /dev/cdrom /mnt
cp /mnt/VMwareTools-*.tar.gz /root/
tar xvf VMwareTools*
./vmware-tools-distrib/vmware-install.pl

Proceed with the default installation.

Restart (run the command reboot).

Installation of a Hyper-V VM

information icon You can get the latest files at the following address ftp://software.servicenav.io
Login : <ask our support>
Password : <ask our support>

To install a virtual Hyper-V ServiceNav Box you need to go to the Hyper-V Manager and create a new "virtual computer":

servicenav-hyperV1

Then a VM creation wizard opens:

ServiceNav-HyperV003

Click on Next.

ServiceNav-HyperV004

Define the name and the location.

ServiceNav-HyperV005

Set the amount of RAM that you want to allocate for this VM.

ServiceNav-HyperV006

Choose the right networkthen click directly on Next.

ServiceNav-HyperV001

Here we will use an existing virtual disk, click on Browse... .

ServiceNav-HyperV008

Select the ".vhd" file that you downloaded from the FTP download site. Then click on open, then next.

warning svgrepo com Attention you should always take the latest version of the Hyper-V documentation and template from the FTP to be up to date. If the version is too old it may not work and/or the deployment procedure will not be up to date.
ServiceNav-HyperV009

Check the summary and click on Finish

warning svgrepo com Known errors

HYPERV 2012: Unable to start the VM: " SCSI boot error, etc..."
Solution: Check during installation that you have chosen generation 1

HYPERV 2016: When the SNB is started, a " error syncing, kernel panic "
Solution:
Log into HyperV Manager, select the VM and click Parameters. 
Hyperv2016 parameter

Configure processor comptability mode in HyperV for SNB
hyperv2016

 
Important note for HYPERV 2012 -2016: choose Generation 1

Installation of a ServiceNav Box (physical)

Ordering the ServiceNav Box from Coservit.

It is possible to have it done by Coservit (in this case you have to fill in the inventory file), otherwise you have to follow the following documentation, and bring the following elements:

  • VGA monitor
  • USB keyboard
  • Network (with SSH access to the ServiceNav SaaS platform)

Platform configuration

Creation of a company

The addition of an entity to a company is done via the web interface. It is therefore necessary to connect to the web interface.

Once connected, you must go to the " Organization" .

ServiceNav-MenuMain
ServiceNav-TreeLocation

A list view with the selected company is displayed, select the parent of the future entity:

  • To add a customer you must be on the entity of his partner.
  • To add a "site" you must be on either a customer or partner entity.
ServiceNav-Organization-Society

You must create a new client or a new site by clicking on : " + Add

ServiceNav-AdditionClient

Fashion: Choose if the customer is in outsourcing contract or autonomous on the supervision (resale mode).

Company name: Name of the new company.

Public IP : Specify the public IP address of the client.

Sending email address : Name of the email address to which supervision notifications about user services will be sent.

VIP : Allows you to choose the type of client

Once the information is entered, click on the button Validate.

Creating a ServiceNav Box in the application

To put a new ServiceNav Box into production, you need to create its certificates.

To do this, go to the Configuration menu, then Box, then the Add button

Please note: you must be on the company for which you want to add the "ServiceNav Box".

Fill in the Name field with the name of the Box (this is the name to be used later in the procedure), leave the other fields filled in with the default values, then validate.

add box 1

The box will be created automatically (the process may take a few minutes, once the box is created the loading icon is replaced by theServiceNav FlecheToken).

Configuration of the ServiceNav Box

Prerequisites

In this section you will need the following items:

  • The name of the ServiceNav Box
  • The url of the ServiceNav web platform

For an installation with a fixed IP address (recommended) you will also need :

  • IP address of the ServiceNav Box
  • The subnet mask to use
  • The default gateway
  • The local DNS suffix
  • The IP address(es) of the DNS servers

The ServiceNav Box must be able to reach the ServiceNav platform via http and https.

To find out which ports to open on exit : To be requested from support

Connecting to the ServiceNav Box

Once the boiter has started on the operating system it asks for login information. Before modification this information is the following:

Login : To be requested from support

Mdp: To be requested from support

At this point, the ServiceNav Box is configured in DHCP.

warning svgrepo com Attention Never manually update your supervision box. The OS updates are managed automatically during the version upgrades or via the UI.

Installation

Launching the installer

To launch the ServiceNav Box installer, execute these three commands:

sudo su -
cd /root/vsb_installation
./vsb_installation.pl

Then follow the instructions on the screen:

###############################
 ##### VSB INSTALLATION #####
 ###############################
 Copyright CoServIT 2012-2021. All rights reserved.
 ## Welcome in the SNB Installation script - SNB/VSM side.
 ## This tool will allow you to :
 ## - Configure your network
 ## - Contact the SNB Installation API to get your synchronization parameters
 ## - Configure the mail
 ## Note : You can exit this program with Ctrl+C
Press any key to continue

Press a key to continue

Network settings

  • DHCP configuration

To set the ServiceNav Box to DCHP press the Enter and proceed to the next section (Downloading the configuration)

##### NETWORK CONFIGURATION #####
Do you want to configure the Network (y/n) [default: n] :
  • Configuration with a fixed IP address

If you want to use a fixed IP address type "y", then press Enter to validate your choice:

##### NETWORK CONFIGURATION #####
Do you want to configure the Network (y/n) [default: n] : y

Type "s", then press the Enter to validate your choice:

Static (s) or dhcp (d) [default = d] : s

Enter the IP address you wish to use, then press the Enter to validate your choice:

IP address : 192.168.192.27
Ip saved : 192.168.192.27

If the subnet mask is not to be changed, press the Enter.

Otherwise, enter the subnet mask and confirm by pressing the Enter

Netmask [default = 255.255.255.0]:

If the broadcast address is not to be changed, press the Enter.

Otherwise, enter the broadcast address and confirm by pressing the Enter.

Gateway [default = 192.168.192.254]:

Enter the IP address of the domain name server(s). Once the DNS server addresses have been entered, press "n" to proceed to the next step.

Please note that it is mandatory to enter at least one DNS server.

DNS Name-servers IP ('n' for next step): 192.168.192.254
DNS saved: 192.168.192.254
DNS Name-servers IP ('n' for next step): n

Fill in the local DNS suffix, then validate by pressing the Enter

Local Network Name [default = lan] : coservit.local

Enter the name given to the ServiceNav Box.

Hostname (example : SNB_1) :SNM-PARTNER

You must then apply the network changes. To confirm your choice, press the Enter

If you change the IP address, you will have to reconnect to the SNB
Do you want to commit this network configuration ? (y/n) [default : n] : y
--> Committing
--> Done

Downloading the configuration

Web application side

The ServiceNav Box configuration is available for download via an API running on the solution's web server.

This configuration contains, among other things, the previously generated certificates.

In order to download this configuration, you have to connect to the platform to authorize the download.

We therefore place ourselves in the application at the level of the section " Configuration "then in the menu " General "then the sub-menu " Housing "

ServiceNav-TokenBox

A token is then generated to authorize the download by clicking on the arrow ServiceNav FlecheToken.

A pop-up window opens:

ServiceNav-RecupTokenBox

An installation token is generated with a lifetime of ten minutes. Keep this pop-up open while you recover the box configuration as you will need this information.

NB: if your token has expired close the pop-up and repeat its generation.

  • ServiceNav Box

Choose the "y" option to download the configuration.

##### CONTACTING INSTALLATION PROVIDER #####
Do you want to retrieve configuration by HTTP/HTTPS api (y/n) [default: n] : y

Then enter the url of the ServiceNav SaaS web platform:

- In OnPremise mode WebApp URL: URL of the platform in the format https://my.supervision.com 

- In SaaS mode :
WebApp URL:  https://snb-init.servicenav.io (if your web interface is https://servicenav.io)  
OR  
WebApp URL :  https://vpn-azure.servicenav.io (if your web interface is https://azure.servicenav.io) 
For any other web interface address, contact support to know the URL address to enter

Retrieve in the pop-up the username and fill it in:

ID: 

Retrieve the installation token from the pop-up and fill it in:

Token installation : 

The download is done :

--> Request sent to the installation provider
Installation package has been correctly downloaded from the installation provider.
Configuration files have been correctly extracted from the installation package.
* Stopping virtual private network daemon.                            [ OK ]
* Starting virtual private network daemon.
* customer (OK)
                                                                      [ OK ]
Stopping remoteOperationBox : remoteOperationBox
Waiting for remoteOperationBox to exit . done.
Error: /usr/local/nagios/var/remoteOperationBox.pid already Exists.
But no remoteOperationBox process runnig
Removing remoteOperationBox pid file
Starting remoteOperationBox : remoteOperationBox
information icon The message "Error: /usr/local/nagios/var/remoteOperationBox.pid already Exists" may appear and is normal.

The ServiceNav Box is now securely connected to the server.

Configure the sending of email notifications

The last step is the configuration of the email sending with the Exim4 email service located on the ServiceNav Box. If needed, you can consult documentation on this subject.

To set up email notifications, type "y" and press the "Enter" key:

##### MAIL CONFIGURATION (EXIM4) ######
Do you want to configure the Mail (y/n) [default: n] : y
--> Launching exim4 config. Do not interrupt !

The Exim4 configuration tool is launched. The configuration can be done directly by SMTP, or via a relay server.

In case of Live configuration

Here's what you need to do to answer the questions:

Configuration type: Direct distribution by SMTP (Website)

Email name of the system: .

List of IP addresses to Exim will be waiting for incoming SMTP connections: 127.0.0.1

Other destinations whose email must be accepted: (white)

Areas to be relayed: . (example masociete.com )

Relay machines: 127.0.0.1

Should we minimize DNS queries (on-demand connections)? No

Method of delivering local mail: Format in /var/mail

Is it necessary to separate the configuration in several files? No

In case of Configuration via a relay server

Here's what you need to do to answer the questions:

Configuration type: Sending via relay (smarthost) - no local mail

System email name: . (example masociete.com )

List of IP addresses to Exim will be waiting for incoming SMTP connections: 127.0.0.1

Other destinations whose email must be accepted: (white)

Visible domain name for local users : . (example masociete.com )

Network name or IP address of the smarthost system : x.x.x (IP address of the mail relay server)

Areas to be relayed: en

Relay machines: 127.0.0.1

Should we minimize DNS queries (on-demand connections)? No

Should the configuration be separated into several files? No

Once the configuration is complete the service will restart:

* Stopping MTA for restart [ OK ]
* Restarting MTA [ OK ]
--> Exim4 config finished

To test the sending of emails, type the following command and adapt it to your needs:

echo test | mail -s 'test' mon.email@mondomaine.com

or

mail -s "Hello World" mail@domaine.com
Cc: Text

End of the configuration

To exit the installer press a key:

Press any key to exit

Important - version 4.17.0 Once the new ServiceNav Box is linked to ServiceNav, go to Configuration > Box, select the ServiceNav Box and click on "Start Migration", in order to upgrade it to version 4.17.1

Synchronization with a time server

Enter the valid time source(s) for the ServiceNav Box in the /etc/ntp.conf.
Restart the ntp service: service ntp restart.

The order ntpq -p (run as root) allows you to query the ntp on its current state.

Securing access to the ServiceNav Box

In order to secure the box, a password must be generated. We advise you to use a password generator with the following generation rules:

  • 12 characters
  • Upper/lower case/numbers/punctuation/uniqueness of characters
warning svgrepo com Warning: when generating a password for a Hyper-V ServiceNavBox, do not use punctuation characters. These characters are not always correctly interpreted by the Hyper-V console. This would make it impossible to access without a network connection.

Once the password is generated, type the following command to change it, for the user with whom SSH access is made:

passwd

Save the password in your production repository.

Configuration of the ServiceNav Box monitoring

The objective is to set up the necessary environment to supervise the proper functioning of the ServiceNav Box that we have just deployed.

Supervision of the ServiceNav Box system

Test if the box is working properly at the system level:

  • Launch a census from the web interface on the IP address 127.0.0.1 and the SNMP community: coservit from the web platform. To do this, go to "Configuration", "Equipment" and then "Census".

Then launch a census by clicking on the "Census" button:

ServiceNav-Configuration-Equipment-Recency
ServiceNav-Configuration-Equipment-Recency-Account

Expected outcome: the census ends correctly if an equipment is found.
- Add equipment 127.0.0.1 with the name "", the snmp community: " coservit "and apply the equipment category: " Monitoring Box " then the model: "ServiceNav Box - self-supervision"

addition of equipment

Check that the SNMP monitoring account is : coservit in the tab Accounts.

- Reload the configuration of the new ServiceNav Box
- Check the data upload to the ServiceNav website

Supervision of the proper functioning of the ServiceNav Box

This is where you can see if the ServiceNav Box can be reached from the platform and if it is sending back information.
- Add a device with the name: " Supervision of "

addition of supervision box
  • Enter the VPN IP in IP address/DNS
  • Choose the shared monitoring server (VSM) hosted on your premises. Please note that the ServiceNav Box must not monitor itself because you will not be notified in case of an incident. In this example, you would have to choose a different box from Supervision for the "Monitored from" field
  • (OnPremise platform only) Select the equipment category "Monitoring Box ". Apply the equipment model: " ServiceNav Box - Supervision by supervisor ". Now you need to configure the "Box-Live-Status" service with the name of the ServiceNav Box: this service ensures that the ServiceNav Box reports the information (status, status information) displayed in the technical evaluation of the ServiceNav website.
ServiceNav-ServiceBoxLiveStatus

Put the of the ServiceNav Box to be monitored in the "Box name" chanmp.
Once the configuration is done you have to generate it to send it to the ServiceNav Box.

Annexes

Manual network configuration

a) Fixed IP address (preferred configuration)

To assign it a fixed IP address :
Type the following command:

nano /etc/netplan/90-snb.yaml

Edit file :

---
network:
  version: 2
  renderer: networkd
  ethernets:
    ens160:
      addresses:
        - x.x.x.x/x
      gateway4: x.x.x.x
      nameservers:
        addresses: [x.x.x.x x x.x.x]
      dhcp4: false

Create/edit :

nano /etc/netplan/90-snb.yaml

Edit the /etc/resolv.conf file with the DNS IP addresses provided in the inventory file:

 Search 
 nameserver x.x.x.x
 nameserver x.x.x.x
 nameserver x.x.x.x
b) Dynamic IP address

Edit the following file:

nano /etc/netplan/90-snb-ens160.yaml

To assign an address in DHCP, add at the end of the file :

---
network:
  version: 2
  renderer: networkd
  ethernets:
    ens160:
      dhcp4: true
      optional: true

You may also be interested in

Replace a ServiceNav Box Ubuntu 16.04 with a ServiceNav Box 4.17 Ubuntu 20.04

Setting up a proxy on a ServiceNav Box

IMG 0006

Configure Exim emailing with Microsoft Office365

en_GB

Welcome to ServiceNav!

Do you need some help? More information about our products? Write to us!
You have taken note of our privacy policy.
We use cookies to ensure the best experience on our site. If you continue to use this site, we will assume that you are satisfied with it.

Reserve your place

You have taken note of our privacy policy.