Documentation ServicePilot

ServicePilot OnPremise

Déploiement ServicePilot

Il y a deux modes d'accès à ServicePilot :

  • Software as a Service : interface web ServicePilot basée dans le cloud et gérée par ServicePilot Technologies, à laquelle les clients se connecteront via Internet. Seul un agent minimum est nécessaire pour la supervision.
  • On Premise : les clients installent le logiciel ServicePilot sur site.

Ce document est destiné aux installations On Premise de ServicePilot où un administrateur local devra installer, mettre à jour, sauvegarder et gérer le serveur ServicePilot.

Installer ServicePilot

Configuration système pour le Manager ServicePilot

Avant d'installer ServicePilot, vérifiez que votre système répond à certaines exigences de base.

Contactez ServicePilot Technologies pour plus de détails si besoin.

Voici les pré-requis minimums pour système de supervision basique. Un matériel ou des machines virtuelles plus puissants seront nécessaires en fonction de la quantité de données à collecter et de l'utilisation simultanée prévue.

  • 8 core CPU
  • 8GB RAM min
  • Disque dur haute performance avec suffisamment d'espace pour stocker les données de ServicePilot - min 250GB
  • Serveur Windows 2016 ou plus

Installer ServicePilot

Pour les installations sur site de ServicePilot, téléchargez le logiciel Manager ServicePilot et installez-le sur votre propre serveur Windows.

  • Téléchargez le fichier exécutable sur portail client du site web de ServicePilot Technologies. Les ingénieurs de ServicePilot peuvent également fournir le programme d'installation si vous testez la solution ServicePilot.

  • Suivez la vidéo Installer le Manager ServicePilot pour terminer l'installation du logiciel Manager ServicePilot.

Configuration système pour les Agents ServicePilot

Les agents ServicePilot ne nécessitent que très peu de CPU, de RAM et d'espace disque dur. Lors de l'installation du Manager ServicePilot, un ServicePilot Windows Agent est automatiquement installé sur le même serveur. Cela peut être suffisant pour superviser les systèmes sur le réseau local de l'entreprise, mais d'autres agents ServicePilot peuvent être installés pour obtenir des données à partir de sites et de serveurs distants.

En tant qu'utilisateur Administrateur de ServicePilot, pour obtenir les pré-requis de l'Agent, le téléchargement et les instructions d'installation, allez dans Paramètres > Agents > Télécharger.

Installer les Agents ServicePilot

Pour installer un Agent ServicePilot en tant qu'utilisateur administrateur de ServicePilot, pour obtenir les pré-requis de l'Agent, le téléchargement et les instructions d'installation, allez dans Paramètres > Agents > Télécharger.

Vous pouvez suivre la vidéo Installer l'agent ServicePilot pour installer les agents ServicePilot qui collecteront et enverront les données au Manager ServicePilot.

Activer le support HTTPS avec des certificats SSL

L'interface web de ServicePilot peut être servie par HTTPS en activant cette possibilité dans la configuration en cours et en redémarrant le Manager ServicePilot. Vous pouvez soit générer votre propre certificat, soit en acheter un auprès d'une autorité commerciale de certification.

Remarque: les agents ServicePilot communiquent avec le ServicePilot Manager à l'aide de HTTP ou HTTPS. Si HTTPS est activé ou si le port d'interface Web du Manager ServicePilot est modifié, tous les agents ServicePilot doivent également être reconfigurés et redémarrés.

Une fois le certificat, la clé privée du certificat et la chaîne de certificat d'AC obtenus, vous devez mettre à jour votre serveur pour les utiliser. Suivez ces étapes pour activer le support SSL :

  1. Procurez-vous ou convertissez votre certificat de serveur, votre clé privée et votre chaîne de certificat d'AC en un fichier PKCS12/PFX protégé par mot de passe
  2. Importez le certificat dans le Magasin Certificat Personnel de l'ordinateur local. Si le certificat est importé correctement il sera visible dans l'application certlm.msc avec un certification et l'icône d'une clé.
  3. Ouvrez le "ServicePilot Setup Console" et cliquez sur le bouton Certificates.
  4. Double-cliquez sur le certificat que vous avez importé visible dans la liste s'il peut être utilisé. L'empreinte numérique du certificat sera copiée dans le champ "Thumbprint". Cliquez sur OK pour sauvegarder le changement.
  5. Ouvrez l'interface Web de ServicePilot et connectez-vous en tant qu'administrateur
  6. Cliquez sur Paramètres > Configuration
  7. Cliquez sur Basique
  8. Cliquez sur Autres paramètres > Editer la configuration
  9. Cliquez sur le bouton Expand
  10. Ajoutez les informations suivantes à la section general: :
  11. Sauvegardez la configuration en utilisant le bouton Enregistrer
  12. Redémarrez le ServicePilot Manager à l'aide du bouton Redémarrer
  13. Une fois le Manager ServicePilot redémarré, essayez de vous connecter à l'interface Web à l'aide du protocole HTTPS

