1. Zero Downtime Migrationを使用したOracle Cloudへの移行
  2. Zero Downtime Migration ZDMCLIコマンドのリファレンス

H 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コマンドの使用方法およびオプションについて説明します。

  • abort job
    指定されたジョブが実行中の場合は、それを終了します。
  • add imagetype
    指定された名前の新しいイメージ・タイプとそれに関連するユーザー・アクションを構成します。
  • add useraction
    指定した名前の新しいユーザーアクションとそれに関連するスクリプトおよびアクション・ファイルを構成します。
  • migrate database
    Oracle Cloudへのデータベースの移行を実行します。
  • modify useraction
    指定された名前でユーザー・アクションの構成を変更します。
  • query job
    スケジュールされた移行ジョブの現在のステータスを取得します。
  • query useraction
    ユーザー・アクションの構成を表示します。
  • resume job
    一時停止された指定のジョブを再開します。
  • suspend job
    指定したジョブを一時停止します(実行中の場合)。suspend jobを実行すると、現在のワークフロー・フェーズで進行中のジョブが停止します。ジョブは後で再開できます。

abort job

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

構文

$ZDM_HOME/bin/zdmcli abort job
  -jobid job_id

オプション

表H-1 ZDMCLI abort jobのオプション

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

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

add imagetype

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

構文

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

オプション

表H-2 ZDMCLI add imagetypeのオプション

オプション 説明
-imagetype image_type

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

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

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

-useractions user_action_list

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

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

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}]

オプション

表H-3 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は、他のコマンド・オプションに基づいて実行範囲を選択する場合に指定します。

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

migrate database

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

構文

$ZDM_HOME/bin/zdmcli migrate database  
  -rsp zdm_template_path
  -sourcenode source_host_name
 [{-srcroot |
    -srccred cred_name |
    -srcuser user_name |
    {-srcsudouser sudo_user_name -srcsudopath sudo_binary_path} |
    {-srcauth plugin_name 
       [-srcarg1 name1:value1 
          [-srcarg2 name2:value2...]]}}]
 {-sourcedb db_name |
   -sourcesid source_oracle_sid}
  -targetnode target_host_name
{-tgtroot |
   -tgtcred cred_name |
   -tgtuser user_name |
   {-tgtsudouser sudo_user_name -tgtsudopath sudo_binary_path} |
   {-tgtauth plugin_name 
      [-tgtarg1 name1:value1 
         [-tgtarg2 name2:value2...]]}} 
  [-eval] 
  -backupuser user_name 
  [-targethome target_home] 
  [-imagetype] 
  [-tdekeystorepasswd] 
  [-tdemasterkey] 
  [-sourcesyswallet sys_wallet_path]
  [-osswallet oss_wallet_path]
  [-tdekeystorewallet tde_wallet_path]
  [-useractiondata user_action_data]
  [-schedule {timer_value | NOW}] 
  [-pauseafter phase] 
  [-stopafter phase]
  [-listphases] 
  [-ignoremissingpatches patch_name [,patch_name...]] 
  [-ignore {ALL | WARNING | PATCH_CHECK}]
  [-advisor | [-ignoreadvisor | -skipadvisor]]

オプション

表H-4 ZDMCLI migrate databaseのオプション

オプション 説明
-sourcedb db_name

移行するソース・データベースの名前
-sourcenode source_host_name

ソース・データベースが実行されているホスト
-targetnode target_host_name

ソース・データベースの移行先となるターゲット・サーバー
-targethome target_home

ターゲット・データベースORACLE_HOMEの場所
-imagetype image_type

ユーザー・アクション・イメージ・タイプの名前
-useractiondata user_action_data

ユーザー・アクション・スクリプトのuseractiondataパラメータに渡される値

-rsp zdm_template_path

Zero Downtime Migrationのレスポンス・ファイルの場所
-sourcesid source_oracle_sid

Grid Infrastructureを使用しないソースのシングル・インスタンス・データベースのORACLE_SID

-eval

ソースおよびターゲットに対して実際にmigrate databaseコマンドを実行せずに、移行ジョブを評価します。

-backupuser user_name

データベースのバックアップまたはリストアを許可されたユーザーの名前
-srcroot

root資格証明を使用してソース・データベース・サーバーにアクセスするようZero Downtime Migrationに指示します

-srccred cred_name

ソース・データベース・サーバーにアクセスするためのユーザー名およびパスワード資格証明を関連付ける資格証明名
-srcuser user_name

