wsadmin スクリプトを使用する AdminTask オブジェクトの RepositoryCheckpointCommands コマンド・グループ
Jython または Jacl スクリプト言語を使用して、 チェックポイントの作成、復元、削除、および管理を wsadmin ツールによって行うことができます。 リポジトリー・チェックポイントは、構成変更が行われる前に保存されたリポジトリーの イメージを表します。RepositoryCheckpointCommands コマンド・グループ のコマンドは、wsadmin のローカル・モードおよび接続モードでリポジトリー・チェックポイント機能 をサポートします。
マスター構成リポジトリーからのファイルのコピーを バックアップするために、チェックポイントを構成することができます。フル・チェックポイント は、 構成リポジトリー全体の完全なコピーです。デルタ・チェックポイント は、 製品の構成を変更したときに作成される、構成リポジトリーのサブセット・スナップショットです。チェックポイントは構成リポジトリーを 以前の状態に復元するために使用されます。
自動チェックポイントを使用可能にするには、setAutoCheckpointEnabled コマンド を使用し、-autoCheckpointEnabled を true に設定します。構成リポジトリー に変更が加えられるたびに、1 つのデルタ・チェックポイントが製品によって 作成されます。このコマンドを実行した後にサーバーを再始動する 必要はありません。自動チェックポイント機能が使用可能になった後は、 何らかの構成変更が行われ、構成リポジトリーに保存されると、profile_root/checkpoints ディレクトリー 内にデルタ・チェックポイントが自動的に作成されます。本製品では構成リポジトリーは profile_root/config ディレクトリーに保管されます。 アプリケーション・サーバーの作成や構成変更の保存などの操作 が行われると、デルタ・チェックポイントが作成されます。チェックポイントは、 構成変更が行われる前のリポジトリーのイメージを保持したものです。
構成リポジトリーを変更するコマンドが実行された後、 構成変更は製品によって自動的に保存されます。createFullCheckpoint、deleteCheckpoint、restoreCheckpoint、setAutoCheckpointDepth、setAutoCheckpointEnabled、 または setCheckpointLocation などのコマンドを実行した後に、AdminConfig.save() を実行する必要はありません。
createFullCheckpoint
createFullCheckpoint コマンド を使用して、フル・チェックポイントを作成します。-checkpointName 値を指定して、 フル・チェックポイントに名前を付けます。
ターゲット・オブジェクト
なし
必須パラメーター
- -checkpointName
- フル・チェックポイントの名前を指定します。(ストリング、必須)
コマンドが正常に実行されると、-checkpointName 値 が戻されます。
オプション・パラメーター
- -checkpointDesc
- フル・チェックポイントの説明を指定します。(ストリング、オプション)
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createFullCheckpoint('[-checkpointName full2 -checkpointDesc "a test"]')
- Jython リストを使用:
AdminTask.createFullCheckpoint(['-checkpointName', 'full2'])
対話モードの使用例
- Jython を使用:
AdminTask.createFullCheckpoint('[-interactive]')
deleteCheckpoint
deleteCheckpoint コマンド を使用して、-checkpointName 値で指定されたチェックポイントを削除 します。任意のフル・チェックポイントを 削除できます。デルタ・チェックポイントに関しては、最も古いデルタ・チェックポイント のみを削除できます。
ターゲット・オブジェクト
なし
必須パラメーター
- -checkpointName
- 削除するチェックポイントの名前を指定します。
削除対象の任意のフル・チェックポイントの
名前を指定できます。(ストリング、必須)注: デルタ・チェックポイントを削除する場合は、 最も古いデルタ・チェックポイントの名前を指定しなければなりません。
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteCheckpoint('[-checkpointName full2]')
- Jython リストを使用:
AdminTask.deleteCheckpoint(['-checkpointName', 'full2'])
対話モードの使用例
- Jython を使用:
AdminTask.deleteCheckpoint('[-interactive]')
extractRepositoryCheckpoint
extractRepositoryCheckpoint コマンドを使用して、デルタ・リポジトリー・チェックポイントを抽出します。 抽出するリポジトリーを -checkpointName に指定する値で 指示し、抽出したチェックポイント・ファイルを保持する圧縮ファイルの絶対パス名を -extractToFile の値で 指定します。
ターゲット・オブジェクト
なし
必須パラメーター
- -checkpointName
- 抽出するリポジトリー・チェックポイントの名前を指定します。デルタ・リポジトリー・チェックポイントのみを抽出できます。 (ストリング、必須)
- -extractToFile
- 抽出されたリポジトリー・チェックポイントが入れられる圧縮ファイルの名前と ターゲット・ロケーションを指定します。圧縮ファイルの 名前には .zip または .jar が 拡張子として付いていても、拡張子がなくてもかまいません。(ストリング、必須)
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.extractRepositoryCheckpoint('[-checkpointName Delta-132 -extractToFile /temp/test1.zip]')
AdminTask.extractRepositoryCheckpoint('[-checkpointName Delta-132 -extractToFile c:/temp/test1.zip]')
- Jython リストを使用:
AdminTask.extractRepositoryCheckpoint(['-checkpointName', 'Delta2', '-extractToFile', '/temp/test1.zip'])
AdminTask.extractRepositoryCheckpoint(['-checkpointName', 'Delta2', '-extractToFile', 'c:/temp/test1.zip'])
対話モードの使用例
- Jython を使用:
AdminTask.extractRepositoryCheckpoint('[-interactive]')
getAutoCheckpointDepth
getAutoCheckpointDepth コマンド を使用して、製品が保持する自動デルタ・チェックポイントの数を取得 します。デルタ・チェックポイントの数に達したら、製品は、新規デルタ・チェックポイントが作成されるたびに、最も古いデルタ・チェックポイントを削除します。このコマンド は、保持される自動デルタ・チェックポイントの数を戻します。
ターゲット・オブジェクト
なし
必須パラメーター
なし
オプション・パラメーター
なし
使用例
print AdminTask.getAutoCheckpointDepth()
getAutoCheckpointEnabled
getAutoCheckpointEnabled コマンド を使用して、デルタ・チェックポイントの自動作成が使用可能になっているかどうかを判別します。 このコマンドは、自動チェックポイントが使用可能になっている場合は true を 戻し、自動チェックポイントが使用不可になっている場合は false を 戻します。
ターゲット・オブジェクト
なし
必須パラメーター
なし
オプション・パラメーター
なし
使用例
print AdminTask.getAutoCheckpointEnabled()
getCheckpointLocation
getCheckpointLocation コマンド を使用して、チェックポイントが保管されているディレクトリー・パスを取得します。このコマンド は、ディレクトリー・パスを戻します。本製品ではチェックポイントは profile_root/checkpoints ディレクトリーに保管されます。
ターゲット・オブジェクト
なし
必須パラメーター
なし
オプション・パラメーター
なし
使用例
print AdminTask.getCheckpointLocation()
getConfigRepositoryLocation
getConfigRepositoryLocation コマンド を使用して、構成リポジトリーが保管されているディレクトリー・パスを取得します。 このコマンドは、ディレクトリー・パスを戻します。本製品では構成リポジトリーは profile_root/config ディレクトリーに保管されます。
ターゲット・オブジェクト
なし
必須パラメーター
なし
オプション・パラメーター
なし
使用例
print AdminTask.getConfigRepositoryLocation()
listCheckpoints
listCheckpoints コマンド を使用して、既存のチェックポイントのリストを取得します。
ターゲット・オブジェクト
なし
必須パラメーター
なし
オプション・パラメーター
なし
使用例
print AdminTask.listCheckpoints()
出力例
full1(cells/MyCell/repository/checkpoints/full1|checkpoint.xml)
Delta-1323948371187(cells/MyCell/repository/checkpoints/Delta-1323948371187|checkpoint.xml)
Delta-1323904606781(cells/MyCell/repository/checkpoints/Delta-1323904606781|checkpoint.xml)
Delta-1323904256625(cells/MyCell/repository/checkpoints/Delta-1323904256625|checkpoint.xml)
listCheckpointDocuments
listCheckpointDocuments コマンド を使用して、特定のチェックポイント・リポジトリー内の文書のリストを取得します。-checkpointName 値 を指定して、文書リストを取得する元のチェックポイントを指示します。
ターゲット・オブジェクト
なし
必須パラメーター
- -checkpointName
- 文書リストを検索する対象のチェックポイントの名前を指定します。 (ストリング、必須)
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.listCheckpointDocuments('[-checkpointName Delta-132]')
- Jython リストを使用:
AdminTask.listCheckpointDocuments(['-checkpointName', 'Delta-132'])
対話モードの使用例
- Jython を使用:
AdminTask.listCheckpointDocuments('[-interactive]')
出力例
authorizationgroup.xml(cells/MyCell/repository/checkpoints/Delta-132|checkpoint.xml#CheckpointDocument_1325)
audit-authz.xml(cells/MyCell/repository/checkpoints/Delta-132|checkpoint.xml#CheckpointDocument_1326)
admin-authz.xml(cells/MyCell/repository/checkpoints/Delta-132|checkpoint.xml#CheckpointDocument_1327)
restoreCheckpoint
restoreCheckpoint コマンド を使用して、構成リポジトリーを、特定のチェックポイントが作成された時点の状態に 復元します。-checkpointName 値を指定 して、復元するフル・チェックポイントまたはデルタ・チェックポイントを指示します。
フル・チェックポイントは、構成リポジトリー全体をフル・チェックポイントが作成された時点の状態に 復元する場合に使用します。

チェックポイントを復元する際に、ワークスペースにコミットされていない変更があると、保存の矛盾が発生します。チェックポイントは復元されますが、コミットされていない変更内容を保存しようとすると、それらの変更内容には保存の矛盾を示すフラグが立てられます。また、 複数のユーザーがリポジトリーの構成変更の作業を行っている場合、 いずれかのユーザーがチェックポイントの復元を実行すると、まだ変更をコミットしていない他のユーザーでは保存の矛盾が発生します。
ターゲット・オブジェクト
なし
必須パラメーター
- -checkpointName
- 復元するチェックポイントの名前を指定します。(ストリング、必須)
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.restoreCheckpoint('[-checkpointName Delta-132]')
- Jython リストを使用:
AdminTask.restoreCheckpoint(['-checkpointName', 'Delta-132'])
対話モードの使用例
- Jython を使用:
AdminTask.restoreCheckpoint('[-interactive]')
setAutoCheckpointDepth
setAutoCheckpointDepth コマンド を使用して、保持するデルタ・チェックポイントの数を指定します。保存されたデルタ・チェックポイントの 数が、指定されたチェックポイント深さを超えると、最も古いデルタ・チェックポイント が削除され、指定されたチェックポイント深さを超えないように保たれます。
ターゲット・オブジェクト
なし
必須パラメーター
- -autoCheckpointDepth
- 保持する自動デルタ・チェックポイントの数を指定します。(整数、必須)
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.setAutoCheckpointDepth('[-autoCheckpointDepth 5]')
- Jython リストを使用:
AdminTask.setAutoCheckpointDepth(['-autoCheckpointDepth', '5'])
対話モードの使用例
- Jython を使用:
AdminTask.setAutoCheckpointDepth('[-interactive]')
setAutoCheckpointEnabled
setAutoCheckpointEnabled コマンド を使用して、自動デルタ・チェックポイントを使用可能または使用不可にします。自動リポジトリー・チェックポイント が使用可能になっている場合、構成リポジトリーに変更が加えられるたびに、1 つのデルタ・チェックポイント が製品によって作成されます。デルタ・チェックポイントの圧縮ファイル 内には、変更された構成ファイルのそれぞれについて、変更前バージョンと変更後バージョン が含まれます。圧縮ファイルの内容を解凍し、 解凍されたファイルを検査すれば、構成にどのような変更が加えられたのかを 判別できます。
setAutoCheckpointEnabled を 実行した後、設定した変更を有効にするためにサーバーを再始動する 必要はありません。
ターゲット・オブジェクト
なし
必須パラメーター
- -autoCheckpointEnabled
- 構成変更前の製品構成を自動的にリポジトリー・チェックポイントに保存する かどうかを指定します。値 true は、 自動チェックポイントを使用可能にします。デフォルトは値 false であり、 自動チェックポイントを使用不可にします。(ブール、必須)
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.setAutoCheckpointEnabled('[-autoCheckpointEnabled true]')
- Jython リストを使用:
AdminTask.setAutoCheckpointEnabled(['-autoCheckpointEnabled', 'true'])
対話モードの使用例
- Jython を使用:
AdminTask.setAutoCheckpointEnabled('[-interactive]')
setCheckpointLocation
setCheckpointLocation コマンド を使用して、チェックポイントが保管されるディレクトリー・パスを設定します。デフォルトでは、 チェックポイントは profile_root/checkpoints ディレクトリーに保管されます。
ターゲット・オブジェクト
なし
必須パラメーター
- -checkpointLocation
- チェックポイントが保管されるディレクトリー・パスを指定します。(ストリング、必須)
オプション・パラメーター
なし
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.setCheckpointLocation('[-checkpointLocation ${USER_INSTALL_ROOT}/checkpoints/temp]')
- Jython リストを使用:
AdminTask.setCheckpointLocation(['-checkpointLocation', '${USER_INSTALL_ROOT}/checkpoints/temp'])
対話モードの使用例
- Jython を使用:
AdminTask.setCheckpointLocation('[-interactive]')