コマンドリファレンス#

Barmanには、 barman という名前のコマンドラインインターフェイスがあり、これは基本的にBarmanのバックエンドと対話するために使用されます。

barman の各サブコマンドに入る前に、 barman には、すべてのサブコマンドで使用可能なグローバルオプションがあることに注意してください。これらのオプションは、サブコマンドの動作を変更でき、次のように使用できます。

`barman`#

概要#

barman
    [ { -c | --config } CONFIG ]
    [ { --color | --colour } { never | always | auto } ]
    [ { -d | --debug } ]
    [ { -f | --format } { json | console } ]
    [ { -h | --help } ]
    [ --log-level { NOTSET | DEBUG | INFO | WARNING | ERROR | CRITICAL } ]
    [ { -q | --quiet } ]
    [ { -v | --version } ]
    [ SUBCOMMAND ]

注釈

これは、概要の構文です。

角かっこ間のオプションはオプショナル。
中括弧間のオプションは、いずれかの設定操作の選択を表します。
[ ... ] を使用したオプションは複数回指定できます。
大文字で書かれたものは、値を与える必要があるリテラルを表します。

以下のセクションで barman サブコマンドを説明するときに、これと同じ構文を使用します。

また、以降のセクションでサブコマンドを説明するときは、コマンドの概要を SUBCOMMAND の代わりに見る必要があります。

パラメーター#

-c / --config CONFIG

使用する構成ファイルを指定します。提供されない場合、デフォルトの /etc/barman.conf 。

--color / --colour { never | always | auto }

出力で色を使用するかどうかを制御します。デフォルトは auto です。オプションは次のとおりです。

never 色を使用しません。
always 常にカラーを使用します。
auto 出力が端末にある場合は色を使用します。

-d / --debug

デバッグ出力を有効にします。デフォルトは false です。トラブルシューティングのための詳細なログ情報を提供します。

-f / --format { json | console }

出力形式を指定します。オプションは次のとおりです。

json JSON形式で出力します。
console 人間が判読できる形式で出力しますデフォルト。

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

--log-level { NOTSET | DEBUG | INFO | WARNING | ERROR | CRITICAL }

デフォルトのログレベルをオーバーライドします。オプションは次のとおりです。

NOTSET これは、特定のロギングレベルが設定されていない場合のデフォルトレベルです。これは本質的にログメッセージの/"フィルタリングなし"を意味し、構成で設定されたレベルに従ってすべてのメッセージを処理できます。
DEBUG このレベルは、詳細な診断情報に使用され、多くの場合、開発者が問題を診断する際に役立ちます。これには、プログラムの実行のトレースを支援することを目的とした、より粒度が高く詳細なメッセージが含まれています。
INFO このレベルは、アプリケーションの通常のオペレーションに関する一般的な情報を提供します。これは、アプリケーションの進行状況を示すメッセージ、または実行フローのキーポイントを強調表示するために使用されますが、問題は示していません。
WARNING このレベルは、予期しない何かが発生したか、潜在的な問題がある可能性を示します。これは、重要ではないが懸念される可能性のあるメッセージに使用され、注意が必要である可能性があることを示します。
ERROR このレベルは、特定の操作を正常に完了できないエラーが発生した場合に使用されます。これは、対処する必要があるが、必ずしもアプリケーションの実行を停止するわけではない重要な問題を示すために使用されます。
CRITICAL これは、最高レベルの重大度であり、アプリケーションを終了させた可能性が高い、またはすぐに対処しないと重大な結果をもたらす重大なエラーを示します。緊急の注意が必要な重要な問題に使用されます。

-q / --quiet

すべての出力を抑制します。 cronジョブまたは自動スクリプトに役立ちます。

-v / --version

プログラムバージョン番号を表示して終了します。

ショートカット#

一部のコマンドでは、次のショートカットまたはエイリアスを使用して、特定のサーバーのバックアップを識別できます。具体的には、 all ショートカットを使用して、すべてのサーバーを識別できます。

Shortcut	Description
all	使用可能なすべてのサーバー
first/oldest	サーバーの使用可能な最も古いバックアップ時系列。
last/latest	サーバーで使用可能な最新のバックアップ時系列。
last-full/latest-full	`rsync` または `postgres` 方法で取得された最新のフルバックアップ。
last-failed	失敗した最新のバックアップ時系列。

終了ステータス#

ステータスコード 0 は 0 を意味し、ステータスコード 0 は 0 を意味します。

サブコマンド#

barman は、いくつかの便利な操作を公開します。このセクションでは、それぞれを説明することを目的としています。

以下のセクションでは、 barman によって実装される各コマンドの説明を見つけます。これらのコマンドの一部には、このドキュメントの別のメインセクションに詳細な情報が含まれている場合があります。その場合、すぐに移動できるリファレンスが提供されています。

`barman archive-wal`#

概要#

archive-wal
    [ { -h | --help } ]
    SERVER_NAME

説明#