ソース・データベース・サーバーで操作を実行する特権ユーザーの名前
-srcsudouser user_name

ソース・データベース・サーバー上でsudoユーザー名としてスーパーユーザーの操作を実行します

-srcsudopath sudo_binary_path

ソース・データベース・サーバー上のsudoバイナリの場所

-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の場所を指定しない場合、ZDMによってデフォルト(/usr/bin/sudo)が使用されます。
-tgtroot

root資格証明を使用してターゲット・データベース・サーバーにアクセスします

-tgtcred cred_name

ターゲット・データベース・サーバーにアクセスするためのユーザー名およびパスワード資格証明を関連付ける資格証明名
-tgtuser user_name

ターゲット・データベース・サーバーで操作を実行するユーザーの名前
-tgtsudouser user_name

ターゲット・データベース・サーバー上でsudoユーザー名としてスーパーユーザーの操作を実行します

-tgtsudopath sudo_binary_path

ターゲット・データベース・サーバー上のsudoバイナリの場所

-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の場所を指定しない場合、ZDMによってデフォルト(/usr/bin/sudo)が使用されます。
-tdekeystorepasswd

透過的データ暗号化(TDE)キーストアのパスワード(パスワードベースのキーストアまたはウォレットでは必須)
-tdemasterkey

透過的データ暗号化(TDE)マスター暗号化キー
-schedule timer_value

操作を実行するスケジュール時間(ISO-8601形式)。例: 2016-12-21T19:13:17+05
-pauseafter phase

指定されたフェーズの実行後にジョブを一時停止します
-ignoremissingpatches

ソース・パスまたは作業用コピーに存在する指定のパッチが宛先パスまたは作業用コピーから欠落している場合でも、移行を続行します
-ignore {ALL | WARNING | PATCH_CHECK}

すべてのチェックまたは特定のタイプのチェックを無視します
-listphases

この操作のフェーズをリストします
-sourcesyswallet sys_wallet_path

ソース・データベースのSYSパスワードを含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス

-osswallet oss_wallet_path

Object Storage Service (OSS)バックアップ・ユーザーの資格証明を含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
-tdekeystorewallet tde_wallet_path

透過的データ暗号化(TDE)キーストア・パスワードを含むZero Downtime Migrationホスト上の自動ログイン・ウォレット・ファイルのフルパス
-advisor

移行時にクラウド移行前アドバイザ・ツール(CPAT)を排他的に実行するために必要な最小限のフェーズのみを実行します
-ignoreadvisor

クラウド移行前アドバイザ・ツール(CPAT)のエラーを無視します
-skipadvisor

このオプションを指定すると、MIGRATE DATABASEの実行時にクラウド移行前アドバイザ・ツール(CPAT)は実行されません

-stopafter phase

指定したフェーズでワークフローを切り捨てて、指定したフェーズの完了時に移行ジョブに完了ステータスのマークを付けます。

このフェーズを超えてジョブを再開するオプションはありません。

たとえば、Data Guardの設定後にワークフローを停止する場合、-stopafter ZDM_CONFIGURE_DG_SRCを指定すると、このフェーズでジョブが停止し、ZDM_CONFIGURE_DG_SRCが正常に完了するとジョブに完了のマークが付けられます。

例

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]]

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

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}]

オプション

表H-5 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は、他のコマンド・オプションに基づいて実行範囲を選択する場合に指定します。

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

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]

オプション

表H-6 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は、最新の評価移行ジョブを取得します

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

query useraction

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

構文

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

オプション

表H-7 ZDMCLI query useractionのオプション

オプション 説明

-useraction user_action_name

ユーザー・アクションの名前
-imagetype image_type

イメージ・タイプ名を指定します
-optype MIGRATE_DATABASE

ユーザー・アクションが構成される操作

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

resume job

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

構文

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

オプション

表H-8 ZDMCLI resume jobのオプション

オプション 説明
-jobid job_id

スケジュール済ジョブの一意のジョブID値(整数)

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

指定されたフェーズの実行後に移行ジョブを一時停止します

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス

suspend job

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

構文

$ZDM_HOME/bin/zdmcli suspend job
  -jobid job_id

オプション

表H-9 ZDMCLI suspend jobのオプション

オプション 説明
-jobid job_id

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

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

親トピック: Zero Downtime Migration ZDMCLIコマンドのリファレンス