Guide de référence de Veritas NetBackup™ WebSocket Service (NBWSS)

Last Published:
Product(s): NetBackup & Alta Data Protection (8.1)
  1. Utilisation de NetBackup WebSocket Service (NBWSS) pour la communication avec une application cloud
    1.  
      A propos du NetBackup WebSocket Service (NBWSS)
    2.  
      Présentation de la tâche de configuration de la communication NBWSS
    3.  
      Remarques sur les connexions de NetBackup aux applications cloud
    4.  
      Formats de message NBWSS
    5.  
      Appels d'API sur NBWSS
    6.  
      Notifications de NBWSS
    7. Exemples de messages NBWSS
      1.  
        NetBackup demande une connexion au terminal client
      2.  
        L'application cloud demande d'effectuer un appel REST API
      3.  
        Messages de notification de NetBackup pour un travail de sauvegarde
      4.  
        Autres messages de notification NetBackup
  2. Configuration des terminaux client WebSocket pour NBWSS
    1.  
      A propos des connexions de NetBackup aux terminaux client WebSocket
    2.  
      Informations du terminal client WebSocket et son formatage
    3.  
      Enregistrement des informations d'authentification de NetBackup pour un terminal client de serveur WebSocket
    4.  
      Boîte de dialogue de Serveur WebSocket
    5.  
      Suppression des informations d'authentification de NetBackup pour un terminal client de serveur WebSocket
    6.  
      Configuration des propriétés de NetBackup WebSocket Service (NBWSS)
    7.  
      Démarrage d'une connexion de NetBackup à une application cloud
  3. Dépannage NBWSS
    1.  
      Consignation de NBWSS
    2. Problèmes NBWSS
      1.  
        Des problèmes de validation du serveur de terminal client dans la boîte de dialogue WebSocket Server
      2.  
        Problèmes d'enregistrement des informations d'authentification dans la boîte de dialogue Serveur WebSocket
      3.  
        Problèmes de suppression de terminal client du serveur WebSocket à partir de NetBackup
      4.  
        Problèmes d'affichage de la liste des serveurs WebSocket qui ont été ajoutées dans NetBackup
      5.  
        Problèmes d'activation ou de désactivation du serveur de terminal client
      6.  
        Problèmes NBWSS supplémentaires

Configuration des propriétés de NetBackup WebSocket Service (NBWSS)

Tableau : Propriétés configurables de NBWSS décrit les propriétés configurables de NBWSS et leurs valeurs par défaut. Les propriétés sont dans le fichier texte nbwss.properties sur le serveur maître NetBackup. (Pour l'emplacement de ce fichier, consultez la procédure dans cette rubrique.)

Chaque propriété apparaît sur une seule ligne sous la forme suivante :

clé=valeur

Un exemple de fichier .properties est inclus après le tableau. Pour modifier les propriétés, utilisez la procédure à la fin de cette rubrique.

Tableau : Propriétés configurables de NBWSS

Clés

Description

exception.ignoreDecoder

Valeur booléenne

Détermine si NBWSS ignore ou pas une exception de décodeur. Une exception de décodeur se produit généralement lorsque NBWSS ne peut pas comprendre un message qu'il reçoit.

Le paramètre par défaut est faux : NBWSS ferme la connexion quand une exception de décodeur se produit.

notification.sendTimeout=

Nombre entier

Détermine combien de temps (en millisecondes) NBWSS attend pour communiquer avec un terminal client (pour envoyer ou recevoir une notification). Par défaut, une tâche de notification attend 2 secondes avant que la tâche se termine. La tâche de notification essaye à nouveau après le délai que la propriété notification.scheduledRate définit.

Le paramètre par défaut est 2 000 millisecondes (2 secondes).  Dans la plupart des cas, Veritas recommande le paramètre par défaut.

notification.scheduledRate=

Nombre entier

Détermine la fréquence (en secondes) à laquelle NetBackup demande de nouvelles notifications. Cette valeur détermine également combien de temps NetBackup attend pour recevoir un accusé de réception d'une notification avant de renvoyer la notification.

La valeur par défaut est de 5 secondes.

keepAlive.scheduledRate=

Nombre entier

Détermine la fréquence (en secondes) à laquelle NBWSS envoie une commande ping à chaque terminal client en tant qu'élément de ses fonctionnalités de persistance de connexion. Si NetBackup reçoit une commande pong en réponse à chaque commande ping, la connexion du terminal client est toujours valide.

La valeur par défaut est de 30 secondes.

keepAlive.maxPongMissAllowed=

Nombre entier

Détermine combien de pongs (réponses aux commandes ping) peuvent être manqués pour une connexion de terminal client. Lorsque NBWSS envoie une commande ping à un terminal client et que pong n'est pas reçu, il est considéré comme un pong manqué. Quand le maximum est atteint, NBWSS ferme la connexion au terminal client.

Le paramètre par défaut est de 10 pongs manqués.

connectionInfo.period=

Nombre entier

Détermine le nombre de secondes entre chaque mise à jour de la connexion NBWSS. Chaque mise à jour détermine les terminaux client qui sont actuellement configurés dans NetBackup, et se connecte aux nouveaux terminaux client ou se déconnecte des terminaux client qui n'existent plus.

Remarque :

Après avoir ajouté un terminal client, il peut prendre jusqu'à la durée configurée pour se connecter à ce terminal client.

La valeur par défaut est de 60 secondes.

scheduledExecutor.threadPoolSize=

Nombre entier

Détermine le nombre de threads que NetBackup utilise pour maintenir la connexion de terminal client et pour traiter les notifications.

Le paramètre par défaut est 1 thread. Il peut être utile d'augmenter cette valeur si le nombre de tâches planifiées augmente.

Les propriétés mise en veille prolongée

Ces propriétés sont pour l'utilisation de la prise en charge Veritas.

Voici le fichier nbwss.properties avec ses paramètres par défaut (voir la procédure suivante pour l'emplacement de ce fichier) :

#Properties file for NetBackup WebSocket Service
exception.ignoreDecoder=false
notification.sendTimeout=2000
notification.scheduledRate=5
keepAlive.scheduledRate=30
keepAlive.maxPongMissAllowed=10
connectionInfo.period=60
scheduledExecutor.threadPoolSize=1

#Hibernate properties
hibernate.format_sql=true
hibernate.show_sql=false
hibernate.hbm2ddl.auto=update
hibernate.dialect=org.hibernate.dialect.SybaseDialect

Pour configurer les propriétés de NetBackup WebSocket Service (NBWSS)

  1. Utilisez un éditeur de texte pour ouvrir le fichier nbwss.properties.

    Le fichier se trouve dans l'emplacement suivant sur le serveur maître NetBackup :

    Sous Windows :

    install_path\NetBackup\wmc\webserver\webapps_api\
    nbwss\WEB-INF\classes\nbwss.properties

    Sous Linux :

    /usr/openv/wmc/webserver/webapps_api/nbwss/WEB-INF/classes/
    nbwss.properties
  2. Modifiez la valeur de la propriété que vous voulez changer et enregistrez le fichier.

    Tableau : Propriétés configurables de NBWSS décrit les propriétés NBWSS et leurs valeurs par défaut.

  3. Pour que les modifications entrent en vigueur, il est possible qu'il faille redémarrer le service Console de gestion Web NetBackup sur le serveur maître NetBackup.

Se reporter à Démarrage d'une connexion de NetBackup à une application cloud.