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

Last Published:
Product(s): NetBackup & Alta Data Protection (8.1)
  1. NetBackup WebSocket サービス (NBWSS) を使用したクラウドアプリケーションとの通信
    1.  
      NetBackup WebSocket サービス (NBWSS) について
    2.  
      NBWSS 通信を設定するためのタスクの概要
    3.  
      クラウドアプリケーションへの NetBackup 接続に関する注意事項
    4.  
      NBWSS メッセージの形式
    5.  
      NBWSS を介した API 呼び出し
    6.  
      NBWSS 通知
    7. 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 に関する追加の問題

WebSocket エンドポイントの詳細とフォーマット

クラウドベースのアプリケーションと通信するために、NetBackup は WebSocket プロトコルを使ってクラウドアプリケーションとのセキュア接続を確立します。NetBackup は、WebSocket エンドポイントと呼ばれるクラウドアプリケーションインターフェースに接続します。接続の際、NetBackup はエンドポイントに関する特定の情報を必要とします。

表: WebSocket エンドポイントを定義するエントリ では、WebSocket エンドポイントについて必要となる情報について説明します。

表: WebSocket エンドポイントを定義するエントリ

エンドポイントの詳細

説明

token

クラウドアプリケーションのセキュリティトークン。

NetBackup は、クラウドアプリケーションへの接続を開始するときに、そのアプリケーションにトークンを送信します。アプリケーションでトークンが検証されます。アプリケーションでトークンが受け入れられると、NetBackup とアプリケーション間でセキュア接続が確立します。アプリケーションがトークンを受け入れない場合、接続は確立しません。

priority

グループ内でのエンドポイントの優先度。低い番号ほど優先度が高くなります。

NetBackup は、優先度に基づいて、該当のサーバーグループに対する接続試行の順番を決定します。アクティブな接続はサーバーグループあたり 1 つのみです。

groupId

エンドポイントが属するグループの一意の識別子。

hostName

エンドポイントを含むクラウドサーバーのホスト名または IP アドレス。

url

NetBackup が接続する WebSocket エンドポイントの完全な URL。

WebSocket の URL は wss:// で始まります。

メモ:

ws:// はサポートされません。

重要: エンドポイントの詳細を取得するには、クラウドサービスプロバイダへの問い合わせが必要な場合があります。エンドポイントの詳細は、次のいずれかの方法で NetBackup に提供する必要があります。

  • JavaScript Object Notation でフォーマット化されたファイル (JSON ファイル)。サービスプロバイダがエンドポイントの詳細を JSON ファイルで提供していない場合は、独自に情報を JSON ファイルにフォーマットする必要があります。

    メモ:

    エンドポイントの詳細には、クラウドアプリケーションにアクセスするためのセキュリティトークンが含まれている必要があります。サービスプロバイダはアプリケーショントークンを安全な方法で送信するように注意する必要があります。

  • URL の使用。NetBackup は URL を使ってクラウドアプリケーションからのエンドポイントの詳細を要求します。

メモ:

NetBackup は、エンドポイントの詳細のどの場所でもアポストロフィ (') をサポートしません。

JSON ファイルでの WebSocket エンドポイントの詳細

JSON (JavaScript Object Notation) による WebSocket エンドポイントの詳細を次に示します。

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

次の点に注意してください。

  • このバージョンの NetBackup では、各 JSON ファイルで複数ではなく単一のエンドポイントを指定する必要があります。

  • ファイルは、左側の波括弧 ({) で始まり、右側の波括弧 (}) で終わります。

  • エントリはカンマで区切った name:value の組み合わせで構成されます。

  • 優先度の値以外の各文字列は二重引用符 ("") で囲まれます。

  • 5 つの name:value の組み合わせ (tokenprioritygroupIDhostNameurl) は任意の順番で表示できます。

  • NetBackup は、このファイル内のどの場所でもアポストロフィ (') をサポートしません。

  • JSON フォーマットの情報を NetBackup がアクセスできる場所にテキストファイルとして保存します。

  • JSON フォーマットについては、JavaScript Object Notation に関するネットワーキンググループメモを参照してください。

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

WebSocket エンドポイントを定義する JSON フォーマットファイルの例を次に示します。

{
      "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"
}

JSON ファイルの例に関する注意

  • この例はトークンから始まります。トークンは、NetBackup が接続を要求するときにクラウドアプリケーションがその NetBackup を認証するために使う文字列です。

    注意:

    サービスプロバイダからエンドポイントの情報を入手するときは、トークンが安全な方法で提供されるようにしてください。

  • 次のエントリは priority です。その後、groupIdhostName、クラウドサーバーの url と続きます。

JSON フォーマットファイルの場合は、NetBackup の [WebSocket サーバー (WebSocket Server)]ダイアログの[ファイル (FILE)]オプションを使って、そのファイルを指定します。NetBackup でファイルからエンドポイントの詳細が抽出されます。次の手順を実行します。

WebSocket サーバーエンドポイントの NetBackup クレデンシャルの保存を参照してください。

Web を介して取得した WebSocket エンドポイントの詳細

クラウドアプリケーションは、NetBackup が WebSocket エンドポイントの詳細の要求に使用できる URL を生成できます。URL を NetBackup の[WebSocket サーバー (WebSocket Server)]ダイアログに入力するには次の手順を実行します。

WebSocket サーバーエンドポイントの NetBackup クレデンシャルの保存を参照してください。