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

Last Published:
Product(s): NetBackup & Alta Data Protection (8.1.1)
  1. Utilisation de NetBackup WebSocket Service (NBWSS) pour la communication avec une application cloud
    1.  
      Mises à jour de ce guide pour NetBackup 8.1.1
    2.  
      Documentation supplémentaire sur les API NetBackup
    3.  
      A propos du NetBackup WebSocket Service (NBWSS)
    4.  
      Présentation de la tâche de configuration de la communication NBWSS
    5.  
      Remarques sur les connexions de NetBackup aux applications cloud
    6.  
      Formats de message NBWSS
    7.  
      Appels d'API sur NBWSS
    8.  
      Notifications de NBWSS
    9. 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

Informations du terminal client WebSocket et son formatage

Pour communiquer avec une application basée sur le cloud, NetBackup utilise le protocole WebSocket pour établir une connexion sécurisée avec l'application cloud. NetBackup se connecte à une interface d'application cloud qui est appelée terminal client WebSocket. Pour vous connecter, NetBackup a besoin de certaines informations concernant le terminal client.

Tableau : Entrées qui définissent un terminal client WebSocket décrit les informations qui sont requises pour un terminal client WebSocket.

Tableau : Entrées qui définissent un terminal client WebSocket

Détails du terminal client

Description

jeton

Le jeton de sécurité de l'application cloud.

Quand NetBackup lance une connexion à l'application cloud, il envoie le jeton à l'application. L'application valide alors le jeton. Si l'application accepte le jeton, une connexion sécurisée est établie entre NetBackup et l'application. Si l'application n'accepte pas le jeton, la connexion n'est pas établie.

priorité

Priorité du terminal client dans son groupe. Un nombre inférieur a priorité plus élevée.

La priorité permet à NetBackup de décider de l'ordre de la tentative de connexions pour ce groupe de serveurs. Une seule connexion peut être active par groupe de serveurs.

groupId

Un identificateur unique du groupe auquel appartient le terminal client.

hostname

Le nom d'hôte ou l'adresse IP du serveur cloud qui contient le terminal client.

url

L'URL complète du terminal client WebSocket à laquelle NetBackup se connecte.

L'URL WebSocket commence parwss://

Remarque :

ws:// n'est pas pris en charge.

IMPORTANT : Il est possible que vous deviez travailler avec le fournisseur de services cloud pour obtenir les informations du terminal client. Les informations du terminal client doivent être disponibles pour NetBackup d'une des manières suivantes :

  • Dans un fichier qui est formaté dans JavaScript Object Notation (un fichier JSON). Si le fournisseur de services ne fournit pas les informations du terminal client dans un fichier JSON, vous pouvez vous-même formater les informations dans un fichier JSON.

    Remarque :

    Les informations du terminal client doivent inclure un jeton de sécurité pour accéder à l'application cloud. Le fournisseur de services doit faire attention d'envoyer le jeton d'application de façon sécurisée.

  • Au moyen d'une URL. NetBackup utilise l'URL pour demander les détails du terminal client à partir de l'application cloud.

Remarque :

NetBackup ne prend pas en charge une apostrophe (') n'importe où dans les informations du terminal client.

Informations du terminal client WebSocket dans un fichier JSON

L'exemple suivant montre les informations du terminal client WebSocket dans JavaScript Object Notation (JSON) :

{
      "token": "security_token ....",
      "priority": numeric_value,
      "groupId": "group_ID",
      "hostName": "host_name.domain", 
      "url": "wss://host_name.domain:port/uri"
}

Veuillez prendre en compte les éléments suivants :

  • Dans cette version de NetBackup, chaque fichier JSON doit spécifier un terminal client unique, pas plusieurs terminaux client.

  • Le fichier commence par une accolade gauche ({}) et se termine par une accolade droite (}).

  • Les entrées se composent de nom : valeurpaires sont séparées par une virgule.

  • Chaque chaîne est entre guillemets doubles (" ») excepté la valeur de priorité.

  • Les cinq paires nom : valeur (jeton,priorité,ID de groupe,nom d'hôte,URL) peuvent apparaître dans n'importe quel ordre.

  • NetBackup ne prend pas en charge une apostrophe (') n'importe où dans le fichier.

  • Enregistrez les informations au format JSON comme un fichier texte dans un emplacement auquel le serveur maître NetBackup peut accéder.

  • Pour la tâche de fond sur le formatage JSON, consultez la note de groupe de travail réseau sur JavaScript Object Notation :

    http://www.ietf.org/rfc/rfc4627.txt?number=4627

Ce qui suit est un exemple d'un fichier au format JSON qui définit un terminal client WebSocket :

{
      "token": "MIID4TCCAsmgAwIBAgIEBZCDRzANBgkqhkiG9w0BAQsFADBxMQs
DVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcx
vzu0n2rWon48ncp6jMjOFiWqMRXnV8Q0vOEpAzUV7Qml92EMV6z0PinAgMBAA
GjgYAwfjBdBgNVHREEVjBUgiJ2b21yaGVsNnU1LXZtMDQuZW5nYmEuc3ltYW
G7IsZ2fTDWKLGxbAG5NNKwEfD11LFhKGwaHkOXYkVi+HVnFEFKK0gxVWg==",
      "priority": 1,
      "groupId": "GROUPID1",
      "hostName": "vrhel6u5-vm4.acme.com",
      "url": "wss://vrhel6u5-vm4.acme.com:14146/cfs/nbufacade"
}

Remarques sur l'exemple de fichier JSON :

  • Cet exemple commence par le jeton. Le jeton est une chaîne que l'application cloud utilise pour authentifier NetBackup quand NetBackup demande une connexion.

    Attention :

    Lorsque vous obtenez les informations du terminal client à partir du fournisseur de services, assurez-vous que le jeton est fourni de façon sécurisée.

  • L'entrée suivante dans le fichier est la priorité, suivie par la groupID, le hostName et l'url du serveur cloud.

Lorsque vous avez le fichier au format JSON, utilisez l'option FICHIER sur la boîte de dialogue NetBackup Serveur WebSocket pour spécifier ce fichier. NetBackup extrait les informations du terminal client à partir du fichier. Utilisez la procédure suivante :

Se reporter à Enregistrement des informations d'authentification de NetBackup pour un terminal client de serveur WebSocket.

Informations du terminal client WebSocket obtenues via le Web

L'application cloud peut générer une URL que NetBackup peut utiliser pour demander les informations du terminal client WebSocket. Utilisez la procédure suivante pour saisir l'URL dans la boîte de dialogue Serveur WebSocket de NetBackup  :

Se reporter à Enregistrement des informations d'authentification de NetBackup pour un terminal client de serveur WebSocket.