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

L'application cloud demande d'effectuer un appel REST API

A. L'application cloud demande d'ajouter des informations à NetBackup à propos d'un serveur vCenter (POST)
{  
      "version": "1.0",
      "id": "99B9BD8C-9E3E-406A-A7EE-33B88531C7D9",
      "type": "COMMAND",
      "subType": "REQUEST",
      "timeStamp": 1444856264,
      "payload": {  
            "uri": "/netbackup/config/servers/vmservers",
            "method": "POST",
            "headers": {  
                  "Content-Type": "application/vnd.netbackup+json;version=1.0"
                  "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1N"
            },
            "parameters": "{\"serverName\": \"vcenterServer1\",
            \"proxyServerName\": \"\",\"vmType\": \"VMWARE_VIRTUAL_
            CENTER_SERVER\",\"userId\": \"administrator\",
            \"password\": \"password@123\",\"port\": 0 }"
      }
}

Remarques : la demande et sa réponse doivent toujours la même valeur pour « id ».

Le champ « type » est « COMMAND » et le champ « Sous-type » est « REQUEST ». La « méthode »« charge utile » est « POST » et elle ajoute les informations vcenterServer1 dans NetBackup.

Pour « Sous-type »« REQUEST », les « En-têtes » : doivent contenir les éléments suivants :

  • « Type de contenu » : « application/vnd.netbackup+json;version=1.0 » est le formulaire de la demande.

  • « Autorisation » est le jeton Web JSON (JWT) qui a été reçu dans une réponse précédente.

Le champ « paramètres » est une chaîne d'échappement JSON : les guillemets doubles autour de chaque valeur (tels que « serverName ») sont échappés avec une barre oblique inverse (\).

B. L'application cloud vous demande de lire des informations sur un serveur vCenter (GET)
{ 
      "version": "1.0",
      "id": "9CD2B89F-0BBF-4F60-974D-C1F3EF39B872",
      "type": "COMMAND",
      "subType": "REQUEST",
      "timeStamp": 1444806222,
      "payload": {
            "uri": "/netbackup/config/servers/vmservers/vCenter2
            .domain.com",
            "method": "GET",
            "headers": {
                  "Content-Type": "application/vnd.netbackup+json;version=1.0"
                  "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1N"
            }
      }
}

Remarques : le champ « type » est « COMMAND » et le champ « Sous-type » est « REQUEST ». La « méthode »« charge utile » est « GET » et lit les informations à propos de vCenter2.domain.com qui sont enregistrées dans NetBackup.

C. NetBackup répond à la demande du terminal client
{  
      "version": "1.0",
      "id": "9CD2B89F-0BBF-4F60-974D-C1F3EF39B872",
      "type": "COMMAND",
      "subType": "RESPONSE",
      "timeStamp": 1444806444,
      "payload": {  
            "headers": {  
                  "date": "Thu, 14 Jan 2016 20:58:11 GMT",
                  "cache-control": "private",
                  "server": "Apache-Coyote/1.1",
                  "content-type": "application/vnd.netbackup+json;version=1.0",
                  "transfer-encoding": "chunked",
                  "expires": "Wed, 31 Dec 1969 16:00:00 PST"
            },
            "responseCode": 200,
            "body": "{\"vmServer\":{\"serverName\":\"vCenter2.domain
            .com\",\"vmType\":\"VMWARE_VIRTUAL_CENTER_SERVER\",
            \"userId\":\"root\",\"password\":\"\",\"port\":0},
            \"links\":[{\"rel\":\"self\",\"href\":\"https://xuanbl5vm9:
            8443/config/servers/vmservers/vCenter2.domain.com\"}]}"
      }
}

Remarques :

La « charge utile » contient la réponse HTTP (« en-têtes », « code de réponse », et « corps du message ») que NetBackup a reçu de l'API.