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 に関する追加の問題

NetBackup WebSocket サービス (NBWSS) のプロパティの設定

表: NBWSS の設定可能なプロパティ では、設定可能な NBWSS プロパティとそのデフォルトについて説明します。これらのプロパティは、NetBackup マスターサーバーの nbwss.properties テキストファイル内にあります。(このファイルの場所については、この項の手順を参照してください。)

各プロパティは次の形式で各行に表示されます。

key=value

例の .properties ファイルが表の最後に含まれています。プロパティを変更するには、この項の最後に記述されている手順を使います。

表: NBWSS の設定可能なプロパティ

キー

説明

exception.ignoreDecoder

ブール値

NBWSS がデコーダ例外を無視するかどうかを決定します。通常、デコーダ例外は NBWSS が受信メッセージを理解できないときに発生します。

デフォルトは false です。NBWSS はデコーダ例外が発生すると接続を閉じます。

notification.sendTimeout=

整数

NBWSS がエンドポイントとの通信 (通知の送受信) までに待機する時間 (ミリ秒単位) を決定します。デフォルトで、通知タスクはその終了までに 2 秒待機します。通知タスクは、notification.scheduledRate プロパティで設定された時間制限後に再試行されます。

デフォルトは 2000 ミリ秒 (2 秒) です。ほとんどの場合で、このデフォルトの設定を推奨します。

notification.scheduledRate=

整数

NetBackup が新しい通知を問い合わせる頻度 (秒単位) を決定します。この値は、NetBackup が通知を再送信するまでに通知の確認を待機する時間も決定します。

デフォルトは 5 秒です。

keepAlive.scheduledRate=

整数

キープアライブ機能の一部として、NBWSS が各エンドポイントに ping を送信する頻度 (秒単位) を決定します。NetBackup が各 ping に対する応答として pong を受信すると、エンドポイントの接続が有効のままになります。

デフォルトは 30 秒です。

keepAlive.maxPongMissAllowed=

整数

エンドポイントの接続について、許容する pong (ping の応答) のミスの回数を決定します。NBWSS がエンドポイントに ping を送信したときに pong を受信しない場合、欠落 pong として考慮されます。最大値に達すると、NBWSS はそのエンドポイントの接続を閉じます。

デフォルトは 10 回の欠落 pong です。

connectionInfo.period=

整数

それぞれの NBWSS 接続更新間の秒数を決定します。各更新では、NetBackup で現在設定しているエンドポイントが判別され、新しいエンドポイントへの接続またはすでに存在しないエンドポイントの接続の切断が実行されます。

メモ:

エンドポイントを追加した後、エンドポイントに接続するまでに最大で設定時間かかる場合があります。

デフォルトは 60 秒です。

scheduledExecutor.threadPoolSize=

整数

エンドポイントの接続を保持し、通知を処理するために NetBackup が使うスレッド数を決定します。

デフォルトは 1 つのスレッドです。スケジュール設定したタスクの数の増加に合わせてこの値を増やすことができます。

hibernate プロパティ

これらのプロパティはベリタスサポートを使うためのプロパティです。

デフォルト設定の nbwss.properties ファイルを次に示します (このファイルの場所については、次の手順を参照してください)。

#Properties file for NetBackup WebSocket Service
exception.ignoreDecoder=false
notification.sendTimeout=2000
notification.scheduledRate=5
keepAlive.scheduledRate=30
keepAlive.maxPongMissAllowed=10
connectionInfo.period=60
scheduledExecutor.threadPoolSize=1

#Hibernate properties
hibernate.format_sql=true
hibernate.show_sql=false
hibernate.hbm2ddl.auto=update
hibernate.dialect=org.hibernate.dialect.SybaseDialect

NetBackup WebSocket サービス (NBWSS) のプロパティを設定するには

  1. テキストエディタを使って nbwss.properties ファイルを開きます。

    このファイルは、NetBackup マスターサーバーの次の場所にあります。

    Windows の場合:

    install_path\NetBackup\wmc\webserver\webapps_api\
    nbwss\WEB-INF\classes\nbwss.properties

    Linux の場合:

    /usr/openv/wmc/webserver/webapps_api/nbwss/WEB-INF/classes/
    nbwss.properties
  2. 変更するプロパティの値を編集し、ファイルを保存します。

    表: NBWSS の設定可能なプロパティ では、NBWSS プロパティとそのデフォルトについて説明します。

  3. 変更を有効にするために、NetBackup マスターサーバーで NetBackup Web 管理コンソールサービスを再起動することが必要になる可能性があります。

クラウドアプリケーションに対する NetBackup 接続の開始を参照してください。