Zero Downtime Migration ZDMCLIコマンドのリファレンス

F Zero Downtime Migration ZDMCLIコマンドのリファレンス

ZDMCLIは、Zero Downtime Migration移行操作のコマンドライン・インタフェースです。

ZDMCLIコマンドを実行するには、Zero Downtime Migrationソフトウェア・ホームの/binディレクトリに移動し、次のトピックにリストされているコマンドのいずれかを入力します。次に例を示します。

zdmuser> $ZDM_HOME/bin/zdmcli migrate database

ZDMCLIコマンドのヘルプ・ページをリストするには、-helpオプションを使用します。次のコマンドは、すべてのZDMCLIコマンドのヘルプをリストします。

zdmuser> $ZDM_HOME/bin/zdmcli -help

Zero Downtime Migrationソフトウェアの現在のリリース情報を取得するには、-buildオプションを指定してZDMCLIを実行します。

zdmuser> $ZDM_HOME/bin/zdmcli -build

次の各トピックでは、Zero Downtime Migration ZDMCLIコマンドの使用方法およびオプションについて説明します。

ZDMCLIのオプション

コマンドを指定せずにZDMCLIでオプションを実行できます。

構文

$ZDM_HOME/bin/zdmcli -option

オプション

表F-1 ZDMCLIのオプション

オプション	説明
-build	Zero Downtime Migrationのバージョン情報(クラウド移行前アドバイザ・ツールのバージョンなど)を返します。

abort job

指定されたジョブが実行中の場合は、それを終了します。

構文

$ZDM_HOME/bin/zdmcli abort job
  -jobid job_id

オプション

表F-2 ZDMCLI abort jobのオプション

オプション	説明
-jobid job_id	スケジュール済ジョブの一意のジョブID値(整数)。ジョブIDは、ジョブのスケジュール時に割り当てられます。

add imagetype

指定された名前の新しいイメージ・タイプとそれに関連するユーザー・アクションを構成します。

構文

$ZDM_HOME/bin/zdmcli add imagetype
  -imagetype image_type
  -basetype CUSTOM_PLUGIN
  [-useractions user_action_list]

オプション

表F-3 ZDMCLI add imagetypeのオプション

オプション説明

オプション	説明
`-imagetype image_type`	作成されるイメージ・タイプの名前
`-basetype CUSTOM_PLUGIN`	イメージ・タイプが作成されるベース・イメージ・タイプ `CUSTOM_PLUGIN`はこの必須引数に有効な唯一の値であることに注意してください。
`-useractions user_action_list`	ユーザー・アクション名のカンマ区切りリスト

-imagetype image_type

作成されるイメージ・タイプの名前

-basetype CUSTOM_PLUGIN

イメージ・タイプが作成されるベース・イメージ・タイプ

CUSTOM_PLUGINはこの必須引数に有効な唯一の値であることに注意してください。

-useractions user_action_list

ユーザー・アクション名のカンマ区切りリスト

add useraction

指定した名前の新しいユーザーアクションとそれに関連するスクリプトおよびアクション・ファイルを構成します。

構文

$ZDM_HOME/bin/zdmcli add useraction
  -useraction user_action_name 
  -actionscript script_name 
  [-actionfile file_name] 
  {-pre | -post}
  -optype MIGRATE_DATABASE 
  [-phase operation_phase]
  [-onerror {ABORT | CONTINUE}]
  [-runscope
     {ONENODE |
      ALLNODES |
      AUTO}]
  [-outputfrom useraction_names]

オプション

表F-4 ZDMCLI add useractionのオプション

オプション	説明
`-useraction user_action_name`	ユーザー・アクションの名前
`-actionscript script_name`	実行するスクリプト・ファイル
`-actionfile file_name`	ユーザー・アクションに関連付けられ、必要となるファイル
`-pre`	操作の前にユーザー・アクションを実行します
`-post`	操作の後にユーザー・アクションを実行します
`-optype MIGRATE_DATABASE`	ユーザー・アクションが`MIGRATE_DATABASE`として構成される操作を定義します。
`-phase phase_of_operation`	ユーザー・アクションが構成される移行操作フェーズ
`-onerror {ABORT \| CONTINUE}`	実行中にユーザー・アクションでエラーが発生した場合のレスポンス
`-runscope {ONENODE \| ALLNODES \| AUTO}`	ユーザー・アクションが実行されるサーバー。 AUTOは、他のコマンド・オプションに基づいて実行範囲を選択する場合に指定します。
`-outputfrom useraction_names`	現在のユーザー・アクションに出力を指定するユーザー・アクション名のカンマ区切りリスト。

