Veritas NetBackup™ WebSocket サービス (NBWSS) リファレンスガイド

Last Published:
Product(s): NetBackup (8.1.1)
  1. NetBackup WebSocket サービス (NBWSS) を使用したクラウドアプリケーションとの通信
    1.  
      NetBackup 8.1.1 についての本ガイドの更新
    2.  
      NetBackup API に関する追加資料
    3.  
      NetBackup WebSocket サービス (NBWSS) について
    4.  
      NBWSS 通信を設定するためのタスクの概要
    5.  
      クラウドアプリケーションへの NetBackup 接続に関する注意事項
    6.  
      NBWSS メッセージの形式
    7.  
      NBWSS を介した API 呼び出し
    8.  
      NBWSS 通知
    9. NBWSS メッセージの例
      1.  
        NetBackup によるエンドポイントへの接続要求
      2.  
        クラウドアプリケーションによる REST API 呼び出し実行の要求
      3.  
        バックアップジョブの NetBackup 通知メッセージ
      4.  
        その他の NetBackup 通知メッセージ
  2. NBWSS に対する WebSocket エンドポイントの設定
    1.  
      WebSocket エンドポイントへの NetBackup 接続について
    2.  
      WebSocket エンドポイントの詳細とフォーマット
    3.  
      WebSocket サーバーエンドポイントの NetBackup クレデンシャルの保存
    4.  
      [WebSocket サーバー (WebSocket Server)]ダイアログ
    5.  
      WebSocket サーバーエンドポイントの NetBackup クレデンシャルの削除
    6.  
      NetBackup WebSocket サービス (NBWSS) のプロパティの設定
    7.  
      クラウドアプリケーションに対する NetBackup 接続の開始
  3. NBWSS のトラブルシューティング
    1.  
      NBWSS のログ記録
    2. NBWSS の問題
      1.  
        [WebSocket サーバー (WebSocket Server)]ダイアログでのエンドポイントサーバーの検証に関する問題
      2.  
        [WebSocket サーバー (WebSocket Server)]ダイアログで NetBackup エンドポイントの資格情報を保存するときの問題
      3.  
        NetBackup から WebSocket サーバーエンドポイントを削除するときの問題
      4.  
        NetBackup に追加された WebSocket サーバーのリストを表示するときの問題
      5.  
        エンドポイントサーバーの有効化または無効化に関する問題
      6.  
        NBWSS に関する追加の問題

クラウドアプリケーションによる REST API 呼び出し実行の要求

A. クラウドアプリケーションが vCenter Server に関する情報を NetBackup に追加することを要求する (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 }"
      }
}

注意: 要求とその応答は常に同じ値の "id" を持ちます。

"type" フィールドは "COMMAND""subType" フィールドは "REQUEST" です。"payload""method" は、vcenterServer1 情報を NetBackup に追加する "POST" です。

"subType" "REQUEST" では、"headers": に次の項目が含まれている必要があります。

  • 要求の形式は "Content-Type": "application/vnd.netbackup+json;version=1.0" です。

  • "Authorization" は、前回の応答で受信した JSON Web トークン (JWT) です。

"parameters" フィールドは JSON エスケープ文字です。各値を囲む二重引用符 ("serverName" など) はバックスラッシュ (\) でエスケープされます。

B. クラウドアプリケーションが vCenter Server に関する情報を読み取ることを要求する (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"
            }
      }
}

注意: "type" フィールドは "COMMAND""subType" フィールドは "REQUEST" です。"payload""method" は、NetBackup に格納されている vCenter2.domain.com についての情報を読み取る "GET" です。

C. NetBackup がエンドポイントの要求に応答する
{  
      "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\"}]}"
      }
}

注意:

"payload" には、NetBackup が API から受信した HTTP 応答 ("headers""response code""body") が含まれます。