標準の archive_command または pg_receivewal を使用したストリーミングレプリケーションから受信したWALファイルを取得し、サーバーのWALアーカイブに保存します。構成ファイルで compression を有効にしている場合、WALファイルはアーカイブされる前に圧縮されます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman backup`#

概要#

backup
    [ --bwlimit KBPS ]
    [ { -h | --help } ]
    [ --incremental BACKUP_ID ]
    [ --immediate-checkpoint ]
    [ { -j | --jobs } PARALLEL_WORKERS ]
    [ --jobs-start-batch-period PERIOD ]
    [ --jobs-start-batch-size SIZE ]
    [ --keepalive-interval SECONDS ]
    [ --manifest ]
    [ --name NAME ]
    [ --no-immediate-checkpoint ]
    [ --no-manifest ]
    [ --no-retry ]
    [ --retry-sleep SECONDS ]
    [ --retry-times NUMBER ]
    [ --reuse-backup { off | copy | link } ]
    [ { --wait | -w } ]
    [ --wait-timeout SECONDS ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

PostreSQLサーバーのバックアップを実行します。 Barmanは、グローバル構成ファイルとサーバー構成ファイルで指定されたパラメーターを使用します。 Barmanノードで構成されているすべてのサーバーからバックアップを実行するには、サーバー名の代わりに all ショートカットを指定します。複数のサーバー名を順番に指定して、特定のサーバーのバックアップを実行することもできます。

パラメーター#

SERVER_NAME

barmanノードのサーバーの名前。

--bwlimit

最大転送速度をキロバイト/秒で指定します。値0は制限がないことを示します。この設定は、 bandwidth_limit 構成オプションをオーバーライドします。

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

--incremental

ブロックレベルのインクリメンタルバックアップを実行します。 BACKUP_ID または以前のバックアップへのショートカットを提供する必要があります。これは、インクリメンタルバックアップの親バックアップとして機能します。

注釈

バックアップと親バックアップには backup_method=postgres が必要です。

--immediate-checkpoint

初期チェックポイントをできるだけ早く実行させ、構成ファイルの immediate_checkpoint パラメーターに設定された値をオーバーライドします。

-j / --jobs

バックアップ中にファイルのコピーに使用するパラレルワーカーの数を指定します。この設定は、構成ファイルで指定されている場合、 parallel_jobs パラメーターをオーバーライドします。

--jobs-start-batch-period

ジョブの単一のバッチを開始する時間を秒単位で指定します。この値は、構成ファイルで設定されている場合、 parallel_jobs_start_batch_period パラメーターをオーバーライドします。デフォルトは 1 秒です。

--jobs-start-batch-size

単一のバッチで開始するパラレルワーカーの最大数を指定します。この値は、構成ファイルで定義されている場合、 parallel_jobs_start_batch_size パラメーターをオーバーライドします。デフォルトは 10 ワーカーです。

--keepalive-interval

サーバーにハートビートクエリを送信して、Rsyncバックアップ中にlibpq接続をアクティブに保つ間隔を秒単位で指定します。デフォルトは 60 秒です。 0 の値はハートビートを無効にします。

--manifest

バックアップの完了時に、バックアップマニフェストファイルの作成を強制します。構成ファイルから autogenerate_manifest パラメーターをオーバーライドします。 rsyncバックアップ戦略にのみ適用されます。

--name

barmanコマンドでバックアップIDの代わりに使用できるこのバックアップのフレンドリ名を指定します。

--no-immediate-checkpoint

構成ファイルの immediate_checkpoint パラメーターに設定された値をオーバーライドして、チェックポイントが実行されるまでバックアップを強制的に待機します。

--no-manifest

バックアップの完了時に、バックアップマニフェストファイルの自動作成を無効にします。この設定は、構成ファイルの autogenerate_manifest パラメーターをオーバーライドし、rsyncバックアップストラテジーにのみ適用されます。

--no-retry

エラーが発生した場合の再試行はありません。 --retry-times 0 の設定と同じです。

--retry-sleep

コピーが失敗した後、再試行するまでに待機する秒数を指定します。この設定は、バックアップとリカバリー操作の両方に適用され、構成ファイルで定義されている場合 basebackup_retry_sleep パラメーターをオーバーライドします。

--retry-times

エラーが発生した場合に、ベースバックアップコピーを再試行する回数を指定します。これは、バックアップとリカバリー操作の両方に適用され、構成ファイルで設定されている場合 basebackup_retry_times パラメーターをオーバーライドします。

--reuse-backup

構成ファイルで構成された reuse_backup オプションの動作をオーバーライドします。可能な値は次のとおりです。

off 最後の使用可能なバックアップを再利用しません。
copy サーバーの最後に利用可能なバックアップを再利用し、変更されていないファイルのコピーを作成しますバックアップ時間を削減します。
link デフォルトサーバーの最後に利用可能なバックアップを再利用し、変更されていないファイルへのハードリンクを作成しますバックアップ時間と領域の両方を節約します。

注釈

これは、最後に使用可能なバックアップが backup_method=rsync で実行された場合にのみ効果があります。

--wait / -w

ベースバックアップに必要なすべてのWALファイルがアーカイブされるまで待ちます。

--wait-timeout

タイムアウトになる前に、必要なWALファイルがアーカイブされるのを待機する時間を秒単位で指定します。

`barman check-backup`#

概要#

check-backup
    [ { -h | --help } ]
    SERVER_NAME BACKUP_ID

説明#

物理バックアップの一貫性を検証するために必要なWALファイルがすべて適切にアーカイブされていることを確認します。このコマンドは、cronジョブによって、および各バックアップ操作の最後に自動的に実行されます。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前。
BACKUP_ID: barmanカタログのバックアップのID。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman check`#

概要#