例

詳細は、ユーザー・アクションの登録を参照してください。

migrate database

Oracle Cloudへのデータベースの移行を実行します。

構文

$ZDM_HOME/bin/zdmcli migrate database  
  [-sourcedb db_name |
     -sourcesid source_oracle_sid}
  -rsp zdm_template_path
  -sourcenode source_host_name
  -targetnode target_host_name
  [-targethome target_home] 
  [-eval] 
  [-tdekeystorepasswd
     [-tgttdekeystorepasswd]] 
  [-tdemasterkey] 
  [-useractiondata user_action_data]
  [-imagetype] 
  [-backupuser user_name]
  [-dvowner database_vault_owner]   [-backuppasswd]
  [-tdewallet wallet_path
     [-tgttdewallet wallet_path]] 
  [-tdekeystorewallet tde_wallet_path
     [-tgttdekeystorewallet tde_wallet_path]]
  [-sourcesyswallet sys_wallet_path]
  [-osswallet oss_wallet_path]
  [-dvwallet dv_wallet_path] 
  [-backupwallet backup_wallet_path] 
  [{-srcroot |
     -srccred cred_name |
     -srcuser user_name |
     {-srcsudouser sudo_user_name -srcsudopath sudo_binary_path} |
        {-srcauth plugin_name 
            [-srcarg1 user:source_database_server_login_user_name 
             -srcarg2 identity_file:ZDM_installed_user_private_key_file_location 
             -srcarg3 sudo_location:sudo_location]}}]
  {-tgtroot |
     -tgtcred cred_name |
     -tgtuser user_name |
     {-tgtsudouser sudo_user_name -tgtsudopath sudo_binary_path} |
       {-tgtauth plugin_name 
          [-tgtarg1 user:target_database_server_login_user_name
           -tgtarg2 identity_file:ZDM_installed_user_private_key_file_location  
           -tgtarg3 sudo_location:sudo_location]}} 
  [-schedule {timer_value | NOW}] 
  [-pauseafter phase] 
  [-stopafter phase]
  [-listphases] 
  [-ignoremissingpatches patch_name
     [,patch_name...]] 
  [-ignore {ALL | WARNING | PATCH_CHECK}]
  [-incrementalinterval timer_minutes] 
  [-advisor |
     -ignoreadvisor |
     -skipadvisor]  [-genfixup {YES | NO}]

オプション

表F-5 ZDMCLI migrate databaseのオプション

