バックアップのためのインポート/エクスポートスクリプトの使用 (Scheduler)¶
インポートスクリプトとエクスポートスクリプトは、プラットフォームの tools/scheduler
ディレクトリにあります。 import.sh
と export.sh
(Linux システム用) および import.bat
と export.bat
(Windows システム用) の 2 つのバージョンがあります。
エクスポート¶
export
スクリプトでは、Scheduler サーバーのすべてのメタデータと構成を zip ファイルまたは xml ファイルにエクスポートできます。エクスポートされるデータは、管理ツールの同等のオプション (「 Scheduler サーバーの構成 」のセクションを参照) で取得されるデータと同じです。
スクリプトを呼び出す形式は、以下のとおりです。
export -h host -p port -l login -P password [-mp <metadataPassword> ] [ -vdpauth ][ -L <project1, project2...> ]
[-xml] [ -dependencies ] [ -config ] [ -drivers ] [ -plugins ] [ -exportWithProperties ] [ -permissions ] -f outputFilename
ここで:
-h host
は、サーバーを起動するマシンの名前または IP アドレスです。
-p port
は、サーバーを起動するポート番号です。
-l login
は、サーバーに接続するために使用されるログイン名です。
-P password
は、サーバーに接続するために使用されるパスワードです。スクリプト encrypt_password
を使用してパスワードを暗号化することで、プレーンテキストによるパスワードの入力を避けることができます。暗号化したパスワードを渡す場合、先頭に encrypted:
を付加します (例: -P encrypted:Gr16MjvuXhRzPtPH/yTXHw==
)。
-mp metadataPassword
は、オプションの引数です。指定したパスワードを使用して、エクスポートされた機密メタデータの暗号化を行います。なお、スクリプト encrypt_password
を使用してパスワードを暗号化することで、プレーンテキストによるパスワードの入力を避けることができます。暗号化したパスワードを渡す場合、先頭に encrypted:
を付加します (例: -mp encrypted:Gr16MjvuXhRzPtPH/yTXHw==
)。
-vdpauth
はオプションの引数です。この引数を使用すると、特定のユーザーが「 Virtual DataPort の設定 」のセクションで構成された Virtual DataPort サーバーで認証されます。それ以外の場合は、ローカルの Scheduler で認証されます。
-L p1, p2...
はオプションの引数です。この引数を使用すると、名前付きのプロジェクトがエクスポートされます。それ以外の場合は、すべてのプロジェクトがエクスポートされます。
-xml
はオプションの引数です。この引数を使用すると、zip ファイルの代わりに xml ファイルがエクスポートされます。
-dependencies
はオプションの引数です。この引数を使用すると、選択したアイテムが依存するエレメントが含まれます。
-config
はオプションの引数です。この引数を使用すると、サーバー構成がエクスポートされます。
-drivers
はオプションの引数です。この引数を使用すると、JDBC アダプターがエクスポートされます。[export all projects] オプションを選択すると、すべての JDBC アダプターがエクスポートされます。そうでなければ、選択したプロジェクトで使用されるアダプターのみがエクスポートされます。
-plugins
はオプションの引数です。この引数を使用すると、プラグインがエクスポートされます。[export all projects] オプションを選択すると、すべてのプラグインがエクスポートされます。そうでなければ、選択したプロジェクトで使用されるプラグインのみがエクスポートされます。
-exportWithProperties
はオプションの引数です。この引数を使用すると、以下の処理が行われます。
エクスポートされる zip ファイルには 2 つのファイルが含まれます。一方にはメタデータが含まれ、もう一方にはサーバーが動作する環境に値が依存するパラメータの値が含まれます。
エクスポートされる xml ファイルには 2 つの固有のセクションが含まれます。このセクションには、このサーバーが稼働する環境に依存する値を持つパラメータの値が含まれます。
-permissions
はオプションの引数です。この引数を使用すると、ロールとアクセス許可がエクスポートされます。
-f outputFilename
は、エクスポートされたメタデータを含む zip ファイルまたは xml ファイルの名前です。
次の行は、エクスポートコマンドの実行例です。
export -h localhost -p 8000 -l admin -P admin -L default -f backup.zip
このコマンドは、ポート 8000 のローカルマシンで稼働している Scheduler サーバーの デフォルト プロジェクトのメタデータをエクスポートします。このサーバーにアクセスするには、ログイン admin
とパスワード admin
が使用されます。エクスポートの結果は、 backup.zip
というファイルに保存されます。
インポート¶
import
スクリプトでは、エクスポートユーティリティを使用して取得された zip ファイルまたは xml ファイルに含まれるメタデータと構成をインポートできます。
スクリプトを呼び出すために使用される形式は以下のとおりです。
import -h host -p port -l login -P password
-f inputFilename [ -pf <propertiesFile> ] [-mp <metadataPassword> ] [ -vdpauth ] [ -replace | [ -replaceJobs ] [ -replaceDataSources ]
[ -replacePlugins ] [ -replaceDrivers ] ]
ここで:
-h host
は、サーバーを起動するマシンの名前または IP アドレスです。
-p port
は、サーバーを起動するポート番号です。
-l login
は、サーバーに接続するために使用されるログイン名です。
-P password
は、サーバーに接続するために使用されるパスワードです。スクリプト encrypt_password
を使用してパスワードを暗号化することで、プレーンテキストによるパスワードの入力を避けることができます。暗号化したパスワードを渡す場合、先頭に encrypted:
を付加します (例: -P encrypted:Gr16MjvuXhRzPtPH/yTXHw==
)。
-mp metadataPassword
は、オプションの引数です。指定したパスワードを使用して、機密メタデータの復号を行います。なお、スクリプト encrypt_password
を使用してパスワードを暗号化することで、プレーンテキストによるパスワードの入力を避けることができます。暗号化したパスワードを渡す場合、先頭に encrypted:
を付加します (例: -mp encrypted:Gr16MjvuXhRzPtPH/yTXHw==
)。
-vdpauth
はオプションの引数です。この引数を使用すると、特定のユーザーが「 Virtual DataPort の設定 」のセクションで構成された Virtual DataPort サーバーで認証されます。それ以外の場合は、ローカルの Scheduler で認証されます。
-f inputFile
は、インポートするメタデータを含むファイルのパスです。
-pf propertiesFile
は、サーバーが稼働している環境に依存するパラメータの値を含むプロパティファイルのパスです。 -f
引数で指定されたファイル内にすでにプロパティファイルが含まれる場合は、 -pf
オプションが使用されても無視されます。
-replace
はオプションの引数であり、インポートされたファイルに含まれるエレメントで同名の既存のエレメントを置き換えるよう指定します。 -replace
オプションが使用されると、 -replaceXXX
オプション (後述) は無視されます。
-replaceJobs
はオプションの引数であり、インポートされたファイルに含まれるジョブで同名の既存のジョブを置き換えるよう指定します。
-replaceDataSources
はオプションの引数であり、インポートされたファイルに含まれるデータソースで同名の既存のデータソースを置き換えるよう指定します。
-replacePlugins
はオプションの引数であり、インポートされたファイルに含まれるプラグインで同名の既存のプラグインを置き換えるよう指定します。
-replaceDrivers
はオプションの引数であり、インポートされたファイルに含まれるドライバーで同名の既存のドライバーを置き換えるよう指定します。
例:
import -h localhost -p 8000 -l admin -P admin -f backup.zip -vdpauth -replace
この文は、 backup.zip
に含まれるメタデータをポート 8000 のローカルマシンで稼働しているサーバーにインポートします。サーバーへのアクセスにはログイン admin
とパスワード admin
が使用され、Virtual DataPort サーバーによりアクセスが認証されます。インポートの結果としてサーバーにより返される情報と警告メッセージはコンソールに記述されます。
注釈
-vdpauth
パラメータを使用する場合、バックアップをインポート/エクスポートするために使用されるユーザーは、これらのアクションを実行するためのアクセス許可を得られるよう、Virtual DataPort でロール scheduler_admin が割り当てられている必要があります。
これらのスクリプトは、エラーがない場合はコード 0 で終了し、それ以外の場合は 1 を返します。