check
    [ { -h | --help } ]
    [ --nagios ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

SSH接続、Postgresバージョン、構成とバックアップディレクトリ、アーカイブとストリーミングプロセス、レプリケーションスロットなど、サーバーに関するステータス情報を表示します。 all をショートカットとして使用して、構成されているすべてのサーバーの診断情報を表示します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--nagios: Nagiosプラグイン互換出力。

`barman config-switch`#

概要#

config-switch
    [ { -h | --help } ]
    SERVER_NAME { --reset | MODEL_NAME }

説明#

モデルからBarmanのサーバーに一連の構成オーバーライドを適用します。最終的な構成は、サーバーの既存の設定をモデルで指定された設定と組み合わせるかオーバーライドします。 --reset 引数を使用してサーバー構成をリセットできます。

注釈

特定のサーバーで一度に1つのモデルのみをアクティブにできます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前。
MODEL_NAME: モデルの名前。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--reset: サーバーの構成をリセットします。

`barman config-update`#

概要#

config-update
    [ { -h | --help } ]
    STRING

説明#

Barmanでサーバーおよび/またはモデルの構成を作成または更新します。パラメーターは、ドキュメントの配列を含むJSON文字列である必要があります。各ドキュメントには、サーバーまたはモデルの scope キーと、スコープ値に応じて server_name または model_name キーのいずれかを含める必要があります。さらに、ドキュメントには、 Barman構成オプションとその目的の値を表す他のキーを含める必要があります。

注釈

barman config-update コマンドは、 barman_home ディレクトリにある .barman.auto.conf という名前のファイルに構成オプションを書き込みます。この構成ファイルは優先順位が高く、グローバルBarman構成ファイル通常は /etc/barman.conf および configuration_files_directory で指定されたインクルードファイル通常は /etc/barman.d のファイルからの値をオーバーライドします。後でこれらのファイルの構成オプションを手動で変更する場合は、これに注意してください。

パラメーター#

STRING: JSON形式の文字列のリスト。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

例#

JSON_STRING='[{“scope”: “server”, “server_name”: “my_server”, “archiver”: “on”, “streaming_archiver”: “off”}]'

`barman cron`#

概要#

cron
    [ { -h | --help } ]
    [ --keep-descriptors ]

説明#

保持ポリシーの適用やWALファイルの管理などのメンテナンスタスクを実行します。

パラメーター#

-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--keep-descriptors: Barmanサブプロセスの`stdout`および`stderr`ストリームをメインプロセスに接続したままにします。これは、Dockerベースのインストールに特に役立ちます。

`barman delete`#

概要#

delete
    [ { -h | --help } ]
    SERVER_NAME BACKUP_ID

説明#

指定されたバックアップを削除します。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
BACKUP_ID: barmanカタログのバックアップのID。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman diagnose`#

概要#

diagnose
    [ { -h | --help } ]
    [ --show-config-source ]

説明#

BarmanがインストールされているサーバーであるBarmanノード、および構成されているすべてのPostgresサーバーに関する診断情報を表示します。これには、グローバル構成、SSHバージョン、Pythonバージョン、rsyncバージョン、すべてのサーバーの現在の構成とステータスなどの詳細が含まれます。

パラメーター#

-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--show-config-source: 各構成オプションの有効な値を提供するソースファイルを含めます。

`barman generate-manifest`#

概要#

generate-manifest
    [ { -h | --help } ]
    SERVER_NAME BACKUP_ID

説明#

バックアップ用の backup_manifest ファイルを生成します。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
BACKUP_ID: barmanカタログのバックアップのID。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman get-wal`#

概要#

get-wal
    [ { --bzip | -j } ]
    [ { --gzip | -z | -x } ]
    [ { -h | --help } ]
    [ --keep-compression ]
    [ { --output-directory | -o } OUTPUT_DIRECTORY ]
    [ { --peek | -p } VALUE ]
    [ { -P | --partial } ]
    [ { -t | --test } ]
    SERVER_NAME WAL_NAME

説明#

指定されたサーバーのxlogアーカイブからWALファイルを取得します。デフォルトでは、要求されたWALファイルが見つかると、非圧縮コンテンツとして STDOUT に返されます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
WAL_NAME: barmanカタログのバックアップのID。
--bzip2 / -j: 出力はbzip2を使用して圧縮されます。
--gzip / -z / -x: 出力はgzipを使用して圧縮されます。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--keep-compression: ファイルの内容は解凍しないでください。出力は元の圧縮ファイルになります。
--output-directory / -o: barmanがWALファイルを保存する宛先ディレクトリ。
--peek / -p: 指定されたWALファイルからこのパラメーターで指定された値までのWALファイルを取得するには、1以上の整数値を指定します。このオプションを使用する場合、 get-wal は、行ごとに1つの名前を含む0から指定されたWALセグメント名のリストを結果ます。
-P / --partial: さらに、部分的なWALファイル.partialを収集します。
-t / --test: WAL取得のためにBarmanで指定されたPostgresサーバーの接続と構成の両方をテストします。このオプションを使用する場合、必須の WAL_NAME 引数は無視されます。

警告

-z / --gzip および -j / --bzip2 オプションは非推奨であり、将来的に削除される予定です。 WAL圧縮の場合、 compression 構成オプションを介してBarmanサーバーで直接有効にしてください。

`barman keep`#

概要#

keep
    [ { -h | --help } ]
    { { -r | --release } | { -s | --status } | --target { full | standalone } }
    SERVER_NAME BACKUP_ID

説明#

指定されたバックアップを無期限に保持するアーカイブバックアップとして target でマークし、アクティブな保持ポリシーをオーバーライドします。バックアップのkeep status とバックアップのkeepマーク release を確認することもできます。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME

barmanノードのサーバーの名前

BACKUP_ID

barmanカタログのバックアップのID。

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

-r / --release

このバックアップからキープマークを解放します。これにより、アーカイブステータスが削除され、直接または保持ポリシーによって削除できるようになります。

-s / --status

バックアップのアーカイブステータスを報告します。ステータスは、アーカイブバックアップの場合は full または standalone 、アーカイブとして指定されていないバックアップの場合は nokeep になります。

--target

アーカイブバックアップのリカバリターゲットを定義します。可能な値は次のとおりです。

full バックアップは、最新のポイント・インタイムにリカバリーするために使用できます。これをサポートするために、 Barmanは必要なすべてのWALを保持して、バックアップの一貫性と後続のWALを維持します。
standalone バックアップは、サーバーをバックアップ時の状態に復元するためにのみ使用できます。 Barmanは、バックアップの一貫性を保証するために必要なWALのみを保持します。

`barman list-backups`#

概要#

list-backups
    [ { -h | --help } ]
    [ --minimal ]
    SERVER_NAME

説明#

サーバーの使用可能なバックアップを表示します。このコマンドは、バックアップIDとバックアップタイプの両方を取得するのに役立ちます。このコマンドの詳細については、 Catalog usage を参照してください。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--minimal: 機械可読出力。

`barman list-files`#

概要#

list-files
    [ { -h | --help } ]
    [ --target { data | full | standalone | wal } ]
    [ --list-empty-directories ]
    SERVER_NAME BACKUP_ID

説明#

特定のバックアップ内のすべてのファイルをリストします。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME

barmanノードのサーバーの名前

BACKUP_ID

barmanカタログのバックアップのID。

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

--target

リストする特定のファイルを定義します。可能な値は次のとおりです。

standalone デフォルト必要なWALファイルを含むベースバックアップファイルをリストします。
data データファイルのみをリストします。
wal ベースバックアップの開始とログの最後または次のベースバックアップの開始までのすべてのWALファイルをリストします指定されたベースバックアップが使用可能な最新のものかどうかに応じて。
full data + wal と同じ。

--list-empty-directories

空のディレクトリをリストに追加します。

`barman list-processes`#

概要#

list-processes
    [ { -h | --help } ]
    SERVER_NAME

説明#

list-processes サブコマンドは、 Barmanサーバーのすべてのアクティブなサブプロセスを出力します。アクティブなサブプロセスごとにプロセス識別子PIDと、対応するバーマンタスクが表示されます。

パラメーター#

SERVER_NAME: アクティブなサブプロセスをリストするサーバーの名前。
-h / --help: ヘルプメッセージを表示して終了します。

`barman list-servers`#

概要#

list-servers
    [ { -h | --help } ]
    [ --minimal ]

説明#

構成されているすべてのサーバーをその説明とともに表示します。

パラメーター#

-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--minimal: 機械可読出力。

`barman lock-directory-cleanup`#

概要#

lock-directory-cleanup
    [ { -h | --help } ]

説明#

未使用のロックファイルを barman_lock_directory から自動的に削除します。

パラメーター#

-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman put-wal`#

概要#

put-wal
    [ { -h | --help } ]
    [ { -t | --test } ]
    SERVER_NAME

説明#

リモートサーバーからWALファイルを受信し、サーバーの受信ディレクトリに安全に保存します。 WALファイルは STDIN を介して提供され、検証用の SHA256SUMS または MD5SUMS ファイルとともにtarストリームにカプセル化されています sha256 はデフォルトのハッシュアルゴリズムですが、ユーザーは barman-wal-archive を介して archive-command を設定するときに md5 を選択できます。このコマンドは、リモートの barman-wal-archive ユーティリティbarman-cliパッケージに含まれているからSSHを介して実行することを目的としています。ファイルのコンテンツを完全に管理する場合を除き、このコマンドを直接使用しないでください。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
-t / --test: WAL取得のためにBarmanで指定されたPostgresサーバーの接続と構成の両方をテストします。

`barman rebuild-xlogdb`#

概要#

rebuild-xlogdb
    [ { -h | --help } ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

ディスクの内容に基づいて、サーバーまたは all ショートカットを使用するすべてのサーバーのWALファイルメタデータを再構築します。 WALアーカイブメタデータは xlog.db ファイルに保存され、各Barmanサーバーが独自のコピーを維持します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman recover`#

注釈

このコマンドは非推奨です。代わりに barman restore コマンドを使用します。

`barman receive-wal`#

概要#

receive-wal
    [ --create-slot ]
    [ --drop-slot ]
    [ { -h | --help } ]
    [ --reset ]
    [ --stop ]
    SERVER_NAME

説明#

サーバーのトランザクションログのストリーミングを開始します。このプロセスは、 pg_receivewal または pg_receivexlog を使用して、ストリーミングプロトコルを介してPostgresサーバーからWALファイルを受信します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前。
--create-slot: slot_name 構成パラメーターで構成された物理レプリケーションスロットを作成します。
--drop-slot: slot_name 構成パラメーターで構成された物理レプリケーションスロットをドロップします。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--reset: receive-wal のステータスをリセットし、サーバーの現在のWALファイルからストリーミングをリスタートします。
--stop: サーバーのプロセスを停止します。

警告

barman receive-wal コマンドの --stop オプションは、将来のリリースでは廃止されます。ユーザーは代わりに --stop コマンドの使用を優先する必要があります。これは、この機能を処理する新しい方法です。

`barman restore`#

概要#

restore
    [ --aws-region AWS_REGION } ]
    [ --azure-resource-group AZURE_RESOURCE_GRP ]
    [ --bwlimit KBPS ]
    [ --exclusive ]
    [ --gcp-zone GCP_ZONE ]
    [ { --get-wal | --no-get-wal } ]
    [ { -h | --help } ]
    [ { -j | --jobs } PARALLEL_WORKERS ]
    [ --jobs-start-batch-period SECONDS ]
    [ --jobs-start-batch-size NUMBER ]
    [ --local-staging-path PATH ]
    [ { --network-compression | --no-network-compression } ]
    [ --no-retry ]
    [ --recovery-conf-filename FILENAME ]
    [ --recovery-staging-path PATH ]
    [ --staging-path STAGING_PATH ]
    [ --staging-location STAGING_LOCATION ]
    [ --remote-ssh-command STRING ]
    [ --retry-sleep SECONDS ]
    [ --retry-times NUMBER ]
    [ --snapshot-recovery-instance INSTANCE_NAME ]
    [ --snapshot-recovery-zone GCP_ZONE ]
    [ --standby-mode ]
    [ --tablespace NAME:LOCATION [ --tablespace NAME:LOCATION ... ] ]
    [ --target-action { pause | shutdown | promote } ]
    [ --target-immediate ]
    [ --target-lsn LSN ]
    [ --target-name RESTORE_POINT_NAME ]
    [ --target-time TIMESTAMP ]
    [ --target-tli TLI ]
    [ --target-xid XID ]
    [ --staging-wal-directory ]
    SERVER_NAME BACKUP_ID DESTINATION_DIR