オプション	説明
`-advisor`	`-eval`と同様に、`migrate database`は、移行ジョブでクラウド移行前アドバイザ・ツール(CPAT)を排他的に実行するために必要な最小限のフェーズを実行します。実際にはソースおよびターゲットに対して移行ジョブを実行しません
`-backuppasswd password`	物理移行では、次のことができます 1. 提供されたバックアップ・パスワードを使用したRMANバックアップの作成 2. バックアップ・パスワード認証での既存のRMANバックアップの使用
`-backupuser user_name`	データベースのバックアップまたはリストアを許可されたユーザーの名前
`-backupwallet backup_wallet_path`	RMANバックアップ・パスワードを含む、Zero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-dvowner database_vault_owner`	SYS権限の付与または取消しが許可されたOracle Database Vault所有者の名前
`-dvwallet dv_wallet_path`	Oracle Database Vault所有者の資格証明を含む、Zero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-eval`	実際にはソースおよびターゲットに対して移行ジョブを実行せずに、移行ジョブを評価します
`-genfixup {YES \| NO}`	クラウド移行前アドバイザ・ツール(CPAT)を有効にして移行を実行したときに、失敗したチェックの修正スクリプトを表示します。ソース・データベースで自動的に実行できる処置が実行されます。 Zero Downtime MigrationでサポートされるCPATユースケースについては、クラウド移行前アドバイザ・ツールのサポートを参照してください。
`-ignore {ALL \| WARNING \| PATCH_CHECK}`	すべてのチェックまたは特定のタイプのチェックを無視します
`-ignoreadvisor`	クラウド移行前アドバイザ・ツール(CPAT)を実行しますが、CPATによって生成されたエラーは無視されます。
`-ignoremissingpatches`	ソース・パスまたは作業用コピーに存在する指定のパッチが宛先パスまたは作業用コピーから欠落している可能性がある場合でも、移行を続行します
`-imagetype image_type`	ユーザー・アクション・イメージ・タイプの名前
`-incrementalinterval timer_minutes`	間隔(分単位)ごとに定期的な増分RMANバックアップを実行します
`-listphases`	移行ジョブのフェーズをリストします
`-osswallet oss_wallet_path`	Object Storage Service (OSS)バックアップ・ユーザーの資格証明を含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-pauseafter phase`	指定されたフェーズの実行後にジョブを一時停止します
`-rsp zdm_template_path`	Zero Downtime Migrationのレスポンス・ファイルの場所
`-schedule timer_value`	移行を実行するスケジュールされた時間(ISO-8601形式)。たとえば、`2016-12-21T19:13:17+05`
`-skipadvisor`	移行ジョブのCPATフェーズをスキップします
`-sourcedb db_name`	移行するソース・データベースの名前
`-sourcenode source_host_name`	ソース・データベースが実行されているホスト
`-sourcesid source_oracle_sid`	Grid Infrastructureを使用しないソースのシングル・インスタンス・データベースの`ORACLE_SID`
`-sourcesyswallet sys_wallet_path`	ソース・データベースの`SYS`パスワードを含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-srcauth plug-in_name [plug-in_args]`	`zdmauth`認証プラグインを使用してソース・データベース・サーバーにアクセスし、次の引数を入力します。 `-srcarg1 user:source_database_server_login_user_name -srcarg2 identity_file:ZDM_installed_user_private_key_file_location -srcarg3 sudo_location:sudo_location` sudoの場所を指定しない場合、Zero Downtime Migrationによってデフォルト(/usr/bin/sudo)が使用されます。
`-srccred cred_name`	ソース・データベース・サーバーにアクセスするためのユーザー名およびパスワード資格証明を関連付ける資格証明名
`-srcroot`	`root`資格証明を使用してソース・データベース・サーバーにアクセスするようZero Downtime Migrationに指示します
`-srcsudopath sudo_binary_path`	ソース・データベース・サーバー上の`sudo`バイナリの場所
`-srcsudouser user_name`	ソース・データベース・サーバー上で`sudo`ユーザー名としてスーパーユーザーの操作を実行します
`-srcuser user_name`	ソース・データベース・サーバーで操作を実行する特権ユーザーの名前
`-stopafter phase`	指定したフェーズでワークフローを切り捨てて、指定したフェーズの完了時に移行ジョブに完了ステータスのマークを付けます。このフェーズを超えてジョブを再開するオプションはありません。たとえば、Data Guardの設定後にワークフローを停止する場合、`-stopafter ZDM_CONFIGURE_DG_SRC`を指定すると、このフェーズでジョブが停止し、`ZDM_CONFIGURE_DG_SRC`が正常に完了するとジョブに完了のマークが付けられます。
`-targethome target_home`	ターゲット・データベース`ORACLE_HOME`の場所
`-targetnode target_host_name`	ソース・データベースの移行先となるターゲット・サーバー
`-tdekeystorepasswd`	透過的データ暗号化(TDE)キーストアのパスワード(パスワードベースのキーストアまたはウォレットでは必須)
`-tdekeystorewallet tde_wallet_path`	透過的データ暗号化(TDE)キーストア・パスワードを含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-tdemasterkey`	透過的データ暗号化(TDE)マスター暗号化キー
`-tdewallet wallet_path`	透過的データ暗号化(TDE)キーストア・パスワードを含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-tgtauth plugin_name [plugin_args]`	`zdmauth`認証プラグインを使用してターゲット・データベース・サーバーにアクセスし、次の引数を入力します。 `-tgtarg1 user:target_database_server_login_user_name -tgtarg2 identity_file:ZDM_installed_user_private_key_file_location -tgtarg3 sudo_location:sudo_location` sudoの場所を指定しない場合、Zero Downtime Migrationによってデフォルト(/usr/bin/sudo)が使用されます。
`-tgtcred cred_name`	ターゲット・データベース・サーバーにアクセスするためのユーザー名およびパスワード資格証明を関連付ける資格証明名
`-tgtroot`	`root`資格証明を使用してターゲット・データベース・サーバーにアクセスします
`-tgtsudopath sudo_binary_path`	ターゲット・データベース・サーバー上の`sudo`バイナリの場所
`-tgtsudouser user_name`	ターゲット・データベース・サーバー上で`sudo`ユーザー名としてスーパーユーザーの操作を実行します
`-tgttdekeystorepasswd`	ターゲット・コンテナ・データベースのTDEキーストア・パスワード
`-tgttdekeystorewallet tde_wallet_path`	ターゲットのTDEキーストア・パスワードを含む、Zero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
`-tgttdewallet wallet_path`	透過的データ暗号化(TDE)キーストア・パスワードを含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス非マルチテナント・ソース・データベースをターゲット上のマルチテナント・アーキテクチャ、つまりプラガブル・データベース(PDB)に変換する場合は、ターゲット・コンテナ・データベース(CDB)のTDEキーストア・パスワード用の自動ログイン・ウォレットを作成することもできます。
`-tgtuser user_name`	ターゲット・データベース・サーバーで操作を実行するユーザーの名前
`-useractiondata user_action_data`	ユーザー・アクション・スクリプトのuseractiondataパラメータに渡される値

