1. データベース・アップグレード・ガイド
  2. Oracle DatabaseアップグレードでのAutoUpgradeの使用
  3. AutoUpgradeコマンドライン・パラメータ

AutoUpgradeコマンドライン・パラメータ

AutoUpgradeパラメータを確認し、Oracle Databaseのアップグレードのユース・ケースのパラメータおよびオプションを選択します。

パラメータは、java -jar autoupgrade.jarコマンドとともに使用します。

  • AutoUpgradeコマンドライン・パラメータについて
    AutoUpgradeユーティリティ(autoupgrade.jar)のパラメータを使用するための構文および前提条件を確認します。
  • config
    AutoUpgradeパラメータconfigは、アップグレードするデータベースに関する情報を提供するために使用する構成ファイルを識別します。
  • console
    AutoUpgradeパラメータconsoleは、AutoUpgradeコンソールをオンにし、AutoUpgradeジョブの進行状況を監視する一連のコマンドを提供します。
  • create_sample_file
    AutoUpgradeパラメータcreate_sample_fileは、構成ファイルまたは設定ファイルを生成します。これらのファイルを編集して、本番構成ファイルまたはAutoUpgrade用設定ファイルを作成します。
  • noconsole
    AutoUpgradeパラメータnoconsoleは、AutoUpgradeコンソールをオフにし、構成ファイル情報のみを使用してAutoUpgradeを実行します。
  • settings
    AutoUpgradeパラメータsettingsは、AutoUpgradeユーティリティのカスタム・ランタイム構成の提供に使用する構成ファイルを識別します。
  • version
    AutoUpgradeパラメータversionは、autoupgrade.jarファイルの現在のビルドを端末の画面に出力します。

親トピック: Oracle DatabaseアップグレードでのAutoUpgradeの使用

AutoUpgradeコマンドライン・パラメータについて

AutoUpgradeユーティリティ(autoupgrade.jar)のパラメータを使用するための構文および前提条件を確認します。

前提条件

  • ソース環境にJava Development Kit (JDK) 8以降がインストールされている必要があります。

    JDK 8は、Oracle Database 12cリリース2 (12.2)以降のリリースごとにインストールされます。12.2より前のリリースでは、ターゲットOracle DatabaseのJavaリリースを使用してAutoUpgradeを実行するか、ソース・データベース・サーバーにJDK 8をインストールする必要があります。

  • AutoUpgradeユーティリティを使用したOracle Databaseのアップグレードは、Oracle Databaseの手動アップグレードに適用されるアップグレード・ルールと同じルールに従います。ソースOracle Databaseのリリースがアップグレードでサポートされていることを確認してください。

非CDBからPDBへの変換およびアップグレードでは、AutoUpgradeは、次の条件が満たされた場合に、アップグレードと変換の両方を自動的に完了することがあります。

  • ターゲット・リリースCDBが存在する必要があります。
  • ターゲット・リリースには、最新のリリース更新(RU)またはリリース更新リビジョン(RUR)に対するパッチを適用する必要があります。
  • ターゲットCDBシステム識別子がtarget_cdbであるAutoUpgrade構成ファイルで、次の構文を使用してローカル・パラメータtarget_cdbを設定する必要があります。

    target_cdb=target_cdb。

  • target_cdb値は、非CDBを接続するCDBのOracle SIDです。

ファイル・パス

AutoUpgradeユーティリティは、新しいリリースのOracle DatabaseホームにあるJava JARファイルです。

Oracle_home/rdbms/admin/autoupgrade.jar

My Oracle Supportから最新のAutoUpgrade JARファイルを取得することをお薦めします。JARファイルおよびJARファイルのデプロイメント手順は、My Oracle Supportノート2485457.1から入手できます

構文

AutoUpgradeコマンドの構文では、大文字と小文字が区別されます。コマンドを小文字で入力します。 