説明#

PostreSQLサーバーの復元操作を実行します。 Barmanは、宛先ディレクトリのサーバーからバックアップを復元します。復元は、ローカルにbarmanノード自分自身でまたはリモートでSSH経由でアクセス可能な別のマシンで実行できます。場所は、 --remote-ssh-command オプションを使用するかどうかによって決まります。このコマンドの詳細については、 --remote-ssh-command セクションを参照してください。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME

barmanノードのサーバーの名前

BACKUP_ID

barmanカタログのバックアップのID。 auto を使用して、 Barmanが復元操作に最適なバックアップを自動的に見つけます。

DESTINATION_DIR

バックアップを復元する宛先ディレクトリ。

--aws-region

スナップショットリカバリー用のインスタンスとディスクが存在するAWSリージョンを指定します。このオプションを使用すると、 Barman構成の aws_region 値をオーバーライドできます。

--azure-resource-group

スナップショットリカバリーのインスタンスとディスクを含むAzureリソースグループを指定します。このオプションを使用すると、 Barman構成の azure_resource_group 値をオーバーライドできます。

--bwlimit

最大転送速度をキロバイト/秒で指定します。 0 の値は、制限がないことを示します。この設定は、 bandwidth_limit 構成オプションをオーバーライドします。

--exclusive