例

Autonomous Database移行用のZDMCLI migrate databaseのオプション:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -rsp file_path -sourcenode host
 -srcauth zdmauth -srcarg1 user:username -srcarg2 identity_file:ssh_key_path
 -srcarg3 sudo_location:sudo_path -eval [-advisor [-ignoreadvisor] | -skipadvisor]]

共同管理データベース移行用のZDMCLI migrate databaseのオプション:

zdmuser> $ZDM_HOME/bin/zdmcli migrate database -rsp file_path -sourcenode host
 -srcauth zdmauth -srcarg1 user:username -srcarg2 identity_file:ssh_key_path
 -srcarg3 sudo_location:sudo_path -targetnode host -tgtauth zdmauth
 -tgtarg1 user:username -tgtarg2 identity_file:ssh_key_path 
 -tgtarg3 sudo_location:sudo_path -eval [-advisor [-ignoreadvisor] | -skipadvisor]]

modify useraction

指定された名前でユーザー・アクションの構成を変更します。

構文

$ZDM_HOME/bin/zdmcli modify useraction
  -useraction user_action_name 
  [-actionscript script_name] 
  [-actionfile file_name] 
  [-pre | -post] 
  [-optype MIGRATE_DATABASE] 
  [-phase phase] 
  [-onerror {ABORT | CONTINUE}] 
  [-runscope 
     {ONENODE |
      ALLNODES |
      AUTO}]
  [-outputfrom useraction_names]

オプション

表F-6 ZDMCLI modify useractionのオプション

オプション	説明
`-useraction user_action_name`	ユーザー・アクションの名前
`-actionscript script_name`	実行するスクリプト・ファイル
`-actionfile file_name`	ユーザー・アクションに必要な付属ファイル
`-pre`	操作の前にユーザー・アクションを実行します
`-post`	操作の後にユーザー・アクションを実行します
`-optype MIGRATE_DATABASE`	ユーザー・アクションが`MIGRATE_DATABASE`として構成される操作を定義します
`-onerror {ABORT \| CONTINUE}`	ユーザー・アクションの実行中にエラーが発生した場合に実行を停止するか継続するかを定義します
`-runscope {ONENODE \| ALLNODES \| AUTO}`	ユーザー・アクションが実行されるサーバー。 AUTOは、他のコマンド・オプションに基づいて実行範囲を選択する場合に指定します。
`-outputfrom useraction_names`	現在のユーザー・アクションに出力を指定するユーザー・アクション名のカンマ区切りリスト。

query job

スケジュールされた移行ジョブの現在のステータスを取得します。

構文

$ZDM_HOME/bin/zdmcli query job
  [-jobid job_id
     [-jobtype]] 
  [-sourcenode source_host_name
     [-sourcedb db_name |
     -sourcesid sid]]
  [-targetnode target_host_name]
  [-latest]
  [-eval |
  -migrate] 
  [-status 
     {SCHEDULED |
      EXECUTING |
      UNKNOWN |
      TERMINATED |
      FAILED |
      SUCCEEDED |
      PAUSED |
      ABORTED}] 
  [-phase]
  [-dbname database_name] 
  [-since timer_value] 
  [-upto timer_value] 
  [-brief]
  [-statusonly]

オプション

表F-7 ZDMCLI query jobのオプション

