Documentation

Deploying a ServiceNav Box

On the page

Need some help?

1. Installation procedure

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

ServiceNav box monitoring can be achieved in two ways:

  • Virtual Machine
    • VMware
    • Hyper-V
    • Xen Server
  • Physical (SNB appliance)

The result at the ServiceNav application level is the same for both. In order to facilitate deployment, it is recommended to fill in the Inventory.xls file available on the servicenav.coservit.fr website.

1.1 Installing a VMware-type VM

Retrieve the latest OVF files and import them to the desired hypervisor or V-Center. Once the VM has been imported, it must be allocated resources according to the number of devices to be monitored.

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 (perform a reboot)

1.2 Installing a Hyper-V VM

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

servicenav-hyperV1

The VM creation wizard opens :

ServiceNav-HyperV003

Click Next.

ServiceNav-HyperV004

Set the name location

ServiceNav-HyperV005

Configure the amount of memory you want to allocate for this VM.

ServiceNav-HyperV006

Choose the correct networkand then click Next.

ServiceNav-HyperV001

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

ServiceNav-HyperV008

Select the ".vhd" file you downloaded from the FTP download site. Then click on Open, then Next.

Caution always take the latest version of the documentation and Hyper-V model on 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 2  Known Errors

HYPERV 2012:

  • Unable to start the VM: " Boot error SCSI, etc...« 

Solution :

  • Check that you have chosen the correct installation generation 1

HYPERV 2016:

  • When the SNB starts up a message "..." is displayed. "error syncing, kernel panic."

Solution :

  • Log in to HyperV Manager, select the VM and click on Settings

  • Configure processor comptability mode in HyperV for SNB

    Warning 2 Important note for HYPERV 2012 -2016 : choose Generation 1

 

1.3 Installation of a ServiceNav Box (physical)

Order ServiceNav Box from Coservit.

It is possible ot have the installation performed by Coservit (in which case it is necessary to fill in the inventory file), otherwise follow this procedure:

  • VGA screen
  • USB Keyboard
  • Network (with SSH access to the ServiceNav SaaS platform)

2. Platform configuration

2.1 Create a company

Adding a company is done using the web interface. You must therefore connect to the web interface.

Once logged in, you have to go to the " Organization 

ServiceNav-MenuMain
ServiceNav-LocationTree

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 business partner.
  • To add a "site" you must be either on a customer or partner entity.

ServiceNav-Organisation-Society

You have to create a new customer or a new site by clicking on : « + Add 

ServiceNav-AddClient

Mode: Choose whether the customer is on a managed services contract or is autonomous on supervision (resale mode).

Company name :name of the new company.

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

Issuing email address :name of the email address with which monitoring notifications on user services will be sent

VIP: allows you to choose the type of customer

Once you have filled in the information, click on the button Apply.

2.2 Creating a ServiceNav Box in the application

To set up a new ServiceNav Box in production, you must create its certificates.

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

Attention: you must be positioned on the company for which you wish to add the "ServiceNav Box".

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

The box will be created automatically (the process can take a few minutes, once the box is created the loading icon is replaced by the icon ServiceNav-FlecheToken)

 

3 Configuring the ServiceNav Box

3.1 Prerequisites

In this section you will need the following items:

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

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

  • The 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 your ServiceNav platform in http and https..

To find out which ports to open for output : Ask support

3.2 Connecting to the ServiceNav Box

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

Login : Ask support

Password: Ask support

At this stage the ServiceNav Box is configured in DHCP.

Warning 2  Beware: Never update your supervision box..

Updates are controlled from the central platform.

3.3 Installation

3.3.1 Launching the installer

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

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

Then follow the instructions on the screen:

############################################################
 ####### VSB INSTALLATION ########
 ############################################################
 Copyright CoServIT 2012-2013. All rights reserved.
 ## Welcome in the VSB Installation script - VSB/VSM side.
 ## This tool will allow you to :
 ## - Configure your network
 ## - Contact the Vsb 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 any key to continue

3.3.2 Network settings

  • DHCP configuration

To set up the ServiceNav Box in DCHP, press directly on the Enter and go to section 3.3.3.

###### 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" and then press the Enter to validate your choice:

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

Type "s" and then press the key. Enter to validate your choice:

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

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

IP address : 192.168.192.27
Ip saved: 192.168.192.27

If you do not want to change the subnet mask, press the Enter.

Otherwise fill in the subnet mask and confirm by pressing the key Enter

Netmask [default = 255.255.255.255.0]:

If you do not want to change the broadcast address, press the key directly. Enter.

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

Broadcast [default = 192.168.192.255]:

If you do not want to change the IP address of the gateway, press the key directly. Enter

Otherwise enter the IP address of the gateway and confirm by pressing the key Enter

Gateway [default = 192.168.192.254]:

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

Attention 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 confirm by pressing the key Enter

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

Fill in the name given to the ServiceNav Box, this name must be the same as the one given on the Coservit website.