ターゲット時間、XID、またはLSNを非包括的に設定します。

--gcp-zone

スナップショットリカバリーのインスタンスとディスクが存在するGCPゾーンを指定します。このオプションを使用すると、 Barman構成の gcp_zone 値をオーバーライドできます。

--get-wal / --no-get-wal

リカバリー中のWAL取得での get-wal の使用を有効/無効にします。デフォルトは recovery_options 設定に基づいています。

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

-j / --jobs

--jobs-start-batch-period

--jobs-start-batch-size

--local-staging-path

宛先ディレクトリにコピーされる前にバックアップチェーンが結合されるBarmanホスト上のパスを指定します。ステージングパス内で作成されたコンテンツは、復元プロセスが完了すると削除されます。このオプションは、ブロックレベルのインクリメンタルバックアップから復元するために必要であり、それ以外の場合は効果がありません。

--network-compression / --no-network-compression

リモート復元中のネットワーク圧縮を有効/無効にします。デフォルトは network_compression 構成設定に基づいています。

--no-retry

エラーが発生した場合の再試行はありません。 --retry-times 0 の設定と同じです。

--recovery-conf-filename

Postgresバージョン12以降のバックアップを復旧するときに、 Barmanが復旧オプションを書き込むファイルの名前を指定します。デフォルトでは、これは postgresql.auto.conf に設定されます。ただし、 --recovery-conf-filename が指定されている場合、リカバリオプションは代わりに指定された値に書き込まれます。デフォルト値はほとんどのPostgresインストールに適していますが、このオプションにより、 Postgresが構成メカニズムを変更するツールで管理されている場合たとえば、 postgresql.auto.conf が /dev/null にシンボリックリンクされている場合、代替の場所を指定できます。

--recovery-staging-path

圧縮バックアップのファイルを宛先ディレクトリに解凍する前にステージングする復旧ホスト上のパスを指定します。バックアップは、命名規則 barman-staging-SERVER_NAME-BACKUP_ID に従って、ステージングパス内の独自のディレクトリにステージングされます。このステージングディレクトリは、復元プロセスが完了すると削除されます。このオプションは圧縮バックアップから復元するために必須であり、それ以外の場合は効果がありません。

--staging-path

リストア中に中間ファイルがステージングされるパス。圧縮されたバックアップを復元する場合、最終的な宛先にコピーする前に、解凍の一時的な場所として機能します。インクリメンタルバックアップを復元する場合、最終的な宛先にコピーする前にバックアップが結合されます。この場所には、解凍/結合されたバックアップを保存するための十分な領域が必要です。

--staging-location

--staging-path がローカルパスかリモートパスであるかを指定します。有効な値は local および remote です。

--remote-ssh-command

このオプションは、リモートホストで実行するsecure Shellコマンドを指定することにより、リモート復元を有効にします。これは、リモートリストアの構成ファイル 'ssh USER@SERVER' の ssh_command サーバーオプションと同様に機能します。

--retry-sleep

コピーが失敗した後、再試行するまでに待機する秒数を指定します。この設定は、バックアップとリストア操作の両方に適用され、構成ファイルで定義されている場合 basebackup_retry_sleep パラメーターをオーバーライドします。

--retry-times

エラーが発生した場合に、ベースバックアップコピーを再試行する回数を指定します。これは、バックアップ操作とリストア操作の両方に適用され、構成ファイルに設定されている場合 basebackup_retry_times パラメーターをオーバーライドします。

--snapshot-recovery-instance

スナップショットから復元されたディスクが接続されているインスタンスの名前を指定します。このオプションは、 backup_method=snapshot で作成されたバックアップをリカバリする場合に必要です。