java -jar autoupgrade.jar
                                   [-version | -help | -create_sample_file create_sample_file
                                   [-settings settings] 
                                   [-config configfile.cfg]
                                               [-clear_recovery_data] 
                                               [-mode mode] 
                                               [-console | -noconsole] 
                                               [-restore_on_fail] 
                                               [-debug]

各パラメータには、前にマイナス記号(-)を付ける必要があります。各パラメータで使用できるオプションの詳細は、関連するパラメータのトピックを参照してください。

例3-2 clear_recovery_dataを使用した問題修正後のAutoUpgradeの再実行

AutoUpgradeをデプロイ・モードで実行します

java -jar autoupgrade.jar -config config.cfg -mode deploy

ただし、アップグレード中に問題が発生しました。AutoUpgradeを停止してデータベースをリストアし、データベースを変更して問題を修正します。以前のAutoUpgrade状態ファイルが検出されない場合にAutoUpgradeプロシージャを再度開始するには、次のコマンドを実行して作業内容を確認します。

java -jar autoupgrade.jar -config config.cfg -mode analyze -clear_recovery_data

分析結果に問題はないため、再度デプロイ・オプションを実行します。 

java -jar autoupgrade.jar -config config.cfg -mode deploy
-clear_recovery_dataオプションを指定してautoupgrade.jar -configを実行すると、AutoUpgradeによって状態ファイルのみが削除されます。以前生成されたログ・ファイルは無視されるため、さらに参照するためにログ・ファイルを保持できます。-clear_recovery_dataオプションを指定してAutoUpgradeを実行すると、最新のjobid情報も保持されるため、AutoUpgradeが次のジョブに対して作成するjobidは、次のIDの順番となります。AutoUpgradeがjobid状態を保持することで、同じログ・ファイル内に前のAutoUpgradeジョブのログ出力を混在させないようにすることができます。

関連項目

親トピック: AutoUpgradeコマンドライン・パラメータ

config

AutoUpgradeパラメータconfigは、アップグレードするデータベースに関する情報を提供するために使用する構成ファイルを識別します。

プロパティ 説明
パラメータ・タイプ 文字列
構文 
-config configfile -mode mode 
     [-console | -noconsole] 
     [-restore_on_fail] 
     [-clear_recovery_data] 
     [-debug]
     [-zip [-sid system_identifier][-d filepath]
デフォルト値 オプション-consoleはデフォルトで有効になっています。

説明

config...mode句には、次の2つの標準引数を指定できます。

  • 構成ファイル名およびパス(オプション)がconfig-fileで表されます

  • モード・タイプ。引数-mode modeを使用します。ここでのmodeは構成ファイルで使用される処理モードです。mode引数は、次のオプションを使用します。

    • analyze: データベースを分析します

    • fixups: ソース・データベース内のエラーを修正します

    • deploy: データベースに対する、分析からアップグレード後までのすべての操作を実行します

    • upgrade: ターゲットOracleホームでアップグレードを実行します。

注意:

-zip句を使用する場合は、-mode句は使用できません。

-configパラメータでは、次のオプション句を指定できます。

  • -clear_recovery_data: 次回AutoUpgradeを起動するときに新しく開始するには、リカバリ・チェックポイントを削除します。このオプションを使用してAutoUpgradeを実行し、以前に生成された状態情報が廃棄されるようにします。特に、このオプションは、アップグレードのテスト時に、テストの間でデータベース・リストアを使用して同じデータベースのアップグレードを複数回テストする場合に役立ちます。

  • -console: 無効になっている場合、AutoUpgradeコンソールを有効にします。コンソールはデフォルトで有効になっています。コンソールを使用すると、端末でコマンドを発行して実行中のジョブに関する詳細をリアルタイムで受信できます。これにより、そのワークフローを変更できます。たとえば、コンソールからジョブを中断したり、特定のデータベースをリストアできます。

  • -noconsole: コンソールを無効にします。バッチ・スクリプトの場合、noconsoleモードを使用します。このモードでは、AutoUpgradeコマンドは端末での対話操作なしで実行されます。

  • -restore_on_fail: アップグレードが失敗した場合に、データベースを自動的にリストアするオプションを有効にします。このオプションは、Enterprise Editionでのみ使用可能で、AutoUpgradeをデプロイ・モードで実行する場合にのみ適用されます。他のモードでは、このオプションは無視されます。

  • -debug: ログ・ファイルと端末出力の両方でデバッグ・レベル・メッセージを有効にします。

  • -zip: AutoUpgradeのすべてのデータおよびログ・ファイルを含むアーカイブ(zip)ファイルを作成します。たとえば、1つのサービス・リクエストについて複数のファイルをアップロードするために、-zip句を使用できます。-zipパラメータを指定すると、他の句を指定していない場合は、構成ファイル内で指定したすべてのデータベースのアーカイブ・ログ・ファイルがzip圧縮されます。このzipファイルは、autoupgrade.jarを実行した現在のパスに作成されます。-zipオプションを使用する場合は-modeオプションを使用できないということに注意してください。-zipオプションには、2つのオプション句を指定できます(これらは個別または一緒に指定できます)。
    • -sid system_identifier: ログ・ファイルをzipファイルに含めるデータベースのシステム識別子(SID)名を指定します。変数system_identiferの値として、少なくとも1つのSIDを指定する必要があります。複数のSIDはカンマ区切りリスト(sid1,sid2,sid3, …)で指定します。
    • -d filepath: zipファイルを配置する宛先パスを指定します。指定した場合、アーカイブ・ログ・ファイルはzip圧縮され、指定したファイル・パスに配置されます。
    そのzipファイルに含まれるログ・ファイルを次に示します。
    • 構成ファイル
    • トレース・ディレクトリ。各データベースに対して指定されている、すべてのアラート・ログ・ファイルが含まれています。
    • cfgtoollogsディレクトリ。cfgtoollogsの下のすべてのディレクトリが含まれています。
    • システム識別子(SID)名: SIDごとに1つのディレクトリ。SIDごとのすべてのジョブ・ディレクトリおよび一時フォルダが含まれています。
    このzipファイルの名前の形式は、AUPG-year-month-day_hour_minute_millisecond.zipです。次にこの説明を示します。
    • yearは、zipファイルが作成された年です。
    • monthは、zipファイルが作成された月です。
    • dayは、zipファイルが作成された日です
    • hourは、zipファイルが作成された時です。
    • minuteは、zipファイルが作成された分です
    • millisecondはzipファイルが作成されたミリ秒です

例

処理モードdeployで、myconfig.cfgという名前の構成ファイルを指定してAutoUpgradeを実行します。 

java -jar autoupgrade.jar -config myconfig.cfg -mode deploy

処理モードanalyzeで、パス/usr/home/oracle1にあるconfig.cfgという名前の構成ファイルを指定してAutoUpgradeを実行します。 

java -jar autoupgrade.jar -config /usr/home/oracle1/config.cfg -mode analyze

分析モードでconfig.cfgという名前の構成ファイルを指定してAutoUpgradeを実行します。 

java -jar autoupgrade.jar -config config.cfg -mode analyze -console

analyzeモードでconfig.cfgという名前の構成ファイルを指定してAutoUpgradeを実行し、AutoUpgradeコンソールを無効にします。 

java -jar autoupgrade.jar -config config.cfg -mode analyze -noconsole

analyzeモードで、config.cfgという名前の構成ファイル、およびアップグレード失敗時のデータベースの自動リストアを有効にするオプションを指定してAutoUpgradeを実行します。 

java -jar autoupgrade.jar -config config.cfg -mode deploy –restore_on_fail

AutoUpgradeをデプロイ・モード(java -jar autoupgrade.jar -config config.cfg -mode deploy)で実行すると、アップグレード中に問題が発生します。AutoUpgradeを停止してデータベースをリストアし、データベースを変更して問題を修正します。以前のAutoUpgrade状態ファイルが検出されない場合にAutoUpgradeプロシージャを再度開始するには、次のコマンドを実行して作業内容を確認します。 

java -jar autoupgrade.jar -config config.cfg -mode analyze -clear_recovery_data

この例では、-zipオプションを指定してAutoUpgrade実行可能ファイルautoupgrade.jarを実行します。AutoUpgradeをユーザーoracleとして実行します。ここでは、autoupgrade.jarはOracleユーザー・ホームにあり、構成ファイルはmyconfig.cfgという名前です。-zipオプションのオプション句を設定せずにAutoUpgradeを実行することもできます。結果として、zipファイルは、autoupgrade.jar実行可能ファイルが配置されている、Oracleユーザーのホームに配置されます。 

java -jar autoupgrade.jar -config myconfig.cfg -zip
Processing: 230736166 [bytes] in 140 Files
/ 100%
Zipped successfully at /home/oracle/AUPG_200130_1501_900.zip

同じAutoUpgradeコマンドを実行しますが、今回は-zipオプションの-dオプション句を設定し、zipファイルをパス/u03/AUPG-filesに配置することを指定します。 

java -jar autoupgrade.jar -config myconfig.cfg -zip -d /u03/AUPG-files/
Processing: 230736166 [bytes] in 140 Files
| 100%
Zipped successfully at /u03/AUPG-files/AUPG_200130_1528_926.zip

SID定義upg1.sid=sales_01およびupg2.sid=inv_04を含んだmyconfig.cfgを使用して、データベースでAutoUpgradeコマンドを実行します。ただし、今回は-zipオプションの-sidオプション句を設定し、SID sales_01のファイルをzip圧縮するよう指定します。 

java -jar autoupgrade.jar -config myconfig.cfg -zip -sid sales_01
Processing: 115368083 [bytes] in 79 Files- 100%
Zipped successfully at /home/oracle/AUPG_200130_1530_843.zip
このzipファイルには、sales_01に関連付けられたログ・ファイルおよびディレクトリのみが含まれます。 
cfgtoollogs/
config.cfg
sales_01/
trace/

同じコマンドを実行しますが、今回は、SID cdb10300、sales_01およびinv_04のログ・ファイルをzipファイルに含めるよう指定し、それらのログ・ファイルをファイル・パス/u03/AUPG-files/に配置するよう指定します。 

java -jar autoupgrade.jar -config myconfig.cfg -zip -sid cdb18300,sales_01,inv04 -d /u03/AUPG-files/
Processing: 230736166 [bytes] in 140 Files
- 100%
Zipped successfully at /u03/AUPG-files/AUPG_200130_1545_945.zip
このzipファイルには、sales_01とinv_04の両方に関連付けられたログ・ファイルおよびディレクトリが含まれます。 
cdb18300/
cfgtoollogs/
config.cfg
sales_01
inv_04
trace/

親トピック: AutoUpgradeコマンドライン・パラメータ

console

AutoUpgradeパラメータconsoleは、AutoUpgradeコンソールをオンにし、AutoUpgradeジョブの進行状況を監視する一連のコマンドを提供します。

プロパティ 説明

パラメータ・タイプ

文字列
構文

autoupgrade.jar -config your-file -mode your-mode -console [exit | help | lsj [(-r|-f-p|-e)|-n number | lsr | lsa | tasks | clear | resume -job number | status][-job number|-long | restore -job number [force] | restore all_failed | logs | abort -job number | h[ist][/number]

説明

アップグレードを監視するには、AutoUpgradeパラメータconsoleを使用してコンソールを実行し、アップグレード・ジョブのステータスを監視します。

AutoUpgradeコンソールは、デフォルトでAutoUpgradeコマンドを使用して起動されます。オプション-console|-noconsoleを使用して、AutoUpgradeコンソールを再度有効または無効にできます

-noconsoleオプションを使用する場合、AutoUpgradeは構成ファイルの設定のみを使用して実行され、コンソールでの入力は必要ありません。複数のデータベースを分析する場合など、AutoUpgrade用のスクリプトを作成する場合は、noconsoleオプションを使用します。AutoUpgradeジョブが終了した後、分析モード・ログの出力を確認して、構成スクリプトに含まれる各データベースのアップグレードに必要な内容を確認できます。

注意:

特定の構成ファイルに関連付けられているAutoUpgradeインスタンスは、一度に1つのみ実行できます。

使用上の注意

各AutoUpgradeコンソール・オプションには、先頭にマイナス記号(-)を付ける必要があります

コンソール・オプション 説明

exit

クローズしてコンソールを終了します。実行中のジョブがある場合、それらは停止されます。

help

コンソール・コマンド・ヘルプを表示します

lsj [(-r|-f-p|-e)|-n number]

数値numberで指定したジョブ数まで、ステータス別にジョブをリストします。次のフラグを使用できます。

-f: (オプション)終了したジョブでフィルタします。

-r: :(オプション)実行中ジョブでフィルタします。

-e: (オプション)エラーのあるジョブでフィルタします。

-p: (オプション)準備中のジョブでフィルタします。

-n number: (必須)整数値で指定される、表示するジョブの数

lsr

リストア・キューを表示します。

lsa

中断キューを表示します。

tasks

実行中のタスクを表示します。

clear

端末表示をクリアします。

resume -job number

実行していた前のジョブから再起動します。ジョブを数値 (number)で指定します。

status [-job number|-long]

数値(-job number)で指定された特定のジョブのステータスを示します。-longを指定して実行すると、AutoUpgradeは実行中のジョブについての全詳細を表示します。

restore [-job (0-9)|-all_failed]

整数値numberで指定されたAutoUpgradeジョブでデータベースをアップグレードの開始前の状態にリストアします。

all_failedオプションを指定して実行すると、アップグレードが開始する前に、失敗したすべてのジョブが前の状態にリストアされます。

logs

すべてのログ・ファイルの場所を表示します。

abort -job number

入力した数値(number)で指定されたジョブを中断します。

h[ist][/number]

コンソール・コマンドライン履歴を表示し、実行するフラットに応じてコマンドを再度実行するオプションを取得します。

フラグ:

/ 最後のコマンドを再度実行します。

/ number 指定したコマンドライン番号で指定された履歴ログ内のコマンドを実行します。

親トピック: AutoUpgradeコマンドライン・パラメータ

create_sample_file

AutoUpgradeパラメータcreate_sample_fileは、構成ファイルまたは設定ファイルを生成します。これらのファイルを編集して、本番構成ファイルまたはAutoUpgrade用設定ファイルを作成します。

プロパティ 説明

パラメータ・タイプ

文字列

構文

-create_sample_file [settings | config ]

デフォルト値

なし

使用上の注意

create_sample_fileパラメータはオプションです。他のパラメータと一緒に使用することはできません。このパラメータを指定する場合、settingsまたはconfig句のいずれかが必要です。

settings: AutoUpgrade設定ファイルを生成します。

config: AutoUpgrade構成ファイルを生成します

これらのサンプル・ファイルのいずれかを生成すると、ファイルを変更してAutoUpgradeユーティリティによるアップグレードの実行方法を制御できます。

  • settings AutoUpgradeは、現在のフォルダにsample_autoupg.cfgという名前のファイルを生成します。

  • config: 構成モード・タイプのテンプレート・アップグレード構成ファイルを生成します。AutoUpgradeは、現在のフォルダにsample_config.cfgという名前のファイルを生成します

settingsとconfigの両方のオプションで、拡張子が.cfgのデフォルトのファイル名が生成されます。ただし、ファイルが有効な(プレーン・テキスト)ファイルであれば、AutoUpgradeでは拡張子なしでも、拡張子を指定してもファイルを読み取ることができます。デフォルトの拡張子は、これらのファイルを構成ファイルとして識別する際に便利です。

サンプル構成ファイルの生成は、AutoUpgradeを使用するための標準的な準備で行われます。サンプル構成ファイルの構成ファイル・パラメータをカスタマイズすると、そのファイルを本番設定およびアップグレード用構成ファイルとして使用できます。

注意:

設定ファイルは、AutoUpgradeの内部設定を上書きするために使用されます。ほとんどのユース・ケースでは、サンプル設定ファイルの生成は必須ではありません。慎重に使用してください。

例

config句でcreate_sample_fileパラメータを実行する例: 

[oracle@example ~]$ java -jar autoupgrade.jar -create_sample_file config
Created sample configuration file /home/oracle/sample_config.cfg

settings句でcreate_sample_fileパラメータを実行する例: 

oracle@example ~]$ java -jar autoupgrade.jar -create_sample_file settings 
Created sample settings file /home/oracle/sample_autoupg.cfg

親トピック: AutoUpgradeコマンドライン・パラメータ

noconsole

AutoUpgradeパラメータnoconsoleは、AutoUpgradeコンソールをオフにし、構成ファイル情報のみを使用してAutoUpgradeを実行します。

プロパティ 説明

パラメータ・タイプ

文字列

構文

noconsole

説明

-noconsoleオプションを使用する場合、AutoUpgradeは構成ファイルの設定のみを使用して実行され、コンソールでの入力は必要ありません。AutoUpgradeをバッチ・フローの一部として実行する場合や、複数のデータベースを分析する場合などにスクリプトで実行する場合は、noconsoleオプションを使用します。AutoUpgradeジョブが終了した後、分析モード・ログの出力を確認して、構成スクリプトに含まれる各データベースのアップグレードに必要な内容を確認できます。

注意:

特定の構成ファイルに関連付けられているAutoUpgradeインスタンスは、一度に1つのみ実行できます。

使用上の注意

この例では、AutoUpgradeはnoconsoleモードで構成ファイルを使用して分析モードで実行されます。 

java -jar autoupgrade.jar -config autoupgrade.cfg -mode analyze -noconsole

親トピック: AutoUpgradeコマンドライン・パラメータ

settings

AutoUpgradeパラメータsettingsは、AutoUpgradeユーティリティのカスタム・ランタイム構成の提供に使用する構成ファイルを識別します。

プロパティ 説明
パラメータ・タイプ 文字列
構文 -settings my-custom-advanced-settings
デフォルト値 該当なし

説明

-settings句には、名前の必須引数およびカスタム設定で変更した設定構成ファイルへのパスがあります。-settings句は単独では使用できませんが、AutoUpgradeが処理モードを実行する方法を変更する構成入力ファイルとして使用できます。

使用上の注意

このパラメータは、詳細パラメータです。ほとんどのアップグレード・シナリオでは、内部AutoUpgradeパラメータ設定を変更する必要はありません。

例

java -jar autoupgrade.jar -settings my_custom_advanced_settings.cfg -config config.cfg -mode deploy

親トピック: AutoUpgradeコマンドライン・パラメータ

version

AutoUpgradeパラメータversionは、autoupgrade.jarファイルの現在のビルドを端末の画面に出力します。

プロパティ 説明
パラメータ・タイプ 文字列
構文 -version
デフォルト値 該当なし。

説明

サーバー上のautoupgrade.jarユーティリティのバージョンを確認するには、このオプション・パラメータを使用します。

使用上の注意

コマンド例:

java -jar autoupgrade.jar -version

出力例:

[oracle@example ~]$ java -jar autoupgrade.jar -version

build.hash 04a58df
build.version 20191127
build.date 2019/11/27 11:40:37
build.max_target_version 20
build.type production-20.3

親トピック: AutoUpgradeコマンドライン・パラメータ