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

Notifications de NBWSS

Lorsque NetBackup est connecté à un terminal client NBWSS, le terminal client reçoit des notifications à partir de NetBackup sous la forme d'un message NOTIFICATION REQUEST. Lorsque le terminal client reçoit la notification, le terminal client doit répondre par un message NOTFICATION RESPONSE.

Tableau : Types de notification de NetBackup décrit les types de notifications que NetBackup envoie.

Tableau : Types de notification de NetBackup

Types de notification

Description

Notifications de travail NetBackup

Quand un travail démarre, NetBackup envoie une notification de l'état actuel du travail : "QUEUED", "ACTIVE", ou "DONE". Notez que NetBackup interroge à propos de l'état du travail de manière régulière.

Quand un travail se termine, NetBackup envoie une notification indiquant que l'état du travail est "DONE". NetBackup émet cette notification, si le travail a réussi ou a échoué.

Notifications d'image de sauvegarde de NetBackup

Quand NetBackup crée une image de sauvegarde, il émet une notification selon laquelle l'état de l'image est "CREATE" ou "UPDATE".

Quand une image de sauvegarde est mise à jour, NetBackup envoie une notification selon laquelle l'état de l'image est "UPDATE".

Quand une image de sauvegarde est supprimée, NetBackup envoie une notification selon laquelle l'état de l'image est "DELETE".

Quand une copie d'image expire, si toutes les copies locales restantes sont des copies de réplique qui ne peuvent pas être restaurées, NetBackup envoie la notification "NO_LOCAL_COPY_AVAILABLE".

Format de message de notification

A. Demande de notification

NetBackup envoie des notifications à un terminal client sous la forme d'un message NOTIFICATION REQUEST. Ce message peut avoir une ou plusieurs notifications au sein de sa charge utile.

Ce qui suit est un exemple de demande de notification :

{
      "version": "1.0",
      "id": "EDD85CD7-8553-47E4-8A19-01C65092F220",
      "type": "NOTIFICATION",
      "subType": "REQUEST",
      "timeStamp": 1459811679,
      "payload": [
            {
                  "notificationType": "INFO",
                  "object": "JOB",
                  "data": [
                        {
                              "scheduleType": "ST_FULL",
                              "clientName": "mserver2.acme.com",
                              "status": 0,
                              "startTime": 1459829674,
                              "state": "ACTIVE",
                              "policyName": "vmware2",
                              "parentJobId": 144,
                              "jobId": 144,
                              "policyType": "VMWARE",
                              "jobType": "BACKUP"
                        }
                  ]
            }
      ]
}

Dans les messages de demande, le type de valeur "payload" est une baie de disques. Chaque élément de la baie contient un type d'objet de notification différent ("JOB" ou "IMAGE"). L'élément a toutes les notifications qui sont liées à ce type d'objet. Cette baie de disques permet à NetBackup de regrouper les notifications d'un même type.

Par exemple, pour début du travail et travail effectué, la charge utile dispose d'un élément : un objet de notification de type "JOB". Dans la section des données de l'objet de notification "JOB", il y a deux éléments, un pour chaque notification. Pour un exemple de notifications par lots dans un seul message, consultez « Plusieurs notifications dans un seul message » dans la rubrique suivante :

Se reporter à Autres messages de notification NetBackup.

Chaque objet de notification possède les champs suivants :

  • notificationType :

    Une chaîne qui affiche le type de notification. Dans cette version, le seul type est "INFO".

  • objet :

    Une chaîne qui affiche l'objet de la notification. Dans cette version, les seuls objets sont "JOB" et "IMAGE".

  • données :

    Une baie de disques qui contient les informations pour chaque type d'objet. Chaque élément de baie de disques de données est une notification séparée. Les champs de la baie de disques de données sont spécifiques à chaque type de notification.

    Se reporter à Exemples de messages NBWSS.

B. Réponse de notification

Pour chaque demande de notification, un message NOTIFICATION RESPONSE est attendu. Le champ "id" de cette réponse doit être identique à la "id" de la demande et le champ "payload" doit être un tableau vide.

Par exemple :

 {
      "version": "1.0",
      "id": "EDD85CD7-8553-47E4-8A19-01C65092F220",
      "type": "NOTIFICATION",
      "subType": "RESPONSE",
      "timeStamp": 1445036999,
      "payload": []
}

Quand NetBackup reçoit la réponse, les notifications qui ont été envoyées au sein de la demande sont considérées comme reconnues et les nouvelles notifications peuvent être envoyées dans le cas où elles se produisent. Si une demande de notification n'est pas reconnue dans le délai configuré, la notification est renvoyée. Aucune nouvelle notification n'est envoyée à ce terminal client jusqu'à ce que la notification soit reconnue.

La période de temps peut être configurée dans le fichier nbwss.properties au moyen de l'option notification.scheduledRate. La valeur par défaut est de 5 secondes. La rubrique suivante contient plus d'informations sur les options dans le fichier nbwss.properties :

Se reporter à Configuration des propriétés de NetBackup WebSocket Service (NBWSS).

Garantie de livraison

Pour éviter les problèmes de livraison, NetBackup garantit la livraison de notifications envoyées dans les cas suivants : la connexion entre NetBackup et le terminal client est abandonnée, le serveur du terminal client est hors ligne ou un problème se produit avec les Services Web de NetBackup. Si un serveur de terminal client est hors ligne, les notifications atteignent le serveur du terminal client suivant dans le groupe de serveurs.

Se reporter à Remarques sur les connexions de NetBackup aux applications cloud.