Configurer les agents ServicePilot pour HTTPS

Tous les Agents ServicePilot doivent être configurés pour utiliser la communication nouvellement sécurisée. Sur chaque ordinateur doté d'un agent ServicePilot, y compris le serveur sur lequel le gestionnaire de service est installé, exécutez la procédure suivante :

Windows

  1. Ouvrez le "ServicePilot Setup Console" ("C:\Program Files (x86)\ServicePilot\ServicePilot ISM Enterprise\Console.exe")
  2. Aller à l'onglet Agent
  3. Arrêtez l'Agent ServicePilot
  4. Définir le numéro de port correct (par défaut 443)
  5. Cochez la case HTTPS
  6. Démarrez l'Agent ServicePilot

Linux

  1. Arrête le daemon splinuxagent
  2. Editez le fichier de configuration de l'agent /etc/spagent/spagent.conf pour inclure le port correct et indiquez que HTTPS est utilisé
  3. Démarrez le daemon splinuxagent

Gestion de ServicePilot

Démarrer ou arrêter les services de ServicePilot

Windows

Les services du Manager ServicePilot et des Agents ServicePilot peuvent être démarrés et arrêtés à l'aide du "ServicePilot Setup Console" fournie. Ces services seront automatiquement démarrés au démarrage. Cette console peut également effectuer la configuration initiale et permet à l'administrateur de voir l'état des composants de ServicePilot.

Démarrer le "ServicePilot Setup Console"

Si la "ServicePilot Setup Console" n'est pas en cours d'exécution, elle peut être lancée en exécutant, avec des privilèges d'administration escaladés, C:\Program Files (x86)\ServicePilot\ServicePilot ISM Enterprise\Console.exe.

La "ServicePilot Setup Console" peut être exécutée à partir de l'icône ServicePilot ISM dans la barre d'état en sélectionnant Lancer la console.

Arrêtez et démarrez le ServicePilot Manager à partir de l'onglet Manager.

Arrêtez et démarrez l'Agent ServicePilot à partir de l'onglet Agent.

Linux

L'agent ServicePilot s'enregistre comme un daemon Linux. Démarrez et arrêtez le daemon splinuxagent en utilisant les commandes standard basées sur votre distribution Linux.

Configurer les paramètres d'emails sortant

Pour pouvoir envoyer des alertes par email, ServicePilot a besoin d'un relais SMTP sortant configuré.

Pour configurer un serveur d'emails :

  1. Connectez-vous à l'interface Web du Manager ServicePilot en tant qu'administrateur.
  2. Cliquez sur PARAMÈTRES > Configuration, puis Basique, et ensuite cliquez sur Serveur email.
  3. Définissez le nom d'hôte du serveur SMTP, l'adresse e-mail De et l'adresse e-mail Vers.
  4. Cochez la case Fonctions avancées pour ajouter d'autres paramètres de serveur SMTP qui pourraient être nécessaires.
  5. Cliquez sur Enregistrer pour enregistrer vos modifications.
  6. Cliquez sur Test pour faire apparaître une boîte de dialogue de test vous permettant d'envoyer des e-mails de test pour vérifier votre connexion.

Dépannage des problèmes SMTP

Certains serveurs de messagerie nécessitent maintenant plus d'authentifications avant d'accepter d'envoyer des emails. Vous devrez peut-être activer une méthode d'accès moins sécurisée ou fournir un mot de passe spécifique à votre application pour permettre à ServicePilot d'envoyer des e-mails.

Actualiser la configuration

Pour actualiser des changements faits sur packages, il existe les deux méthodes suivantes :

Utilisation de l'interface ServicePilot

  1. Connectez-vous à l'interface Web du Manager ServicePilot en tant qu'administrateur
  2. Cliquez sur PARAMÈTRES > Configuration, puis Avancé, et ensuite cliquez sur Recharger

Utilisation de l'API ServicePilot

L'API permet d'actualiser la configuration automatiquement sans avoir besoin de redémarrer ServicePilot. La commande cURL ci-dessous est un exemple de requête utilisant la clé API avec des droits d'écriture 10000000-0000-0000-0000-000000000000 vers le serveur ServicePilot https://data.servicepilot.com.

