Symantec NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
bpplclients — NetBackup ポリシー内のクライアントの管理
概要
bpplclients
bpplclientspolicy_name | -allunique [-pt policy_type] [-L | -l | -U | -noheader] [-M master_server,...] [-v]
bpplclientspolicy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add host_name hardware_os [-priority priority]
bpplclientspolicy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -delete host_name ...
bpplclientspolicy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -modify host_name [-hardware hardware] [-os os] [-priority priority]
bpplclientspolicy_name -rename old_client_name new_client_name [-os os] [-priority priority] [-hardware hardware] [-generation generation] [-reason "string"]
bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance instance_namehost_name | -delete_instance {instance_namehost_name [instance_name2host_name2] [...]}
bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance_database instance_namedatabase_namehost_name | -delete_instance_database {instance_name1database_name1host_name1 [instance_name2database_name2host_name2] [...]}
bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance_group instance_group_name | -delete_instance_group instance_group_name]
UNIX システムでは、このコマンドへのディレクトリパスは /usr/openv/netbackup/bin/admincmd/ です。
Windows システムでは、このコマンドへのディレクトリパスは install_path\NetBackup\bin\admincmd\
です。
説明
bpplclients によって、次のいずれかの操作が実行されます。
クライアントのリストを生成します。
新しいクライアントをポリシーに追加します。
ポリシーから、クライアントのリストを削除します。
ポリシー内の既存のクライアントを変更します。
インスタンスグループ、インスタンス、インスタンス内の特定のデータベースのいずれかを SQL Server インテリジェントポリシーに追加します。
インスタンスグループ、インスタンス、インスタンス内の特定のデータベースのいずれかを SQL Server インテリジェントポリシーから削除します。
-add、-delete および -modify オプションを指定して bpplclients を実行すると、クライアント変更の要求が NetBackup に送信された後、すぐにシステムプロンプトに戻ります。変更が正常に終了したかどうかを判断するには、bpplclients を再度実行して、更新されたクライアント情報を表示します。
リストのオプションを使用する場合、リストはクライアント名のアルファベット順で表示されます。クライアントのエントリは、それぞれ 1 行で表示されます。また、このエントリは各クライアントに 1 つ存在します。
このコマンドは、認可済みユーザーが開始できます。
NetBackup による認可について詳しくは、『NetBackup セキュリティおよび暗号化ガイド』を参照してください。
オプション
bpplclients には、2 つの形式があります。使用する bpplclients の形式により、bpplclients で使用するオプションが決定されます。
bpplclients の 1 番目の形式では、オプションは指定されず、すべてのポリシーのクライアント情報を含むリストが生成されます。SQL Server インテリジェントポリシーの場合には、bpplclients によりすべてのポリシーのインスタンスとデータベースのリストまたはインスタンスグループのリストを生成します。その他のポリシー形式がある場合に、任意の MS-SQL-Server ポリシーのバックアップ対象を表示する最良の方法は bpplclients policy_name を使用することです。
bpplclients の 2 番目の形式では、すべてのポリシーまたはある 1 つのポリシーのクライアント情報を含むリストが生成されます。この形式に適用されるオプションを次に示します。
- -add host_name hardware os [priority]
このオプションを指定すると、クライアントがポリシーに追加されます。ローカルシステムにすでに最大数のクライアントが定義されている場合、エラーが戻されます。インストール時のデフォルトのクライアントの最大数は、NetBackup Enterprise Server で無制限、NetBackup サーバーで 4 です。ホスト名、ハードウェア、オペレーティングシステムを指定します。現在、-priority オプションは実装されていません。
- -add_instance_database instance_namedatabase_namehost_name
このオプションは SQL-Server インテリジェントポリシーに適用されます。ポリシーにインスタンスの特定のデータベースを追加します。
ポリシー属性 (bpplinfo) で、-client_list_type は 1 (INSTANCE) に設定する必要があります。同じポリシーにインスタンスとデータベースを追加できます。インスタンスまたはデータベースを含むポリシーにはインスタンスグループを追加できません。
- -add_instance instance_namehost_name
このオプションは SQL-Server インテリジェントポリシーに適用されます。インスタンスをポリシーに追加します。
ポリシー属性 (bpplinfo) で、-client_list_type は 1 (INSTANCE) に設定する必要があります。同じポリシーにインスタンスとデータベースを追加できます。インスタンスまたはデータベースを含むポリシーにはインスタンスグループを追加できません。
- -add_instance_group instance_group_name
このオプションは SQL-Server インテリジェントポリシーに適用されます。インスタンスグループをポリシーに追加します。
ポリシー属性 (bpplinfo) で、-client_list_type は 2 (INSTANCE_GROUP) に設定する必要があります。インスタンスグループを含むポリシーにはインスタンスやデータベースを追加できません。
- -delete host_name ...
このオプションを指定すると、ポリシーから 1 つ以上のクライアントが削除されます。一度の操作で、最大 20 のクライアントを削除できます。クライアントを、ホスト名を空白で区切った形式のリストとして指定します。
- -delete_instance {instance_namehost_name [instance_name2host_name2] [...]}
このオプションは SQL-Server インテリジェントポリシーに適用されます。ポリシーからインスタンスを削除します。 一度の操作で、最大 20 のインスタンスを削除できます。 空白で区切られたリストでインスタンスとホスト名をグループ化します。
- -delete_instance_database {instance_name1database_name1host_name1 [instance_name2database_name2host_name2] [...]}
このオプションは SQL-Server インテリジェントポリシーに適用されます。ポリシーからインスタンス内のデータベースを削除します。一度に最大 20 件のデータベースを削除できます。空白で区切られたリストでデータベース名、インスタンス名、ホスト名をグループ化します。
- -delete_instance_group instance_group_name ...
このオプションは SQL-Server インテリジェントポリシーに適用されます。ポリシーからインスタンスグループを削除します。 一度の操作で、最大 20 のインスタンスグループを削除できます。 空白で区切られたリストで名前を指定します。
- -generation generation
このオプションを指定すると、コマンドがポリシーの特定の世代またはバージョンに対して機能することが確認されます。世代の値は、ポリシーが保存されるたびに大きくなります。bpplinfo または bppllist を使用すると、現在の世代の値を表示できます。世代が指定されない場合は、コマンドは現在のバージョンに対して実行されます。
- -hardware hardware
このオプションでは、クライアントのハードウェアを指定します。バックアップポリシーの管理ユーティリティのクライアントにポリシーを追加するために使用するダイアログボックスで、ハードウェア形式の 1 つを選択します。
- -L
このオプションを指定すると、リストが詳細形式で表示されます。リストの最初の 2 行のヘッダーは表示されません。このヘッダーは、それぞれのクライアントの行に埋め込まれています。各クライアントの行には、次のフィールドが含まれます。
クライアント/HW/OS/優先度 (ヘッダー)
クライアント名 (Client Name)
ハードウェア形式 (Hardware type)
オペレーティングシステム (Operating system)
優先度 (Priority)
その他の 4 つのフィールドは無視できます。これらのフィールドは、未使用であるかまたは内部処理に使用されます。
- -l
このオプションを指定すると、表示形式が簡易になり、簡易なリストが作成されます。これは、raw 出力モードとも呼ばれます。リストの最初の 2 行のヘッダーは表示されません。このヘッダーは、それぞれのクライアントの行に埋め込まれています。リストは次のフィールドから成ります。
フィールド 1 = クライアント名
フィールド 2 =ハードウェア。クライアントのオペレーティングシステムの種類。例: Linux
フィールド 3 = クライアントのオペレーティングシステム名。 例: RedHat
フィールド 4 = 優先度。指定したポリシーでのクライアントの優先度。
フィールド 5 から 7 は使いません。
このオプションは、カスタマイズされたレポート形式にリストを再生成するスクリプトまたはプログラムに対して有効です。
- -M master_server,...
代替マスターサーバーをリストします。このオプションは、カンマで区切られたホスト名のリストで構成されます。このオプションを指定すると、一覧表示されている各マスターサーバーで bpplclients が実行されます。リストに示される各マスターサーバーでは、bpplclients を発行するシステムからのアクセスが許可されている必要があります。マスターサーバーでエラーが発生した場合、その時点で処理が停止します。
bpplclients によってリストが生成される場合、そのリストは、このリスト内のすべてのマスターサーバーから戻された情報で構成されます。
bpplclients によって、後述のとおりクライアントが追加、削除または変更された場合、その変更はリスト内のすべてのマスターサーバーに反映されます。
- -modify host_name ...
このオプションを指定すると、ポリシー内のクライアントの属性が変更されます。変更可能なクライアントは、事前にポリシーに追加されているクライアントです。クライアント名に続く属性値は、このクライアントに前に設定された同等の属性値を置換します。1 つ以上のクライアントの属性を変更する必要があります。現在、-priority は実装されていません。
- -noheader
このオプションを指定すると、リストにヘッダーが含まれません。リストには、各クライアントが 1 行で表示され、ハードウェア、オペレーティングシステムおよびクライアント名が表示されます。
- -os os
このオプションでは、クライアントに異なるオペレーティングシステムを指定します。バックアップポリシーの管理ユーティリティのクライアントにポリシーを追加するために使用するダイアログボックスで、オペレーティングシステムの 1 つを選択します。
ハードウェアオプションおよび -os オプションに選択した値は、有効な組み合わせとして構成されている必要があります。
- policy_name | -allunique [-pt policy_type]
policy_name には、ポリシー名を指定します。そのポリシーのクライアント情報だけが表示されます。
-allunique で -pt policy_type を指定しない場合、マスターサーバー上の NetBackup に定義されたすべてのポリシーのクライアント情報が表示されます。
-allunique -pt policy_type で、policy_type に特定のポリシー形式 (Sybase など) を指定した場合、コマンドを実行すると、その形式のポリシーに属するクライアント情報だけが表示されます。
コマンドラインに policy_type オプションと -allunique オプションのいずれも指定しない場合、すべてのポリシーのクライアント情報が表示されます。このオプションを使う場合は、コマンドラインで最初に指定する必要があります。
- -pt policy_type
このオプションでは、次のいずれかの文字列を指定して、ポリシー形式を指定します (デフォルトは Standard です)。
- -priority priority
実装されていません。
- policy_name
このオプションでは、クライアントを含むポリシーを指定します。このオプションを指定する場合、コマンドラインの最初に指定する必要があります。
- -reason "string"
このコマンド処理を選択する理由を示します。理由の文字列は監査レポートに取得されて表示されます。この文字列は二重引用符 ("...") で囲んでください。文字列が 512 文字を超えないようにしてください。それはハイフンの文字 (-) から始まり単一の引用符 (') を含む場合がありません。
- -rename old_client_name new_client_name
old_client_name オプションでは現行のクライアント名、new_client_name オプションでは新しいクライアント名を指定します。
- -U
このオプションを指定すると、リストがユーザー形式で表示されます。リストには、各クライアントが 1 行で表示され、ハードウェア、オペレーティングシステムおよびクライアント名が表示されます。デフォルトの形式では、リストの最初の部分に 2 行のヘッダーが含まれます。
- -v
このオプションを指定すると、詳細モードが選択されます。このオプションを指定して bpplclients を実行すると、デバッグに使用するための追加情報がログに書き込まれます。追加情報は NetBackup 管理の日次デバッグログに記録されます。このオプションは、デバッグログ機能が有効になっている場合、つまり次のディレクトリが定義されている場合にだけ有効です。
UNIX systems: /usr/openv/netbackup/logs/admin
Windows systems: install_path\NetBackup\logs\admin
このオプションを指定する場合、コマンドラインで、-add、-delete または -modify オプションより前に指定する必要があります。
例
例 1 - マスターサーバー上でコマンドを実行中に、マスターサーバーに認識されているクライアントを表示します。
# bpplclients Hardware OS Client --------------- --------------- -------------- Windows-x64 Windows2008 marmot HP9000-800 HP-UX 11.23 squash
このコマンドをクライアント hatt 上で実行しても、同じ結果が得られます。
例 2 - ポリシー onepolicy に定義されたクライアントを表示します。
# bpplclients onepolicy Hardware OS Client --------------- --------------- -------------- Solaris Solaris10 jeckle RS6000 AIX5 streaky HP9000-800 HP-UX 11.31 shark
例 3 - マスターサーバー serv1
と serv2
上のポリシー twopolicy に、クライアント marmot を追加します。lynx のハードウェアは HP9000、オペレーティングシステムは HP-UX 11.23 です。デフォルトの優先度が使われます。
# bpplclients twopolicy -M serv1,serv2 -add lynx HP9000 HP-UX 11.23
例 4 - マスターサーバー serv1 および serv2 上のポリシー twopolicy から、クライアント marmot および vole を削除します。
# bpplclients twopolicy -M serv1,serv2 -delete marmot vole
例 5 - マスターサーバー hatt 上でコマンドを実行中に、マスターサーバー beaver 上のポリシー BackTrack のクライアント情報を表示します。
# bpplclients BackTrack -M beaver Hardware OS Client --------------- --------------- -------------- Solaris Solaris10 saturn
戻り値
終了状態が 0 (ゼロ) の場合は、コマンドが正常に実行されたことを意味します。
終了状態が 0 (ゼロ) 以外の場合は、エラーが発生したことを意味します。
管理ログ機能が有効になっている場合、終了状態は、次のログディレクトリ内の管理日次ログに書き込まれます。
UNIX システムの場合: /usr/openv/netbackup/logs/admin
Windows システムの場合: install_path\NetBackup\logs\admin
次の形式が使用されます。
bpplclients: EXIT status = exit status
エラーが発生した場合、このメッセージの前に診断が表示されます。
ファイル
UNIX システムの場合:
/usr/openv/netbackup/logs/admin/* /usr/openv/NetBackup/db/policy/policy_name/clients
Windows システムの場合:
install_path\netbackup\logs\admin\* install_path\NetBackup\db\policy\policy_name\clients