NetBackup™ コマンドリファレンスガイド
- 概要
- 付録 A. NetBackup コマンド
名前
nbpgsql — NetBackup PostgreSQL クライアントで、バックアップ、問い合わせ、リストア、削除の操作を実行するために使用されます。
概要
nbpgsql -o backup -S primary_server_name -P policy_name -s schedule_name -l postgresql_library_path -z lvm_snapshot_size [-C client_server_name] [-portnum postgresql_server_port] [-u postgresql_server_user] [-instance postgresql_instance_name] [-pgid provider_generated_id]
nbpgsql -o backup -S primary_server_name -P policy_name -s schedule_name -l postgresql_library_path -z lvm_snapshot_size [-C client_server_name] [-b backup_type] [-d backup_directory_path] [-dbname database_name] [-delwal delete_wal_logs] [-g pg_basebackup_compression_level] [-portnum postgresql_server_port] [-u postgresql_server_user] [-instance postgresql_instance_name] [-pgid provider_generated_id]
nbpgsql -o restore -S primary_server_name -P policy_name -t target_restore_directory [-u postgresql_server_user] [-C client_server_name] [-id backup_image_id] [-pitr point-in_time_recovery_time]
nbpgsql -o query -S primary_server_name [-u postgresql_server_user] [-P policy_name] [-C client_server_name] [-instance postgresql_instance_name]
nbpgsql -o delete -S primary_server_name -id backup_image_id
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin
On Windows systems, the directory path to this command is install_path\NetBackup\bin
説明
このコマンドは、NetBackup PostgreSQL クライアントに対するバックアップ、問い合わせ、リストア、および削除の操作を呼び出します。削除操作は、NetBackup カタログからバックアップ情報を削除しますが、バックアップはストレージメディアに保持します。
オプション
- -b backup_type
バックアップ操作に使用するバックアップ形式を指定します。デフォルトでは、スナップショットバックアップ形式が選択されています。-b には次の値を指定できます。
pg_basebackup: PostgreSQL ユーティリティが、インスタンスのバックアップを実行します。Veritas では、LVM 以外の配備でこのオプションを推奨しています。pg_basebackup 形式が指定されている場合、NetBackup はストリームバックアップを実行します。これらのバックアップは、-d オプションを指定すると、非ストリームバックアップに変更されます。このオプションは UNIX と Windows の両方のシステムで利用可能です。
pg_dumpall: PostgreSQL ユーティリティが、インスタンスの論理バックアップを実行します。Veritas では、LVM 以外の配備でこのオプションを推奨しています。pg_dumpall 形式が指定されている場合、NetBackup はストリームバックアップを実行します。これらのバックアップは、-d オプションを指定すると、非ストリームバックアップに変更されます。このオプションは UNIX と Windows の両方のシステムで利用可能です。
pg_dump: PostgreSQL ユーティリティが、個別のデータベースの論理バックアップを実行します。pg_dump 形式が指定されている場合、NetBackup はストリームバックアップを実行します。これらのバックアップは、-d オプションを指定すると、非ストリームバックアップに変更されます。このオプションは UNIX と Windows の両方のシステムで利用可能です。
vss: Windows クライアントのみ対象のスナップショットバックアップ形式。
lvm: UNIX クライアントのみ対象のスナップショットバックアップ形式。
- -C client_server_name
NetBackup クライアント名を指定します。このオプションを -o query オプションと組み合わせて使用すると、操作により、指定した NetBackup クライアントからすべてのバックアップが取得され、一覧表示されます。
- -d backup_directory_path
-b オプションが pg_basebackup、pg_dumpall、または pg_dump の場合に、バックアップディレクトリのパスを構成するために使用されます。-d オプションを指定すると、pg_basebackup、pg_dumpall、または pg_dump のバックアップが非ストリームバックアップに変更されます。一貫性のあるバックアップファイルが、バックアップディレクトリのパスに生成され、バックアップ後に消去されます。ディレクトリパスが空であることを確認してください。指定したディレクトリ内のすべての情報は削除されます。
- -dbname database_name
このオプションを -b pg_dump と組み合わせて使用して、バックアップするデータベースの名前を指定します。このオプションは個々のデータベースをバックアップします。
- -delwal value
このパラメータは、バックアップ中に WAL ファイルを削除するために使用されます。指定できる値は 0 または 1 です。WAL ファイルの削除を有効にするには 1 を使用し、WAL ファイルの削除を無効にするには 0 を使用します。
- -g postgresql_compression_level
-b pg_basebackup バックアップ操作を使用する際の圧縮レベルを設定します。指定可能な値の範囲は 1 から 9 までで、1 が最も低く、9 が最も高い圧縮率です。
- -id backup_image_id
バックアップイメージ ID を指定します。-o delete 操作でこのオプションを使用すると、NetBackup カタログから削除されるバックアップイメージ ID が指定されます。バックアップイメージは削除されません。
増分バックアップをリストアする -o restore 操作で -id パラメータを使用すると、前回の完全バックアップから、バックアップイメージ ID が指定されたバックアップまでのファイルがリストアされます。
-id オプションと -pitr オプションを併用することはできません。
-id パラメータも -pitr パラメータも指定されていない場合、クライアント時間は、指定した時点へのリカバリ時間と見なされます。
- -instance postgresql_instance_name
PostgreSQL サーバーインスタンス名を指定するために使用されます。このオプションを -o query オプションと組み合わせて使用すると、指定したインスタンス名のすべてのバックアップが取得され、一覧表示されます。
- -l postgresql_library_path
PostgreSQL ライブラリディレクトリを指定します。このオプションは UNIX クライアントでのみ利用可能です。
- -o operation_type
実行する操作を指定します。有効な操作形式は次のとおりです。
backup: PostgreSQL インスタンスとデータベースをバックアップするために使用されます。
query: PostgreSQL バックアップの NetBackup カタログを問い合わせるために使用されます。
restore: PostgreSQL インスタンスとデータベースのバックアップをリストアするために使用されます。
delete: PostgreSQL バックアップのカタログ情報を削除するために使用されます。
- -P policy_name
NetBackup DataStore のポリシー名を指定するために使用されます。このオプションを -o query オプションと組み合わせて使用すると、コマンドにより、指定したポリシー名のすべてのバックアップが取得され、一覧表示されます。
- -pgid provider_generated_id
バックアップ用の NetBackup プロバイダ生成 ID を構成します。
PostgreSQL インスタンスの場合、-pgid の形式は「POSTGRESQL_INSTANCE_client_server_name_port」であることが必要です。
個別の PostgreSQL データベースバックアップの場合、-pgid の形式は「POSTGRESQL_DATABASE_database_name_client_server_name_port」であることが必要です。
NetBackup Web UI では、これらの形式に従って、バックアップのリカバリポイントを一覧表示してください。
- -pitr "YYYY-MM-DD hh:mm:ss"
指定した時点へのリカバリ時間を構成します。この値は、リカバリが実行される時点までの時間を表します。
-id パラメータと -pitr パラメータを併用することはできません。
パラメータ -pitr が使用され、指定した時間がバックアップイメージの時間と一致する場合、-id と -pitr も同様に機能します。ただし、時間がバックアップから増分バックアップまでの範囲にある場合、前回の完全バックアップからその増分バックアップまでのファイルがリストアされます。指定した時間の後に増分バックアップが実行されていない場合、バックアップファイルは最後のバックアップにリストアされます。
-id パラメータも -pitr パラメータも指定されていない場合、時間は、指定した時点へのリカバリ時間と見なされます。
- -portnum postgresql_server_port
NetBackup がバックアップおよびリストア操作に使用する、PostgreSQL インスタンスのポート番号を指定します。デフォルトでは、ポート番号は 5432 です。
- -S primary_server_name
NetBackup プライマリサーバーの名前を指定します。
- -s schedule_name
DataStore ポリシー用に構成したスケジュール名を指定します。
- -t target_restore_directory
バックアップのリストア先とするターゲットディレクトリを構成します。
- -u postgresql_server_user
PostgreSQL サーバーユーザーの名前を指定します。デフォルトのユーザーは postgres です。このオプションを -o query オプションと組み合わせて使用すると、このオプションにより、指定したユーザーのすべてのバックアップが取得され、一覧表示されます。
UNIX コンピュータの場合、このパラメータはバックアップ、リストア、および問い合わせの操作のオプションパラメータです。このパラメータは削除操作には使用できません。Windows コンピュータの場合、このパラメータは、バックアップについては省略可能です。このパラメータは、リストア、問い合わせ、および削除の操作には使用できません。
- -z lvm_snapshot_size
LVM のスナップショットサイズを構成します。このオプションは UNIX クライアントでのみ利用可能です。
例
例 1: pg_basebackup のストリームバックアップを実行します。
# nbpgsql -o backup -S Primary_Server1 -P Policy1 -s Schedule1 -l /path/to/pgsql/lib -C Client_Server1 -b pg_basebackup -g 5 -portnum 5432 -u postgres -instance postgres-linux-5432 -pgid POSTGRESQL_INSTANCE_Client_Server1_5432
例 2: pg_basebackup の非ストリームバックアップと圧縮バックアップを実行します。
# nbpgsql -o backup -S Primary_Server1 -P Policy1 -s Schedule1 -l /path/to/pgsql/lib -C Client_Server1 -b pg_basebackup -d /backup/dir/path -g 5 -portnum 5432 -u postgres -instance postgres-linux-5432 -pgid POSTGRESQL_INSTANCE_Client_Server1_5432
例 3: UNIX で -pitr パラメータを使用したリストアを実行します。
# nbpgsql -o restore -S Primary_Server1 -P Policy1 -t /target/restore/directory -u postgres -C Client_Server1 -pitr "2023-12-18 11:43:15"
例 4: Windows で問い合わせを実行します。
nbpgsql -o query -S Primary_Server1 -P Policy1 -C Client_Server1 -instance postgres-linux-5432