curl -H "X-Api-Key: 10000000-0000-0000-0000-000000000000" -d "{}" -X POST "https://data.servicepilot.com/api/service/reload"

Sauvegarde et restauration de ServicePilot

Sauvegarde de la configuration et données de ServicePilot

ServicePilot sauvegarde automatiquement la configuration et les données au même endroit que la configuration et la base de données en cours. Les clients peuvent copier ces sauvegardes sur un autre serveur ou prendre un instantané du disque comme ils le souhaitent.

Faire une sauvegarde complète de ServicePilot (configuration et données)

ServicePilot effectue automatiquement des sauvegardes de la configuration et des données pouvant être copiées sur le serveur du Manager ServicePilot. Cependant, la configuration personnalisée du client doit être incluse pour créer une sauvegarde complète.

Sauvegarde de la configuration ServicePilot

Pour créer une sauvegarde de la configuration, copiez les fichiers et répertoires suivants :

  • La clé de licence ServicePilot, la clé d'activation, les certificats du serveur et les autres paramètres du "ServicePilot Setup Console".
  • <WorkFolder>\Conf
  • <WorkFolder>\Packages
  • <WorkFolder>\Pictures
  • <WorkFolder>\Web

Sauvegarde des données de ServicePilot

Les données ServicePilot sont enregistrées dans le WorkFolder de la configuration en cours d'exécution. Sauvegardez les répertoires suivants :

  • <WorkFolder>\Backup
  • <WorkFolder>\Pdf

Restaurer la configuration de ServicePilot

Suivez ces étapes :

  1. Installez ServicePilot, s'il n'est pas déjà en place
  2. Arrêtez le Manager ServicePilot
  3. Restaurez toute la configuration dans un nouveau WorkFolder vide
  4. Définissez le WorkFolder de configuration dans "ServicePilot Setup Console" vers le répertoire récemment restauré
  5. Démarrez le Manager ServicePilot

Restaurer les données de ServicePilot

Les données du ServicePilot sont automatiquement restaurées dans la base de données à partir des fichiers de sauvegarde sous <WorkFolder>\Backup.

Remarque : la restauration des données se fait en arrière-plan et prend plusieurs jours.

Pour voir l'état actuel de la base de données :

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Cliquez sur Outils > Widget > Database
  3. La colonne DB History de la table Collection Status indique le nombre de jours d'historique actuellement présents dans la base de données.

Changer la durée de rétention des données de sauvegarde

La source originale des données de la base de données ServicePilot est stockée dans le répertoire <WorkFolder>\Backup. Cela peut être nécessaire si la base de données est corrompue ou si ServicePilot modifie le format de la base de données. Les sources de la base de données ServicePilot sont conservées sur disque pendant 1 an et un mois par défaut. Ce paramètre peut être modifié dans le fichier de configuration <WorkFolder>\Conf\servicepilotdb.conf.

# Backup retention duration
RETENTIONBACKUP=90

Les sources de sauvegarde des bases de données peuvent-elles être supprimées ?

Les anciennes données dans le répertoire <WorkFolder>\Backup peuvent être supprimées mais cela peut être nécessaire si la base de données est corrompue ou si ServicePilot change le format de la base de données. Supprimez manuellement les fichiers ZIP source si les fichiers ne sont pas nécessaires à la restauration. Par exemple, les fichiers objectdata_*.zip datant de plus d'une semaine ne sont normalement pas nécessaires car la base de données de ServicePilot ne conserve ces données que pendant une semaine selon le paramètre <WorkFolder>\Conf\servicepilotdb.conf RETENTIONOBJECTDATA.

Modifier la durée de rétention des données de la base de données

ServicePilot ne conserve les données dans sa base de données que pendant une durée limitée. Cela dépend du type de données stockées. Par exemple, les données de l'indicateur d'objet sont conservées pendant 7 jours avec une résolution de 1 minute, alors que les données de l'indicateur quotidien Summary sont conservées pendant un an. Ces paramètres peuvent être modifiés dans le fichier de configuration <WorkFolder>\Conf\servicepilotdb.conf.

Les durées de rétention par défaut sont les suivantes