Hostname (example: VSB_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 VSB.
Do you want to commit this network configuration ? (y/n) [default : n] : y
--> Committing
--> Done

3.3.3 Downloading the configuration

  • Web application side

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

This configuration contains among others the previously generated certificates.

To be able 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 "The application". Configuration and then General " then the sub-menu " Box

 

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 the box configuration is being retrieved 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 be able 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:

WebApp URL : https://my.supervision.com

Retrieve in the pop-up the identifier and fill in the :

ID : 103

Retrieve the installation token from the pop-up window and enter the :

Token installation : Kw3TL4uxAzph

The download is completed:

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

The ServiceNav Box is now securely connected to the server.

3.3.4 Configuring the sending of notification emails

The last step is the configuration of sending emails with the Exim4 email service located on the ServiceNav Box.

To configure the sending of e-mail notifications, type "y" and then 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:

  • Live configuration

Here's what you need to answer the questions:

Configuration type:

  • Direct distribution by SMTP (Website)

System email name:

  • en

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

  • 127.0.0.1

Other destinations for which email must be accepted:

  • (blank)

Areas to be relayed:

Relay machines:

  • 127.0.0.1

Should DNS queries (connections on demand?) be minimized?

  • No

Method of delivering local mail:

  • Format in /var/mail

Is it necessary to separate the configuration into several files?

  • No

 

  • Configuration via a relay server

Here's what you need to answer the questions:

Configuration type:

  • Sending via relay (smarthost) - no local mail

System email name:

  • en

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

  • 127.0.0.1

Other destinations for which email must be accepted:

  • (blank)

Domain name visible to local users :

Network name or IP address of the smarthost system :

  • x.x.x (@IP of the relay mail server)

Areas to be relayed:

  • en

Relay machines:

  • 127.0.0.1

Should DNS queries (connections on demand?) be minimized?

  • No

Is it necessary to separate the configuration into several files?

  • No

Once the configuration is complete, the service restarts:

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

 

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

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

 

3.3.5 End of configuration

To exit the installer press a key:

Press any key to exit

 

3.3.6 Synchronization with a time server

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

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

3.3.7 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
  • Uppercase/lowercase/numbers/character uniqueness

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 the ServiceNavBox without a network connection.

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

passwd

 

Warning 2 Save the password in your production repository.

4 Configuring ServiceNav Box supervision

The objective is to put in place the necessary environment to supervise the proper functioning of the recently deployed ServiceNav Box.

4.1 Supervision of the ServiceNav Box system

Test if the box is working properly in its system:

  • Launching 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-Recenting

ServiceNav-Configuration-Equipment-Recenting-Account

Expected outcome : the census ends correctly a piece of equipment is found.
- Add equipment 127.0.0.1 with the name " ", the snmp community: " coservit " and apply to it the equipment category: " Viadéis™ Services Box " then the model: "Viadeis Services Box - Self-Supervision

ServiceNav-AdditionEquipment

Verify that the SNMP supervision account is : coservit under the tab Accounts

- Reload the configuration of the new ServiceNav Box
- Check the data feedback on the ServiceNav website

4.2 Supervision of the proper functioning of the ServiceNav Box

Allows you to know if the ServiceNav Box can be reached from the platform and if it is uploading information.
- Add a piece of equipment with the name: " Supervision of name.
ServiceNav-AddBoxSupervision

  • Enter IP VPN IP in IP/DNS Address
  • Choose the shared supervision server (VSM) hosted at your home. Please note that the ServiceNav Box must not supervise itself under any circumstances, as you will not be notified in the event of an incident. In this example you would have to choose a different box than SNM-PARTNER for the "Monitored since" field.
  • Select equipment category "Viadéis Services Box ». Apply the equipment model: " Viadéis Services Box - Supervision by supervisor "VSBox-Live-Status" service must now be configured with the name of the ServiceNav Box: this service supervises that the ServiceNav Box reports back the information (status, status information) displayed in the technical operation of the ServiceNav website.

ServiceNav-ServiceBoxLiveStatus

Put the of the ServiceNav Box to be supervised in the chanmp " Name of the box ".
Once the configuration is done you need to generate it to send it to the ServiceNav Boxes.

5 Annexes

5.1 Manual network configuration

a) Fixed IP address (preferred configuration)

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

nano /etc/network/interfaces

Edit the :

auto eth0
 iface eth0 inet static
 address x.x.x
 netmask x.x.x.x.x.x.x
 gateway x.x.x
 dns-nameservers x.x.x.x x.x.x.x.x.x.x.x

Create/edit :

nano /etc/resolv.conf

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

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

Edit the following file :

nano /etc/network/interfaces

To assign it a DHCP address, add at the end of the :

auto eth0
 iface eth0 inet dhcp

 

This may also be of interest to you

tel1

Ensuring and maintaining the availability of ServiceNav Boxes

install script

Preparing for ServiceNav Box DR

Configuring a ServiceNav Box to use a mail server with authentication

Welcome to ServiceNav!

Need help? More information about our products? Write to us!
You have taken note of our privacy policy.

[COVID - 19 ] - TELEWORKING, TARGET AVAILABILITY 100% !

While the epidemic lasts, ensure the availability and performance of your IT services for teleworking, with ServiceNav!

Following the government's call to mobilize to help businesses overcome the current health and economic context, we help you, free of charge, to ensure the complete monitoring of your teleworking environments: VPN, VDI, Teams, Skype Enterprise, Citrix... Objectives: collection, availability and usage indicators, dashboards to support your communication.
We use cookies to ensure that you have the best possible experience on our site, and 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.