オプション	説明
`-jobid job_id`	スケジュールされた移行ジョブの一意のジョブID値(整数) ジョブIDは、移行ジョブのスケジュール時に割り当てられます。
`-job_type`	スケジュール済ジョブのタイプを返します
`-sourcenode source_host_name`	ソース・データベースが実行されているサーバー
`-sourcedb db_name`	移行されるソース・データベースの名前
`-sourcesid sid`	Grid Infrastructureを使用しないソースのシングル・インスタンス・データベースの`ORACLE_SID`
`-targetnode target_host_name`	データベースの移行先となるターゲット・サーバー
`-latest`	指定された基準に一致する最新のジョブを返します
`-eval`	評価ジョブのみを返します
`-migrate`	移行ジョブのみを返します
`-status {SCHEDULED \| EXECUTING \| UNKNOWN \| TERMINATED \| FAILED \| SUCCEEDED \| PAUSED \| ABORTED}`	指定されたジョブ・ステータスに一致するジョブを返します
`-phase`	指定されたフェーズのステータスを返します。ユーザーが指定したフェーズが無効の場合、問合せはエラーを返します。 `./zdmcli query job -jobid 33 -phase ZDM_PREUSERACTIONS_TGT -statusonly # exmaple.com: Audit ID: 153 # Job ID: 33 # ZDM_PREUSERACTIONS_TGT:PENDING`
`-dbname unique_db_name`	データベースの`DB_UNIQUE_NAME`値を指定します
`-since timer_value`	ジョブの取得を開始する日付(ISO-8601形式)。例: 2016-12-21T19:13:17+05
`-upto timer_value`	ジョブを取得する上限時間(ISO-8601形式)。例: 2016-12-21T19:13:17+05
`-brief`	ジョブ詳細サマリーのみを返します
`-statusonly`	ジョブ・ステータスと現在のフェーズ名のみを返します

使用上の注意

現在の実行が、PAUSED移行ジョブの再開、FAILED移行ジョブの再開または移行ジョブの新規開始のいずれであるかを識別するには、次のオプションを使用します。

zdmcli query job -latestは、job_typeを考慮せずに最新のジョブを取得します
zdmcli query job -latest -migrateは、最新の非評価移行ジョブを取得します
zdmcli query job -latest -evalは、最新の評価移行ジョブを取得します

query useraction

ユーザー・アクションの構成を表示します。

構文

$ZDM_HOME/bin/zdmcli query useraction
    [-useraction user_action_name | -imagetype image_type
    [-optype MIGRATE_DATABASE]]

オプション

表F-8 ZDMCLI query useractionのオプション

オプション	説明
`-useraction user_action_name`	ユーザー・アクションの名前
`-imagetype image_type`	イメージ・タイプ名を指定します
`-optype MIGRATE_DATABASE`	ユーザー・アクションが構成される操作

resume job

一時停止された指定のジョブを再開します。

構文

$ZDM_HOME/bin/zdmcli resume job
  -jobid job_id
  [-pauseafter pause_phase | 
   -rsp zdm_logical_template_path]

オプション

表F-9 ZDMCLI resume jobのオプション

オプション	説明
`-jobid job_id`	スケジュール済ジョブの一意のジョブID値(整数) ジョブIDは、移行ジョブのスケジュール時に割り当てられます。
`-pauseafter pause_phase`	指定されたフェーズの実行後に移行ジョブを一時停止します

`-rsp zdm_logical_template_path`	再開時にZDMによって取得されるパラメータを変更した場合は、移行レスポンス・ファイルを指定します。このオプションは、論理移行ジョブでのみ使用できます。

使用上の注意

移行ジョブの再開を参照してください

suspend job

指定したジョブを一時停止します(実行中の場合)。suspend jobを実行すると、現在のワークフロー・フェーズで進行中のジョブが停止します。ジョブは後で再開できます。

コマンドsuspend jobは、物理移行ジョブにのみ適用されます。

構文

$ZDM_HOME/bin/zdmcli suspend job
  -jobid job_id

オプション

表F-10 ZDMCLI suspend jobのオプション

オプション説明

オプション	説明
`-jobid job_id`	一意のジョブID値(整数) ジョブID番号は、移行ジョブのスケジュール時に割り当てられます。

-jobid job_id

一意のジョブID値(整数)

ジョブID番号は、移行ジョブのスケジュール時に割り当てられます。