# Event log retention duration
#RETENTIONEVENTS=90
# IP Flow retention duration
#RETENTIONNETTRACE=30
# AppTrace data retention duration
#RETENTIONAPPTRACE=7
# General object log retention duration
#RETENTIONOBJECTLOG=30
# General object data retention duration
#RETENTIONOBJECTDATA=7
# Quarter object data retention duration
#RETENTIONOBJECTDATAQ=30
# Hour object data retention duration
#RETENTIONOBJECTDATAH=365
# RCA retention duration
#RETENTIONOBJECTRCA=365
# Trap retention duration
#RETENTIONTRAP=60
# Syslog retention duration
#RETENTIONSYSLOG=60
# ObjectSL retention duration
#RETENTIONOBJECTSL=90
# ObjectSLD retention duration
#RETENTIONOBJECTSLD=365
# VoIP event retention duration
#RETENTIONVOIP=90

Mise à jour vers une nouvelle version de ServicePilot

Il est fortement recommandé de créer une sauvegarde avant de commencer le processus de mise à jour. Une sauvegarde rapide consiste à arrêter ServicePilot et à faire une copie complète du WorkFolder de la configuration en cours d'exécution.

Important : demandez à ServicePilot Technologies si le format de la base de données a changé avant de commencer une mise à jour. Une sauvegarde de la configuration et des données de ServicePilot sera nécessaire dans ce cas.

Afin de mettre jour le logiciel ServicePilot :

  1. Arrêtez le Manager et l'agent ServicePilot
  2. Arrêtez le "ServicePilot Setup Console"
  3. Arrêtez l'icône ServicePilot ISM dans de la barre des tâches
  4. Exécutez le nouveau programme d'installation de ServicePilot
  5. Installez le service du Manager ServicePilot dans le "ServicePilot Setup Console"
  6. Démarrez le Manager ServicePilot

Personnaliser ServicePilot

Ajouter des images personnalisées à ServicePilot

ServicePilot présente des pages Web pouvant contenir des icônes et des graphiques clients.

Des images peuvent être uploadées lors de l'ajout de ressources dans la configuration.

Il est également possible de placer des images personnalisées, au format JPEG, GIF, PNG ou SVG, dans le répertoire <WorkFolder>\Pictures de la configuration d'exécution. Un fichier logo.png placé dans ce répertoire sera utilisé comme logo de l'entreprise pour les rapports PDF.

Ajouter des pages Web personnalisées à ServicePilot

Le Manager ServicePilot peut diffuser des pages Web personnalisées vers les utilisateurs de l'interface Web de ServicePilot si les fichiers HTML sont placés dans le répertoire de configuration <WorkFolder>\Web.

Ajouter des packages personnalisés à ServicePilot

ServicePilot est livré avec de nombreux packages intégrés. La configuration de ServicePilot peut personnaliser la façon dont ces modèles sont utilisés pour superviser les ressources. Il est possible d'étendre les fonctionnalités de ServicePilot en utilisant des packages personnalisés pour les équipements nouveaux ou spécialisés.

Les packages personnalisés sont créés par ServicePilot Technologies et sont appliqués en les plaçant dans le répertoire de configuration <WorkFolder>\Packages de la configuration d'exécution. La configuration d'exécution de ServicePilot doit être rechargée pour que les nouveaux packages personnalisés puissent être utilisés. Pour recharger la configuration en cours d'exécution :

  1. Cliquez sur PARAMÈTRES > Configuration
  2. Cliquez sur Avancé
  3. Cliquez sur Packages > Recharger

Debug

Déboguer les erreurs ServicePilot

ServicePilot Manager et l'agent Windows ServicePilot stockent leurs fichiers logs dans le répertoire C:\Program Files (x86)\ServicePilot\ServicePilot ISM Enterprise\Logs. L'agent Linux ServicePilot stocke ses logs dans le fichier/var/log/servicepilotagent.log.

Consultez ces fichiers pour les erreurs de configuration ou de communication entre les composants ServicePilot et les périphériques surveillés. Souvent, les mots de passe, les adresses IP ou les numéros de port sont mal configurés lors de l'ajout d'équipement surveillé. Vérifiez ces logs pour voir ces erreurs d'accès.

Erreurs de page web 429 dans ServicePilot

Si ServicePilot renvoie des codes d'erreur HTTP 429 lors de l'affichage de pages Web, cela indique normalement que la base de données ServicePilot est surchargée. Trop de personnes essaient d'obtenir des informations ou trop de requêtes complexes concurrentes sont faites sur le système. Veuillez patienter et réessayer plus tard.

Il s'agit d'une fonction de sécurité supplémentaire qui peut aider à se protéger contre les attaques par déni de service (D/DOS).

Installation gratuite en quelques clics