--snapshot-recovery-zone 非推奨

スナップショットリカバリーのインスタンスとディスクを含むゾーン非推奨: --gcp-zone に置き換えられます。

--standby-mode

Postgresサーバーをスタンバイとして起動するかどうか。

--tablespace

テーブルスペースの再配置ルールを指定します。 NAME はテーブルスペース名であり、 LOCATION はテーブルスペースを復元するための復旧ホスト宛先パスです。

--target-action

回復目標に到達すると、指定されたアクションをトリガーします。このオプションでは、これらのアクションのいずれかとともにターゲットを定義する必要があります。可能な値は次のとおりです。

pause 復旧目標に到達すると、サーバーは一時停止状態で起動され、ユーザーはインスタンスを検査できます
promote 復旧ターゲットに到達すると、サーバーは復旧オペレーションを終了し、マスターとして昇格します。
shutdown 復旧目標に到達すると、サーバーはシャットダウンされます。

--target-immediate

一貫した状態に到達すると、リカバリは完了しますベースバックアップの終了。

--target-lsn

指定されたLSNログシーケンス番号にリカバリします。 Postgres 10以上が必要です。

--target-name

pg_create_restore_point(name) で以前に作成した復元ポイントの指定された名前にリカバリーします。

--target-time

指定した時間にリカバリーします。 YYYY-MM-DD HH:MM:SS.mmm 形式を使用します。

--target-tli

指定されたタイムラインを復元します。数値のタイムラインIDに加えて、特別な値 current および latest を使用できます。 Postgresバージョン12以降の場合、デフォルトでは、WALアーカイブの最新のタイムラインにリカバリーします。 12より前のPostgresバージョンの場合、デフォルトでは、バックアップが取得された時点のタイムラインにリカバリーします。

--target-xid

指定されたトランザクションIDにリカバリします。

--staging-wal-directory

PITRを実行する際のWALファイルの宛先ホスト上のステージングディレクトリ。指定しない場合、宛先ディレクトリ内の barman_wal ディレクトリを使用します。

`barman replication-status`#

概要#

replication-status
    [ { -h | --help } ]
    [ --minimal ]
    [ --source { backup-host | wal-host } ]
    [ --target { hot-standby | wal-streamer | all } ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

指定したサーバーに接続しているストリーミングクライアントのリアルタイム情報とステータスを表示します。構成されているすべてのサーバーの情報を表示するには、 all ショートカットを指定します。

パラメーター#

SERVER_NAME

barmanノードのサーバーの名前

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

--minimal

機械可読出力。

--source

可能な値は次のとおりです。

backup-host デフォルトサーバーのバックアップ接続情報を使用してクライアントをリストします。
wal-host サーバーのWALストリーミング接続情報を使用してクライアントをリストします。

--target

可能な値は次のとおりです。

hot-standby ホットスタンバイサーバーのみをリストします。
wal-streamer pg_receivewal などのWALストリーミングクライアントのみをリストします。
all デフォルトすべてのストリーミングクライアントをリストします。

`barman show-backup`#

概要#

show-backup
    [ { -h | --help } ]
    SERVER_NAME BACKUP_ID

説明#

特定のバックアップに関する詳細情報を表示します。このコマンドの詳細については、 Catalog usage を参照してください。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
BACKUP_ID: barmanカタログのバックアップのID。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman show-servers`#

概要#

show-servers
    [ { -h | --help } ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

conninfo 、 backup_directory 、 wals_directory 、 archive_command などを含むサーバーに関する詳細情報を表示します。構成されているすべてのサーバーに関する情報を表示するには、サーバー名の代わりに all ショートカットを指定します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman status`#

概要#

status
    [ { -h | --help } ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

状態、Postgresバージョン、WAL情報、使用可能なバックアップなどの詳細を含むサーバーのステータスに関する情報を表示します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman switch-wal`#

概要#

switch-wal
    [ --archive ]
    [ --archive-timeout ]
    [ --force ]
    [ { -h | --help } ]
    SERVER_NAME [ SERVER_NAME ... ]

説明#

ターゲットサーバーPostgresバージョン10以降で pg_switch_wal() を実行するか、 pg_switch_xlog() Postgresバージョン8.3〜9.6の場合を実行します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
--archive: 1つのWALファイルがアーカイブされるのを待機します。指定された時間以内にWALファイルがアーカイブされない場合デフォルト 30 秒、 Barmanは失敗終了コードで終了します。このオプションは、スタンバイサーバーでも使用できます。
--archive-timeout: タイムアウトになる前に、新しいWALファイルがアーカイブされるのをアーカイバーが待機する時間を秒単位で指定しますデフォルト 30 秒。このオプションは、スタンバイサーバーでも使用できます。
--force: pg_switch_wal() の前にCHECKPOINTを実行することにより、スイッチを強制します。

注釈

CHECKPOINTを実行すると、PostgresサーバーのI/O負荷が増加する可能性があるため、このオプションは注意して使用します。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman switch-xlog`#

説明#

switch-wal コマンドのエイリアス。

`barman sync-backup`#

概要#

sync-backup
    [ { -h | --help } ]
    SERVER_NAME BACKUP_ID

説明#

このコマンドは、サーバーノードに存在するバックアップからすべてのファイルをコピーすることにより、パッシブノードをプライマリと同期します。これはパッシブノードでのみ利用でき、 primary_ssh_command オプションを使用してプライマリノードとの安全な接続を確立します。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
BACKUP_ID: barmanカタログのバックアップのID。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman sync-info`#

概要#

sync-info
    [ { -h | --help } ]
    [ --primary ]
    SERVER_NAME [ LAST_WAL [ LAST_POS ] ]

説明#

同期のために、 Barmanサーバーの現在のステータスに関する情報を収集します。

このコマンドは、正常に完了したすべてのバックアップ、アーカイブされたすべてのWALファイル、構成、 xlog.db から読み取られた最後のWALファイル、およびファイル内のその位置を含むサーバーのJSON出力を結果ます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
LAST_WAL: 指定されたファイルより前のWALファイルをスキップするようにsync-infoに指示しますインクリメンタル同期の場合。
LAST_POS: xlog.db ファイルにすばやく配置するためのヒントインクリメンタル同期用。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。
--primary: プライマリノードでsync-infoを実行します設定されている場合。

`barman sync-wals`#

概要#

sync-wals
    [ { -h | --help } ]
    SERVER_NAME

説明#

このコマンドは、サーバーノードからアーカイブされたすべてのWALファイルをコピーすることにより、パッシブノードをプライマリと同期します。これはパッシブノードでのみ利用でき、 primary_ssh_command オプションを使用してプライマリノードとの安全な接続を確立します。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman terminate-process`#

概要#

terminate-process SERVER_NAME TASK_NAME

説明#

barman terminate-process コマンドは、指定されたサーバーでアクティブなBarmanサブプロセスを終了します。ターゲットプロセスは、タスク名たとえば backup または receive-wal などで識別されます。サーバーレベルで実行中のプロセスのみを終了できるため、 cron や config-update のようなグローバルプロセスはこのコマンドでは終了できないことに注意してください。

barman list-processes の出力を使用して、特定のサーバーのアクティブなプロセスをすべて表示し、終了できるタスクを判断することもできます。このコマンドの詳細については、 barman list-processes を参照してください。

パラメーター#

SERVER_NAME: サブプロセスが実行されているサーバーの名前。
TASK_NAME: 終了するサブプロセスを識別するタスク名。

`barman verify-backup`#

概要#

verify-backup
    [ { -h | --help } ]
    SERVER_NAME BACKUP_ID

説明#

バックアップマニフェストファイルに対して pg_verifybackup を実行しますPostgresバージョン13以降で利用可能。 rsyncバックアップの場合、 generate-manifest コマンドを使用してマニフェストファイルを作成した後に使用できます。バックアップサーバーに pg_verifybackup をインストールする必要があります。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME: barmanノードのサーバーの名前
BACKUP_ID: barmanカタログのバックアップのID。
-h / --help: ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

`barman verify`#

説明#

verify-backup コマンドのエイリアス。

`barman-cli` コマンド#

barman-cli パッケージには、Postgresサーバーとともにインストールする必要がある推奨クライアントユーティリティのコレクションが含まれています。次に、両方のユーティリティのコマンドリファレンスを示します。

`barman-wal-archive`#

概要#

barman-wal-archive
    [ { -h | --help } ]
    [ { -V | --version } ]
    [ { -U | --user } USER ]
    [ --port PORT ]
    [ { { -z | --gzip } | { -j | --bzip2 } | --xz | --snappy | --zstd | --lz4 } ]
    [ --compression-level COMPRESSION_LEVEL ]
    [ { -c | --config } CONFIG ]
    [ { -t | --test } ]
    [ --md5 ]
    BARMAN_HOST SERVER_NAME WAL_PATH

説明#

このスクリプトは、 Postgresサーバーの archive_command で利用でき、 put-wal コマンドBarman 2.6で紹介を使用してWALファイルをBarmanホストに転送できます。 BarmanホストへのSSH接続を確立し、Postgresクラスター内でのBarmanのシームレスな統合を可能にして、ビジネスの継続性を向上させます。

Exit Statuses は次のとおりです。

SUCCESS の場合は 0 。
FAILURE の場合は non-zero 。

パラメーター#

SERVER_NAME: WALファイルが取得されるPostgresサーバーのBarmanで構成されたサーバー名。
BARMAN_HOST: Barmanサーバーのホスト。
WAL_PATH: '%p'キーワードの値 archive_command によると。
-h / --help: ヘルプメッセージを表示して終了します。
-V / --version: プログラムのバージョン番号を表示して終了します。
-U / --user: BarmanサーバーへのSSH接続のユーザーを指定しますデフォルトは barman 。
--port: BarmanサーバーへのSSH接続に使用されるポートを定義します。
-z / --gzip: Barmanサーバーに送信する前に、WALファイルをgzip圧縮します。
-j / --bzip2: Barmanサーバーに送信する前に、WALファイルをbzip2圧縮します。
--xz: Barmanサーバーに送信する前に、WALファイルをxz圧縮します。
--snappy: Barmanサーバーに送信する前に、WALファイルをsnamppy圧縮します python-snappy Pythonライブラリをインストールする必要があります。
--zstd: Barmanサーバーに送信する前に、WALファイルをzstd圧縮します zstandard Pythonライブラリをインストールする必要があります。
--lz4: Barmanサーバーに送信する前に、WALファイルをlz4圧縮します lz4 Pythonライブラリをインストールする必要があります。
--compression-level: 選択した圧縮アルゴリズムで使用される圧縮レベル。有効な値は、選択したアルゴリズムまたは事前定義されたラベルのいずれか low 、 medium 、および high のサポートされている範囲内の整数です。各アルゴリズムの範囲と、各事前定義されたラベルがマップするレベルは low で見つかります。
-c / --config: Barmanサーバー上の構成ファイルを指定します。
-t / --test: Barmanで指定されたPostgresサーバーの接続と構成をテストして、WALファイルを受信する準備ができていることを確認します。このオプションは、必須引数 WAL_PATH を無視します。
--md5: Barmanサーバーに送信するときにWALファイルのチェックサムを計算するハッシュアルゴリズムとしてSHA256の代わりにMD5を使用します。 Barmanサーバーの古いバージョンはMD5のみをサポートしていたため、これは古いサーバーバージョンとの互換性を維持するために使用されます。

注釈

barman-wal-archive で圧縮が有効になっている場合、 Barmanサーバーで構成された圧縮設定が異なる場合、それが優先されます。

重要

barman-wal-archive で圧縮が有効になっている場合、ファイルがBarmanに送信される前に、クライアント側で実行されます。圧縮率を高くするとWALのシッピングが遅延し、WALファイルが蓄積される可能性があるため、データベースサーバーの負荷と選択した圧縮アルゴリズムとレベルに注意してください。

`barman-wal-restore`#

概要#

barman-wal-restore
    [ { -h | --help } ]
    [ { -V | --version } ]
    [ { -U | --user } USER ]
    [ --port PORT ]
    [ { -s | --sleep } SECONDS ]
    [ { -p | --parallel } JOBS ]
    [ --spool-dir SPOOL_DIR ]
    [ { -P | --partial } ]
    [ { { -z | --gzip } | { -j | --bzip2 } | --keep-compression } ]
    [ { -c | --config } CONFIG ]
    [ { -t | --test } ]
    BARMAN_HOST SERVER_NAME WAL_NAME WAL_DEST

説明#

このスクリプトは、 Postgresサーバーの restore_command として機能し、Barmanの get-wal 機能を介してWALファイルの取得を有効にします。 BarmanホストへのSSH接続を確立し、Postgresクラスター内でのBarmanの統合を促進し、ビジネス継続性を強化します。

Exit Statuses は次のとおりです。

SUCCESS の場合は 0 。
リモート get-walコマンド FAILURE の場合 1 、おそらく要求されたWALが見つからないためです。
2 ssh接続の場合 FAILURE 。
FAILURE のその他の non-zero 。

パラメーター#

SERVER_NAME: WALファイルが取得されるPostgresサーバーのBarmanで構成されたサーバー名。
BARMAN_HOST: Barmanサーバーのホスト。
WAL_NAME: '%f'キーワードの値 restore_command によると。
WAL_DEST: '%p'キーワードの値 restore_command によると。
-h / --help: ヘルプメッセージを表示して終了します。
-V / --version: プログラムのバージョン番号を表示して終了します。
-U / --user: BarmanサーバーへのSSH接続のユーザーを指定しますデフォルトは barman 。
--port: BarmanサーバーへのSSH接続に使用されるポートを定義します。
-s / --sleep: get-wal 要求が失敗した後、 SECONDS のために一時停止しますデフォルトは 0 - 待機なし。
-p / --parallel: ファイルの数を peek に指定し、同時に転送しますデフォルトでは 0 -無効になっています。
--spool-dir: WALファイルのスプールディレクトリを指定しますデフォルトで /var/tmp/walrestore 。
-P / --partial: 取得には部分的なWALファイル.partialを含めます。
-z / --gzip: gzip で圧縮したWALファイルを転送します。
-j / --bzip2: bzip2 で圧縮したWALファイルを転送します。
--keep-compression: 指定すると、圧縮ファイルはそのまま転送され、クライアントサイドで到着時に解凍されます。
-c / --config: Barmanサーバー上の構成ファイルを指定します。
-t / --test: Barmanで指定されたPostgresサーバーの接続と構成をテストして、WALファイルを受信する準備ができていることを確認します。このオプションは、必須引数 WAL_NAME および WAL_DEST を無視します。

警告

コマンドリファレンス#

barman#

概要#

パラメーター#

ショートカット#

終了ステータス#

サブコマンド#

barman archive-wal#

概要#

説明#

パラメーター#

barman backup#

概要#

説明#

パラメーター#

barman check-backup#

概要#

説明#

パラメーター#

barman check#

概要#

説明#

パラメーター#

barman config-switch#

概要#

説明#

パラメーター#

barman config-update#

概要#

説明#

パラメーター#

例#

barman cron#

概要#

説明#

パラメーター#

barman delete#

概要#

説明#

パラメーター#

barman diagnose#

概要#

説明#

パラメーター#

barman generate-manifest#

概要#

説明#

パラメーター#

barman get-wal#

概要#

説明#

パラメーター#

barman keep#

概要#

説明#

パラメーター#

barman list-backups#

概要#

説明#

パラメーター#

barman list-files#

概要#

説明#

パラメーター#

barman list-processes#

概要#

説明#

パラメーター#

barman list-servers#

概要#

説明#

パラメーター#

barman lock-directory-cleanup#

概要#

説明#

パラメーター#

barman put-wal#

概要#

説明#

パラメーター#

`barman`#

`barman archive-wal`#

`barman backup`#

`barman check-backup`#

`barman check`#

`barman config-switch`#

`barman config-update`#

`barman cron`#

`barman delete`#

`barman diagnose`#

`barman generate-manifest`#

`barman get-wal`#

`barman keep`#

`barman list-backups`#

`barman list-files`#

`barman list-processes`#

`barman list-servers`#

`barman lock-directory-cleanup`#

`barman put-wal`#

`barman rebuild-xlogdb`#

`barman recover`#

`barman receive-wal`#

`barman restore`#

`barman replication-status`#

`barman show-backup`#

`barman show-servers`#

`barman status`#

`barman switch-wal`#

`barman switch-xlog`#

`barman sync-backup`#

`barman sync-info`#

`barman sync-wals`#

`barman terminate-process`#

`barman verify-backup`#

`barman verify`#

`barman-cli` コマンド#

`barman-wal-archive`#

`barman-wal-restore`#