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

AutoUpgradeのコマンドライン・パラメータおよびオプション

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

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

  • AutoUpgradeコマンドライン構文
    AutoUpgradeを使用してアップグレードを実行する方法を確認するには、構文および実行時のユースケースを確認してください。
  • debug
    AutoUpgradeパラメータdebugにより、AutoUpgradeデバッグ・メッセージ機能をオンにします。これは、正しくないAutoUpgradeジョブ構文の修正に役立ちます。
  • clear_recovery_data
    AutoUpgradeパラメータclear_recovery_dataにより、リカバリ・チェックポイントを削除します。これにより、AutoUpgradeは、指定されたデータベースまたはすべてのデータベースで次回ツールが起動されたときに、新しく起動されます。
  • config
    AutoUpgradeパラメータconfigにより、アップグレードするデータベースについて情報を提供するために使用する、構成ファイルを特定します。
  • config_values
    AutoUpgradeパラメータconfig_valuesを使用すると、テキスト構成ファイルと同様の内容で、システムに関する入力値を指定できます。このパラメータは、configパラメータと組み合せて使用できます。
  • console
    AutoUpgradeパラメータconsoleにより、AutoUpgradeコンソールをオンにし、AutoUpgradeジョブの進行状況を監視するための一連のコマンドが提供されるようにします。
  • create_sample_file
    AutoUpgradeパラメータcreate_sample_fileにより、構成ファイルまたは設定ファイルを生成します。これらのファイルを編集して、本番構成ファイルまたはAutoUpgrade用設定ファイルを作成します。
  • error_code
    AutoUpgradeパラメータerror_codeにより、AutoUpgradeエラーのエラー・コードが表示されるようにします。
  • listchecks
    AutoUpgradeパラメータlistchecksは、アップグレードのすべてのアップグレード・チェックのリストを提示するか、特定のチェックが指定された場合は、指定されたチェックに関する詳細を提示します。
  • load_password
    AutoUpgradeパラメータload_passwordを使用すると、AutoUpgradeのキーストアにパスワードを安全に入力できます。
  • load_win_credential
    AutoUpgradeパラメータload_win_credentialは、アップグレード中にAutoUpgradeを中断することなく実行できるように、PowerShellを使用して資格証明オブジェクトを作成します。
  • mode
    AutoUpgradeパラメータmodeの値により、AutoUpgradeの実行モードを設定します。
  • noconsole
    AutoUpgradeパラメータnoconsoleにより、AutoUpgradeコンソールをオフにし、構成ファイル情報のみを使用してAutoUpgradeが実行されるようにします。
  • preupgrade
    AutoUpgradeパラメータpreupgradeにより、データベース・チェックと、ほとんどの問題をアップグレード開始前に修正するアップグレード前修正と、ほとんどの問題をアップグレード完了後に修正するアップグレード後修正を実行します。
  • settings
    AutoUpgradeパラメータsettingsにより、AutoUpgradeユーティリティのカスタム・ランタイム構成の提供に使用する構成ファイルを特定します。
  • version
    AutoUpgradeパラメータversionにより、autoupgrade.jarファイルの現在のビルドを端末画面に出力します。
  • restore
    AutoUpgradeパラメータrestoreにより、指定したAutoUpgradeジョブのシステムレベル・リストアを実行します。
  • restore_on_fail
    AutoUpgradeパラメータrestore_on_failにより、デプロイメント中に失敗したジョブが自動的にリストアされるようにします。
  • zip
    AutoUpgradeパラメータzipにより、AutoUpgradeサービス・リクエストのファイリングに必要なログ・ファイルのzipファイルを作成します。

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

AutoUpgradeコマンドライン構文

AutoUpgradeを使用してアップグレードを実行する方法を確認するには、構文および実行時のユースケースを確認してください。

前提条件

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

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

    Oracle Database 23c以降は、すべてのOracleホームにJava Runtime Environment (JRE) 11が含まれています。AutoUpgradeはJava 11でコンパイルされており、Java 8以降のリリースと互換性があります。

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

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

  • ターゲット・リリースCDBが存在する必要があります。
  • ターゲットCDBシステム識別子がtarget_cdbであるAutoUpgrade構成ファイルで、次の構文を使用してローカル・パラメータtarget_cdbを設定する必要があります。

    target_cdb=target_cdb。たとえば: 

    target_cdb=cdb1
  • 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 [options]

複数のオプションを連結できます。

AutoUpgradeの実行タイプ1 (基本)のパラメータ

AutoUpgradeの実行タイプ1 (基本)のパラメータおよびオプションにより、アップグレードの準備の開始点が提供されます。

パラメータ 説明
-version

AutoUpgradeのバージョンを表示します。

-help

AutoUpgrade構文のヘルプ・ファイルを表示します。
-create_sample_file [settings | config config-file-name]

AutoUpgradeのサンプル構成ファイルを作成します。オプションの詳細は、create_sample_fileパラメータのトピックを参照してください。

AutoUpgradeの実行タイプ2 (コア)のパラメータ

AutoUpgradeの実行タイプ2 (コア)のパラメータおよびオプションは、ほとんどのアップグレード・シナリオで重要なアップグレード機能を提供します。

パラメータ 説明

-config [config_path | -config_values config_values]

アップグレードするデータベースに関する情報を提供するために使用する構成ファイルを識別します。オプションの詳細は、configパラメータのトピックを参照してください。

-mode [analyze|fixups|deploy|upgrade|postfixups]

AutoUpgradeを実行するモードを設定します。オプションの詳細は、modeパラメータのトピックを参照してください。

-restore -jobs job#

指定するAutoUpgradeジョブのシステムレベルのリストアを実行します

-restore_on_fail

設定されている場合、ジョブが失敗すると、データベースは自動的にリストアされます。PDBのエラーは致命的とはみなされず、CDB$ROOTまたは非CDBのエラーのみが致命的とみなされます。

-console

コンソールを有効にしてAutoUpgradeを開始します。

-noconsole

コンソールを無効にしてAutoUpgradeを開始します。

-debug

デバッグ・メッセージを有効にします。

-clear_recovery_data [-jobs job#,job#,...]

リカバリ情報を削除します。これにより、すべてのデータベースまたは-jobsで指定されたカンマ区切りリストのデータベースでAutoUpgradeが最初から開始されます。オプションの詳細は、clear_recovery_dataパラメータのトピックを参照してください。

-restore -jobs job#,job#,...

指定されたジョブのシステムレベルのリストアを実行します。データベースは保証付きリストア・ポイント(GRP)にフラッシュ・バックされます。このコマンドを実行する前に、GRPがAutoUpgradeによってすでに作成されている必要があります。オプションの詳細は、clear_recovery_dataパラメータのトピックを参照してください。

-zip [-sid sid] [-d dir]

AutoUpgradeサービス・リクエストのファイリングに必要なログ・ファイルを圧縮します。オプションの詳細は、zipパラメータのトピックを参照してください。

AutoUpgradeの実行タイプ3 (追加)のパラメータ

AutoUpgradeの実行タイプ3 (追加)のパラメータおよびオプションは、アップグレードの失敗したポイントからの再開や特定の修正の実行など、特定のアップグレード・シナリオに役立ちます。

パラメータ 説明

-debug

デバッグ・メッセージを有効にします。
-error_code

AutoUpgradeエラー・コードが表示されます。

-help

AutoUpgrade構文のヘルプ・ファイルを表示します。

-mode [analyze|fixups|postfixups]

AutoUpgradeを実行するモードを設定します。オプションの詳細は、modeパラメータのトピックを参照してください。

-load_password

AutoUpgradeが必要とするパスワードをAutoUpgradeのキーストアに安全に入力できるようにします。

-preupgrade preupgrade_options options

データベース・チェックおよびほとんどの問題をアップグレードの開始前に修正するアップグレード前修正と、ほとんどの問題をアップグレードの完了後に修正するアップグレード後修正を実行します。オプションの詳細は、preupgradeパラメータのトピックを参照してください。

関連項目

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

debug

AutoUpgradeパラメータdebugは、AutoUpgradeデバッグ・メッセージ機能をオンにします。これは、障害のあるAutoUpgradeジョブ構文の修正に役立ちます。

プロパティ 説明

パラメータ・タイプ

文字列
構文

autoupgrade.jar -parameter -debug

説明

AutoUpgradeのdebugパラメータは、AutoUpgradeコマンド構文の修正に役立つデバッグ・メッセージをオンにします。

使用上のノート

debugパラメータは、他のAutoUpgradeパラメータと組み合せて使用します。

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

clear_recovery_data

AutoUpgradeパラメータclear_recovery_dataは、リカバリ・チェックポイントを削除します。これにより、AutoUpgradeは、指定されたデータベースまたはすべてのデータベースで次回ツールが起動されたときに、新しく起動します。

プロパティ 説明

パラメータ・タイプ

文字列
構文

clear_recovery_data [-jobs job_numbers]

ここで、

job_numbersは、クリアするジョブのカンマ区切りリストです

説明

AutoUpgradeのclear_recovery_dataパラメータは、リカバリ情報を削除します。これにより、指定したデータベースまたはすべてのデータベースでAutoUpgradeが最初から開始されます。

使用上のノート

データベースを手動でリストアし、新しいアップグレードを試行した後に使用します。ジョブのリストが指定されていない場合は、デフォルトですべてのジョブ・メタデータが削除されます。メタデータを削除しても、ログ・ファイルは削除されず、ジョブ識別子(jobid)カウンタもリセットされません。各ジョブの進行状況を追跡するために使用されるAutoUpgradeファイルのみが削除されます。

例

次の例は、問題が発生した後に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 -jobs 100

ノート:

ジョブID番号は、ジョブをデータベースに関連付けます。間違ったジョブIDを入力すると、AutoUpgradeは間違ったジョブを最初から再開します。

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

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ジョブのログ出力を混在させないようにすることができます。

次に、clear_recovery_dataパラメータの実行方法のその他の例を示します。 

java -jar autoupgrade.jar -config config.cfg -clear_recovery_data
java -jar autoupgrade.jar -config config.cfg -clear_recovery_data -jobs 111,222

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

config

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

プロパティ 説明
パラメータ・タイプ 文字列
構文 
-config [configfile
デフォルト値 なし

説明

configパラメータは構成ファイル名を指定します。これは次の3つの引数を取ります。

  • 構成プロパティ名

  • (オプション) config-fileで表される構成ファイルへのパス

    パラメータ-load_passwordとともに使用すると、グローバル構成ファイル・パラメータglobal.keystoreがデータベースの構成ファイルに設定されている場合、AutoUpgradeは、そのパラメータで指定された場所にTransparent Data Encryption (TDE)パスワードのキーストアも作成します。

例

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

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

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

config_values

AutoUpgradeパラメータconfig_valuesを使用すると、テキスト構成ファイルと同じシステムに関する入力値を指定できます。このパラメータは、configパラメータと組み合せて使用できます。

プロパティ 説明
パラメータ・タイプ 文字列。
構文 
-config_values [config-parameter1=value*,config-parameter2=value,...]
デフォルト値 なし。

説明

config_valuesパラメータを使用すると、使用しない場合は構成ファイルを指定する必要があるデータベース・パス、インスタンスおよびターゲット・リリースに関する値をAutoUpgradeコマンドラインを介して指定できます。その後、AutoUpgradeによってユーティリティの実行時に構成ファイルが作成されます。config_valuesを使用することで、構成ファイルなしにAutoUpgradeを実行できます。

config_valuesオプションは、複数のデータベース・アップグレードをサポートできるカンマ区切りリストです。各データベース構成は、それぞれのデータベースを識別するためにアスタリスク(*)で区切られます。グローバル・エントリの名前には、global接頭辞が含まれている必要があります。たとえば: 

global.autoupg_log_dir=/u01/app/oracle/cfgtoollogs/upgradelogs/

ローカル・エントリには、名前のみが含まれている必要があります。 

target_home=/u01/app/oracle/product/23.0.0.0/dbhome_1

ロギング・ディレクトリは、次の方法で解決されます。

  • ケース: グローバルのautoupg_log_dirが指定されていない場合。

    config_fileパラメータがAutoUpgradeに渡されない場合、ローカル・ディレクトリがグローバル・ログ・ディレクトリとして使用されます。config_fileパラメータがAutoUpgradeに渡されない場合、グローバル・ログ・ディレクトリのデフォルトはJava一時ディレクトリになります。

    • UNIXおよびLinuxシステム: /tmp/autoupgrade
    • Microsoft Windows: C:\Users\name\AppData\Local\Temp\autoupgrade
    • autoupgradeYYYYMMMHHMMSS.cfgという名前の構成ファイルが作成されます。ここで、YYYYは年、MMMは月、HHは時、MMは分、SSは秒です。

  • ケース: グローバルのautoupg_log_dirが指定されている場合。

    config_fileパラメータがディレクトリをAutoUpgradeに渡さない場合、AutoUpgradeは、パラメータで指定されたAutoUpgradeログ・ディレクトリに構成ファイルを作成します。config_fileパラメータがディレクトリをAutoUpgradeに渡さない場合、構成ファイルはグローバル・ログ・ディレクトリ下に作成されます。既存の構成ファイル名を指定すると、AutoUpgradeは、接尾辞YYYYMMMHHMMMMSS.cfg (YYYYは年、MMMは月、HHは時間、MMは分、SSは秒)を使用して、既存の構成ファイルの名前を変更します。たとえば、2022年4月29日の午前8時30分4秒に、構成ファイル\tmp\autoupgrade.cfgがすでに存在する場合、ファイル名-config_file \tmp\autoupgrade.cfgをAutoUpgradeに渡すと、既存のファイルの名前は\tmp\autoupgrade.cfg20220429083004に変更されます。その後、AutoUpgradeは新しい構成ファイル\tmp\autoupgrade.cfgを作成します。

-config_valuesパラメータを使用し、AutoUpgradeコマンドを実行するユーザー・アカウントに次のオペレーティング・システム環境変数が設定されている場合、AutoUpgradeでは、これらの変数に定義されているパスを取得します。

  • ORACLE_HOME - ソースOracleホームのOracleホーム・パス。
  • ORACLE_TARGET_HOME - ターゲットOracleホーム・パス。
    • LinuxおよびUnix: export ORACLE_TARGET_HOMEコマンドと同等です。例: export ORACLE_TARGET_HOME=/u01/app/oracle/product/23.0.0/
    • Microsoft Windows: SET ORACLE_TARGET_HOMEコマンドと同等です。例: SET ORACLE_TARGET_HOME=C:\oracle\23.0.0
  • ORACLE_SID - Oracle Databaseシステム識別子(SID)。
    • LinuxおよびUnix: オペレーティング・システムのシェル・コマンドexport ORACLE_SIDを使用して設定します。たとえば: export ORACLE_SID=sales
    • Microsoft Windows: オペレーティング・システムのシェル・コマンドSET ORACLE_SIDを使用して設定します。たとえば: SET ORACLE_SID=sales
  • ORACLE_TARGET_VERSION - 新しいOracleホームのターゲット・リリース。このオペレーティング・システム環境変数は、ターゲットのOracleホームが存在しない場合に設定する必要があります。

    • LinuxおよびUNIX: export ORACLE_TARGET_VERSIONを使用して設定します。たとえば、Oracle Database 19cの場合は、次のように入力します。 

      export ORACLE_TARGET_VERSION=19.0.0

      Oracle Database 21c:の場合 

      export ORACLE_TARGET_VERSION=23.0.0

    • Microsoft Windows: SET ORACLE_TARGET_VERSIONを使用して設定します。

      たとえば、Oracle Database 19cの場合は、次のように入力します。 

      SET ORACLE_TARGET_VERSION=19.1

      たとえば、Oracle Database 23cの場合は、次のように入力します。 

      SET ORACLE_TARGET_VERSION=23.0.0

    構成ファイルのかわりにconfig_valuesパラメータを使用し、AutoUpgradeを実行するユーザー・アカウントにこれらのオペレーティング・システム環境変数を設定していない場合は、config_valuesを使用して少なくともこの4つの値を引数として指定する必要があります。

例: 既存の構成ファイルを使用したAutoUpgradeの実行

シナリオ: config_valuesを使用して既存の構成ファイルでAutoUpgradeを実行。次のコマンド構文では、myconfig.cfgファイルが作成されているローカル・ディレクトリからglobal.autoupg_log_dirを作成します。このコマンドの結果、global.autoupg_log_dirの場所は/dirに設定されます。 

java –jar autoupgrade.jar –config /dir/myconfig.cfg –config_values
        “source_home=/srcdir, target_home=/trgdir, sid=sales” –mode
        deploy

構成ファイルmyconfigは、パス/dirに作成され、次のエントリが含まれます。 

global.autoupg_log_dir=/dir
autoupgrade1.source_home=/srcdir
autoupgrade1.target_home=/trgdir
autoupgrade1.sid=sales

例: –config_valuesの値を指定しないAutoUpgradeの実行

分析、修正、アップグレードまたはデプロイの各モードでは、AutoUpgradeで実行する必要があるユーザー環境値を設定し、これらの値を–config_valuesの引数として渡さない場合、AutoUpgradeはデフォルトでサーバーに設定されているユーザー環境変数を使用します。

この仕組みを理解するために、ユーザーoracleとして、次の環境変数が設定されており、ターゲット・バージョンがOracle Database 23cのAutoUpgradeを実行するとします。

  • ORACLE_HOMEは、/u01/app/oracle/product/19.0.0/dbhome_1に設定されています
  • ORACLE_TARGET_HOMEは、/u01/app/oracle/product/23.0.0.0/dbhome_1に設定されています
  • ORACLE_SIDは、salesに設定されています
  • ORACLE_TARGET_VERSIONは、23.1に設定されています

では、2022年9月30日の午前11時45分15秒に次のコマンドを実行したとします。 

[Wed Sep 30 11:45:15] oracle@example:~$ java –jar autoupgrade.jar –config_values –mode analyze

ログ・ディレクトリが指定されていないため、AutoUpgradeはデフォルトで、実行用の構成ファイルを一時ディレクトリに書き込みます。AutoUpgradeが作成した構成ファイルは、/tmp/autoupgrade/autoupgrade20220501114515.cfgファイルとしてパス/tmp/autoupgradeに存在し、次のエントリが含まれます。 


global.autoupg_log_dir=/tmp/autoupgrade
# Value from environmental variable ORACLE_HOME
autoupgrade1.source_home=/u02/app/oracle/19.0.0
# Value from environmental variable ORACLE_TARGET_HOME
autoupgrade1.target_home=/scratch/oracle/23.0.0
# Value from environmental variable ORACLE_SID
autoupgrade1.sid=sales
# Value from environmental variable ORACLE_TARGET_VERSION
autoupgrade1.target_version=23.0.0

このオプションを使用すると、AutoUpgradeを使用して、アップグレードに関する広範な詳細を指定しなくても単一のデータベース・アップグレードを処理できます。

例: 複数のデータベースに関する–config_valuesエントリを使用したAutoUpgradeの実行

このシナリオでは、*を使用して各データベースの値を区切り、複数のデータベースに関する–config_valuesエントリを指定して、ターゲット・リリースがOracle Database 21cのAutoUpgradeを実行します。 

 java –jar autoupgrade.jar –config /tmp/auto.cfg –config_values "global.autoupg_log_dir=/scratch/upglogs,source_home=/scratch/19.0.0,target_home=/scratch/23.0.0,sid=sales,*,source_home=/scratch/18,target_home=/scratch/23.0.0,sid=employees"

構成ファイルは、/tmp/auto.cfgとしてディレクトリ/tmpに作成され、次のエントリが含まれます。 


global.autoupg_log_dir=/scratch/upglogs
autoupgrade1.source_home=/scratch/19.0.0
autoupgrade1.target_home=/scratch/23.0.0
autoupgrade1.sid=sales
autoupgrade2.source_home=/scratch/19.0.0
autoupgrade2.target_home=/scratch/23.0.0
autoupgrade2.sid=employees

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

console

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

プロパティ 説明

パラメータ・タイプ

文字列
構文

autoupgrade.jar -config your-file -mode your-mode

説明

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

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

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

ノート:

AutoUpgradeのインスタンスは必要な数を起動できますが、各インスタンスで一意のグローバル・ロギング・ディレクトリ(global.autoupg_log_dir)を使用する必要があります。グローバル・ロギング・ディレクトリが1つのみの場合、起動できるインスタンスは1つのみです。

使用上のノート

コンソールを起動すると、コンソール内のオプションを使用できます。

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

-exit

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

-help

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

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

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

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

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

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

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

-a number: (オプション)整数値(number)で指定された秒数の後にコマンドを繰り返します。

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

-lsr

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

-lsa

停止するジョブのキューを表示します。

-tasks

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

-clear

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

-resume -job number [-ignore_errors=ORA-number,ORA-number]

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

ignore_errorsオプション: このフラグはオプションです。パッチ適用またはアップグレード・ステージの処理中に再開エラーが発生した場合は、ステージの失敗としてレポートされます。AutoUpgradeは、アップグレード後の操作に進みません。エラーを無視してアップグレード後の操作を続行できる場合もあります。特定のエラーがパッチ適用またはアップグレードに影響しないと思われる場合は、ignore_errorsオプションを使用して、無視するエラーを指定し、アップグレード後の操作を続行できるようにすることができます。エラー番号は、カンマ区切りのエラー・リストで指定されます。例:

-resume -job 444 -ignore_errors=ORA-48101,ORA-00001

-status [-job number | -c dbname| -config| -a number]

特定のジョブのステータスを、フラグで指定したレスポンスとともにリストします。

フラグ:

-job number: 数値で指定された特定のジョブに関する情報を表示します。

-c dbname: 指定する特定のデータベース名(dbname)に関する詳細情報を表示します(可能な場合)。

-config number 指定したジョブの構成情報を表示します。

-a number: (オプション)整数値(number)で指定された秒数の後にコマンドを繰り返します。

-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 config [filename] [full|unplug|noncdbtopdb] | settings [filename]

デフォルト値

create_sample_file configの場合、コマンドにファイル名を付加すると、サンプル構成ファイルが指定した名前で作成されます。出力ファイル名を指定しない場合、サンプル構成ファイルはsample_config.cfgという名前で作成されます。

次のオプションのいずれかを使用して、AutoUpgrade構成ファイルのタイプを指定する句を追加できます。

  • full: 完全なオプションのAutoUpgrade構成ファイル
  • unplug: PDBの切断/接続アップグレードのオプションを含むAutoUpgrade構成ファイル。
  • noncdbtopdb: 非CDBからPDBへのアップグレード用のオプションを含むAutoUpgrade構成ファイル。

settings句を追加すると、内部設定構成ファイルが生成されます。デフォルトのファイル名をそのまま使用することも、カスタム名を指定することもできます。

使用上のノート

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

settings: sample_autoupg.cfgという名前または指定した名前でAutoUpgradeの設定ファイルが生成されます。

config: sample_config.cfgという名前または指定した名前でAutoUpgradeの構成ファイルが生成されます。

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

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

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

configとsettingsのいずれのオプションの場合も、拡張子が.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

出力構成ファイル名を指定するconfig句でcreate_sample_fileパラメータを実行する例: 

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

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

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

出力構成ファイル名を指定するsettings句でcreate_sample_fileパラメータを実行する例: 

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

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

error_code

AutoUpgradeパラメータerror_codeは、AutoUpgradeエラーのエラー・コードを示します。

プロパティ 説明

パラメータ・タイプ

文字列

構文

-error_code [errorcode]

デフォルト値

エラー・コードを指定しないと、すべてのAutoUpgradeエラー・コードがコンソールに表示されます。

エラー・コードを指定すると、指定のエラー・コードに関する情報がコンソールに表示されます。

例

指定なしで入力すると、すべてのエラー・コードの説明が生成されます。 

$ java -jar autoupgrade.jar  -error_code
ERROR1000.ERROR  = UPG-1000
ERROR1000.CAUSE  = It was not possible to create the data file where the jobsTable is being written or there was a problem during the writing, it might be thrown due to a permission error or a busy resource scenario

ERROR1001.ERROR  = UPG-1001
ERROR1001.CAUSE  = There was a problem reading the state file perhaps there was corruption writing the file and in the next write it might be fixed

ERROR1002.ERROR  = UPG-1002
ERROR1002.CAUSE  = Error deserializing the object for rerun, review log for any errors
.
.
.

特定のエラー・コードを入力すると、指定したエラーの出力が提示されます。たとえば:

java -jar autoupgrade.jar -error_code UPG-3010

このコマンドにより、次の出力が生成されます。 

ERROR3010.ERROR  = UPG-3010
ERROR3010.CAUSE  = Error running approot_to_pdb.sql script

次に、もう一つの例を示します。 

$ java -jar autoupgrade.jar  -error_code UPG-1400

このコマンドにより、次の出力が生成されます。

ERROR1400.ERROR  = UPG-1400
ERROR1400.CAUSE  = Database upgrade failed with errors

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

listchecks

AutoUpgradeパラメータlistchecksは、アップグレードのすべてのアップグレード・チェックのリストを提示するか、特定のチェックが指定された場合は、指定されたチェックに関する詳細を提示します。
プロパティ 説明
パラメータ・タイプ 文字列
構文 
-listchecks [checkname]
デフォルト値 なし。特定のチェックが指定されていない場合は、すべてのAutoUpgradeチェックのリストが提示されます。

例

指定しないで入力すると、Autoupgrade listchecksパラメータにより、AutoUpgradeがアップグレードに対して実行するすべてのチェックの説明が生成されます。 

$ java -jar autoupgrade.jar  -listchecks
Check : AMD_EXISTS
        Description : Starting with Oracle Database 12c, the OLAP Catalog (OLAP AMD) is desupported and will be automatically marked as OPTION OFF during the database upgra
de if present. Oracle recommends removing OLAP Catalog (OLAP AMD) before database upgrade.  This step can be manually performed before the upgrade to reduce downtime.
        Fixup Action : Remove OLAP Catalog by running the {1} SQL script $ORACLE_HOME/olap/admin/catnoamd.sql script.
        Severity : WARNING
        Fixup Stage : PRE
        Min Version(inclusive) Check applies : NONE
        Max Version(exclusive) Check applies : NONE
        Check Introduced Version : NONE
        Check Removed Version : NONE
        Manual Fixup or Automatic : AUTO
        AutoUpgrade Only : NO
        Run for Datapatch : NO


Check : APEX_MANUAL_UPGRADE
        Description : Starting with Oracle Database Release 18, APEX is not upgraded automatically as part of the database upgrade. Refer to My Oracle Support Note 1088970.
1 for information about APEX installation and upgrades. Refer to MOS Note 1344948.1 for the minimum APEX version supported for your target database release. Unsupported ver
sions of APEX will be in an INVALID state when its database dependencies are not in sync with the upgraded database.
        Fixup Action : Upgrade Oracle Application Express (APEX) manually before or after the database upgrade.
        Severity : WARNING
        Fixup Stage : PRE
        Min Version(inclusive) Check applies : NONE
        Max Version(exclusive) Check applies : NONE
        Check Introduced Version : 18
        Check Removed Version : NONE
        Manual Fixup or Automatic : MANUAL
        AutoUpgrade Only : NO
        Run for Datapatch : NO


Check : APEX_PATCH
        Description : The APEX patching process is not performed by the {1} Oracle database upgrade.  The APEX version upgrade only ensures that the APEX version is upgrade
d to version {3} and does not guarantee the version is brought all the way to the patched level {2}.  If a PDB from this CDB is unplugged and plugged into another ROOT, the
.
.
.

チェックを指定して入力すると、listchecksにより、指定したチェックのチェックに関する詳細が提示されます。 

$ java -jar autoupgrade.jar  -listchecks XDB_RESOURCE_TYPE 
Check : XDB_RESOURCE_TYPE
        Description : Direct access to either TYPE XDB.XDB$RESOURCE_T or TABLE XDB.XDB$RESOURCE is restricted to Oracle internal code only.
        Fixup Action : Please contact Oracle Support to resolve the problem.
        Severity : ERROR
        Fixup Stage : PRE
        Min Version(inclusive) Check applies : 11.1
        Max Version(exclusive) Check applies : NONE
        Check Introduced Version : NONE
        Check Removed Version : NONE
        Manual Fixup or Automatic : MANUAL
        AutoUpgrade Only : NO
        Run for Datapatch : NO

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

load_password

AutoUpgradeパラメータload_passwordを使用すると、AutoUpgradeのキーストアにパスワードを安全に入力できます。 分析モードでAutoUpgradeを実行すると、必要なパスワードが通知され、AutoUpgradeキーストアにロードできます。AutoUpgrade 22.1以降では、後のデータベース・アップグレードの一環として透過的データ暗号化(TDE)キーストアのパスワードを入力できます。
プロパティ 説明
パラメータ・タイプ 文字列
構文 
-load_password
デフォルト値 なし。AutoUpgradeでは、対話型プロンプトで値の入力を求められます。

説明

アップグレードに必要なパスワードを提供するために、load_passwordパラメータを使用できます。このパラメータは、-configパラメータとともに使用する必要があります。引数はありません。かわりに、キーストアに必要な情報を提供できる特定のコマンドを使用して対話型プロンプトを起動します。

AutoUpgrade 22.1以降、キーストア外部パスワード・ストアがなく、TDEを使用する場合、load_passwordを使用してアップグレードに必要なTDEパスワードをロードできます。

ノート:

  • キーストア外部パスワード・ストアをデータベースで構成する場合、AutoUpgradeはキーストア外部パスワード・ストアの存在を検出し、TDEキーストア・パスワードを手動で入力するのではなく、この外部パスワード・ストアを使用します。ただし、すべてのデータベースがキーストア外部パスワード・ストアを使用して構成されている場合、引き続きglobal.keystoreの定義が必要になりることもあります。
  • 場合によっては、AutoUpgradeに、他の機密情報を書き込むためのAutoUpgradeキーストアへのアクセス権が必要になります。たとえば、AutoUpgradeは、ADMINISTER KEY MANAGEMENT EXPORT KEYSおよびADMINISTRATER KEY MANAGEMENT IMPORT KEYSコマンドによって使用される転送シークレット(パスフレーズ)をAutoUpgradeに書き込むことができます。

キーストア外部パスワード・ストアの詳細は、『Oracle Database Advanced Securityガイド』を参照してください。

-mode analyzeを使用してAutoUpgradeを実行すると、AutoUpgradeは、構成ファイルでアップグレードに指定されたデータベースに必要なパスワードを検出し、アップグレード前のサマリー・レポートにリストします。アップグレードの前に、-load_parameterを使用してデータベースのパスワードを入力できます。これらのパスワードは、global.keystoreで指定された場所にあるAutoUpgrade独自のキーストアに安全に格納されます。パスワードは、ソース・データベースのTDEキーストアにアクセスし、ターゲット・キーストアにTDEパスワードを書き込む場合にのみ使用されます。

注意:

AutoUpgradeを指定してglobal.keystoreで作成するディレクトリにはソフトウェア・キーストアが含まれているため、TDEキーストア・ファイルで使用する場合と同じセキュリティのベスト・プラクティスを使用して保護する必要があります。
コマンドラインで-load_parameterオプションを指定してAutoUpgradeを実行すると、AutoUpgradeでは対話型コンソールを起動してパスワード・オプションを構成できます。AutoUpgrade 22.1以降では、次の構成オプションを使用できます。

  • add ORACLE_SID [-pdb isolated-pdb]

    指定されたOracleシステム識別子(ORACLE_SID).のTDEパスワードを追加します

    パスワードを必要とする分離PDBがある場合、構成ファイルでオプションの-PDBパラメータを使用して、パスワードを指定する分離PDBを指定します。CDBルートおよびすべてのPDBが統一モードで構成されている場合、統一モードでは、キーストアがCDBルートと構成されているすべてのPDBの間で共有されるため、-pdbパラメータは必要ありません。

  • delete ORACLE_SID [-pdb isolated-pdb]

    指定されたOracleシステム識別子(ORACLE_SID)のロード済パスワードを削除します。

    削除する分離PDBのパスワードをロードしていた場合、構成ファイルでオプションの-pdb pdbnameパラメータを使用して、パスワードを削除する分離PDBの名前を指定します。CDBルートおよびすべてのPDBが統一モードで構成されている場合、-pdbパラメータは必要ありません。

  • list

    各Oracle DatabaseをOracleシステム識別子(ORACLE_SID)別にリストし、各データベースの詳細を提供し、暗号化されたデータベース・アップグレードを実行するために追加のアクションが必要かどうかを示します。AutoUpgradeは、構成ファイルにリストされたどのデータベースにも保留中のアクションがない場合にのみデプロイ・モードを開始します。データベースをアップグレードする前にアクションが必要な場合、AutoUpgradeチェックtde_passwords_requiredが事前チェック・ステージ中に失敗します。

  • group

    処理中のパスワード・グループを変更します。AutoUpgrade 22.1では、透過的データ暗号化(TDE)が唯一のグループ・オプションです。

  • save

    キーストアをglobal.keystoreディレクトリで指定された場所に保存します。自動ログイン・キーストアがまだ有効化されていない場合、キーストアを自動ログイン・キーストアに変換するかどうかを入力するよう求められます。

  • help

    使用可能なすべてのload_passwordコマンドをリストします。

  • exit

    load_password対話型コンソールを終了します。キーストアが変更され、まだ保存されていない場合は、終了する前にキーストアを保存するかどうかを確認するよう求められます。

アップグレード中に、AutoUpgradeがソース・データベース・キーストアにアクセスできるように、AutoUpgradeではメモリーの暗号化されたパスワード配列にパスワードを格納します。アップグレード中、SQL*Plusスクリプトにパスワードは書き込まれません。AutoUpgradeでパスワードが必要なくなった場合、これらのパスワードはメモリーから削除されます。パスワードのログ・レコードは保持されません。

例

AutoUpgradeキーストアに追加されたTDEキーストアのパスワード

AutoUpgradeを実行して、myconfig.cfgという名前の構成ファイルを使用して、TDEキーストアのパスワードをAutoUpgrade独自のキーストアに追加します(-load_passwordは、TDEキーストアのパスワードが必要なデータベースのTDEパスワードの入力を求めるために使用されます)。 

java -jar autoupgrade.jar -config myconfig.cfg -load_password

TDEパスワードがロードされた後、分析または構成モードでAutoUpgradeを実行できます。 

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

AutoUpgradeは、独自のキーストアのTDEパスワード・ファイルを使用してソース・データベースのTDEキーストアにアクセスし、ターゲット・データベースのキーストアにTDEパスワードを書き込みます。

複数のソース・データベースのアップグレードで使用される複数のロード・パスワード・オプション

次の例では、すべてのload_passwordコマンド・オプションを使用して、ソース・データベースdb12201、cdb122およびdb19xから共通ターゲットCDB cdb19xにTDEパスワードをロードします。 

$ java -jar autoupgrade.jar -config config.cfg -load_password
Processing config file ...

Starting AutoUpgrade Password Loader - Type help for available options
Creating new keystore - Password required
Enter password:
Enter password again:
Keystore was successfully created

TDE> add cdb19x
Enter your secret/Password:
Re-enter your secret/Password:
TDE> add cdb122
Enter your secret/Password:
Re-enter your secret/Password:
TDE> add db12201
Enter your secret/Password:
Re-enter your secret/Password:
TDE> add db19x
Enter your secret/Password:
Re-enter your secret/Password:
TDE> delete cdb19x
TDE> list
+----------+----------------+------------------+-----------+------------------+
|ORACLE_SID|Action Required | TDE Password     |SEPS Status|Active Wallet Type|
+----------+----------------+------------------+-----------+------------------+
|    cdb122|                |          Verified|   Inactive|               Any|
|    cdb19x|Add TDE password|No password loaded|   Inactive|               Any|
|   db12201|                |          Verified|   Inactive|        Auto-login|
|     db19x|                |          Verified|   Inactive|               Any|
+----------+----------------+------------------+-----------+------------------+
TDE> help
The following options are available
-----------------------------------
1 add
2 delete
3 list
4 group
5 save
6 help
7 exit

TDE> save
Convert the keystore to auto-login [YES|NO] ? YES
TDE> exit

AutoUpgrade Password Loader finished - Exiting AutoUpgrade

AutoUpgradeキーストアに追加された分離PDBのTDEキーストアのパスワードの追加

プラガブル・データベース(PDB)に独自のキーストアがある分離モードでは、PDBは独自のキーストアを別個に作成および管理ができます。分離モードのPDBの場合、AutoUpgradeパスワード・ローダーを起動し、構文add Oracle_SID -pdb pdbnameを使用します(Oracle_SIDはCDBルートの名前、pdbnameは分離PDBの名前です)。

たとえば、CDBルートがcdb19xで、分離PDB名がisoの場合: 

TDE> add cdb19x -pdb iso
Enter your secret/Password:
Re-enter your secret/Password:

関連項目

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

load_win_credential

AutoUpgradeパラメータload_win_credentialは、アップグレード中にAutoUpgradeを中断することなく実行できるように、PowerShellを使用して資格証明オブジェクトを作成します。

説明

Microsoft Windowsプラットフォームでのアップグレードに必要なパスワードを提供するために、load_win_credentialパラメータを使用できます。このパラメータは、-configパラメータと、ローカルのwincredentialパラメータを指定する構成ファイルとともに使用する必要があります。このパラメータは、Microsoft WindowsのPowerShell資格証明リクエストを起動します。このリクエストでは、PowerShell資格証明オブジェクトを作成するための管理者資格証明を指定できます。デフォルトでは、WindowsのPowerShell資格証明リクエストはローカル・マシン用です。資格証明(Oracleバイナリの所有者)のユーザー名とそのユーザー・パスワードを指定します。Windows Powershellでは、database-name.xmlという形式を使用して資格証明が生成されます。database-nameは、ローカル構成ファイルのsidエントリで指定したデータベースの名前です。たとえば、wincredentialエントリupg1.wincredential=C:\Users\oracle\credを持つ構成ファイルのupg1.sid=db12201は、パスupg1.wincredential=C:\Users\oracle\credにpowershell資格証明ファイルdb12201.xmlを生成します

データベースのアップグレードでAutoUpgradeを実行すると、AutoUpgradeはローカルのwincredentialで指定されたパスから資格証明を読み取り、アップグレード中に管理者が管理者の資格証明を手動で指定することなく、AutoUpgradeがターゲット・データベースでサービスを自動的に作成できます。

AutoUpgradeでパスワードが必要なくなった場合、これらのパスワードはメモリーから削除されます。パスワードのログ・レコードは保持されません。

例

次の例では、アップグレード中に管理者資格証明の呼出しを自動化するために、次のステップを完了します:

  1. wincredentialローカル・パラメータを使用して構成ファイルを作成し、ソース・データベースdb12201のWindows Powershell資格証明の場所を指定します: 

    
global.autoupg_log_dir=C:\Users\oracle\autoupg
global.target.version=19.0.0
global.target_home=C:\u01\app\oracle\product\19\dbhome_1

upg1.sid=db12201
upg1.source_home=C:\u01\app\oracle\product\12.2\dbhome_1
upg1.log_dir=C:\Users\Oracle\autoupg
upg1.upgrade_node=localhost
upg1.target_base=C:\u01\app\oracle
upg1.target_version=19.0.0.0
upg1.wincredential=C:\Users\oracle\cred

  2. load_win_credentialコマンドライン・パラメータを使用して、資格証明を指定するアップグレードのアップグレード接頭辞を指定して、構成モードでAutoUpgradeを実行します。たとえば: 

    C:\Users\oracle>java -jar autoupgrade.jar -config config.cfg -load_win_credential upg1
AutoUpgrade 24.1.240306 launched with default internal options
Processing config file ...
  3. Microsoft WindowsのPowershell資格証明プロンプトが開きます。Oracle Databaseバイナリ所有者の資格証明を指定します。次に、PowerShellは資格証明オブジェクト(この例ではdb12201.xml)を生成し、wincredentialパラメータで指定したパスに配置します。

  4. アップグレード中に、資格証明オブジェクト・パスを指定する構成ファイルを使用してAutoUpgradeを実行します。たとえば: 

    C:\Users\oracle>java -jar autoupgrade.jar -config config.cfg -mode deploy

    AutoUpgradeは、資格証明を要求せずにアップグレードを処理します。

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

mode

AutoUpgradeパラメータmodeの値は、AutoUpgradeの実行モードを設定します。

プロパティ 説明

パラメータ・タイプ

文字列

構文

-mode = [analyze|fixups|deploy|upgrade|postfixups]

デフォルト値

なし。次のいずれかのオプションを選択します。

  • analyze: ソースOracleホームでアップグレード準備状況チェックを実行します。
  • fixups: アップグレード準備状況チェックおよびアップグレード前の修正を実行しますが、アップグレードは実行しません。
  • deploy: データベースのアップグレードを最初から最後まで実行します。
  • upgrade: データベースのアップグレードおよびアップグレード後のアクションを実行します。このモードを開始する前に、ターゲットOracleホームのデータベースが稼働している必要があります。
  • postfixups: ターゲットOracleホームでデータベースの事後修正を実行します。

例

java -jar autoupgrade.jar -config config.cfg -mode analyze
java -jar autoupgrade.jar -config config.cfg -mode deploy
java -jar autoupgrade.jar -preupgrade "target_version=21" -mode fixups

親トピック: 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のコマンドライン・パラメータおよびオプション

preupgrade

AutoUpgradeパラメータpreupgradeは、データベース・チェックおよびほとんどの問題をアップグレードの開始前に修正するアップグレード前修正と、ほとんどの問題をアップグレードの完了後に修正するアップグレード後修正を実行します。

プロパティ 説明
パラメータ・タイプ 文字列
構文 
-preupgrade preupgrade_options -mode
      [analyze|fixups|postfixups]
デフォルト値 分析

説明

AutoUpgradeの-preupgrade.jar句は、以前のリリースで手動のアップグレード前情報ツール(preupgrade.jar)によって以前に実行された関数に置き換わります。-mode句は、次の3つの値のいずれかを取ります。

  • analyze: アップグレードの準備状況をシステムで確認します。
  • fixups: アップグレードの準備として、ソースOracle Databaseリリースで必要に応じて修正を実行します
  • postfixups: アップグレードの完了後にターゲットのOracle Databaseリリースで修正を実行します。

-modeの値が指定されていない場合、-preupgradeパラメータはデフォルトでanalyzeモードになります。

使用上のノート

アップグレード前情報ツール(preupgrade.jar)で以前に使用可能にした機能と同じ機能を取得する場合にのみ、preupgrade句を使用します。ほとんどのアップグレード・シナリオでは、このパラメータを使用する必要はありません。

-preupgradeパラメータにはpreupgrade_optionsが必要です。これは、カンマ区切りのオプションと値のペアのリストを次の形式で指定します。option1=value1,option2=value2,…

引数

  • target_version=release-number: アップグレード先のリリースであるターゲットのOracle Databaseリリース・バージョンを指定します。

    この引数の値は、analyzeおよびfixupsモードで必要です。ただし、ターゲット・リリースはtarget_homeから導出できます。したがって、analyzeおよびfixupsモードでは、target_versionまたはtarget_homeのいずれかを指定する必要があります。target_versionの値は、12.2以上のリリース値である必要があります。

  • target_home=[target-path|env-variable]: アップグレード先のターゲット・リリースのOracle Databaseホームの場所を指定します(Oracleホーム・パスまたはオペレーティング・システム・パス変数のいずれか)。

    postfixupsモードを選択した場合、この引数は必須です。postfixupsモードを選択し、ターゲット・ホーム・パスを指定しない場合、デフォルト値は、AutoUpgradeを実行しているユーザーのOracleホーム・セットのOracleホーム環境変数(LinuxおよびUnixシステムの場合は$ORACLE_HOME、Microsoft Windowsシステムの場合は%ORACLE_HOME%)によって指定されます。

  • oh=[source-path|env-variable]: アップグレード元のソース・リリースのOracle Databaseホームの場所を指定します(Oracleホーム・パスまたはオペレーティング・システム・パス変数のいずれか)。

    analyzeまたはfixupsモードを選択する場合、この引数は必須です。analyzeまたはfixupsモードを選択し、ソース・ホーム・パスを指定しない場合、デフォルト値は、AutoUpgradeを実行しているユーザーのOracleホーム・セットのOracleホーム環境変数(LinuxおよびUnixシステムでは$ORACLE_HOME、Microsoft Windowsシステムでは%ORACLE_HOME%)によって指定されます。

  • sid=system-identifier: アップグレードするソース・データベースのOracleシステム識別子を指定します。この引数は、analyzeまたはfixupsモードでは必須です。analyzeまたはfixupsモードのいずれかを選択し、システム識別子を指定しない場合、デフォルト値は、AutoUpgradeを実行しているユーザーのOracleホーム・セットのOracleホーム環境変数(LinuxおよびUnixシステムでは$ORACLE_SID、Microsoft Windowsシステムでは%ORACLE_SID%)によって指定されます。

  • dir=path: 出力を特定のディレクトリに送ります。dir引数で出力ディレクトリを指定しなかった場合は、システムの一時ディレクトリに配置されているautoupgradeというフォルダに出力されます。通常、このディレクトリは次のいずれかの場所にあります。
    • LinuxまたはUnix: /tmpまたは/var/tmp。
    • Microsoft Windows: C:\WINNT\TEMP

  • inclusion_list=list: 処理に含めるコンテナ・データベース(CDB)内のプラガブル・データベース(PDB)のリストを指定します。処理するPDBのスペース区切りリストを次のいずれかの形式で指定します。pdb1、pdb2およびpdb3は処理するPDBです。

    • pdb1 pdb2 pdb3
    • (pdb1 pdb2 pdb3)

    PDBのリストを指定しない場合、CDB内のすべてのPDBが処理されます。

  • exclusion_list=list: 処理対象から除外するコンテナ・データベース(CDB)内のプラガブル・データベース(PDB)のリストを指定します。処理するPDBのスペース区切りリストを次のいずれかの形式で指定します。pdb1、pdb2およびpdb3は処理するPDBです。

    • pdb1 pdb2 pdb3
    • (pdb1 pdb2 pdb3)

    PDBのリストを指定しない場合、CDB内のすべてのPDBが処理されます。

  • user=username: AutoUpgradeユーティリティがOracle Databaseへの接続に使用するOracle Databaseユーザー名を指定します。ユーザーが指定されている場合、AutoUpgradeはコマンドラインでユーザー名パスワードの入力を求めます。ユーザー名が指定されていない場合、AutoUpgradeはOracle Database接続にオペレーティング・システム認証を使用します。

モード

  • analyze(デフォルト値): 指定したターゲット・リリース引数に適用されるすべてのアップグレード前チェックを使用して、分析モードで自動アップグレードを実行します。モードを指定しない場合、AutoUpgradeはデフォルトでanalyzeになります。

  • fixups: アップグレード前に修正する必要があるソース・データベースで、AutoUpgrade Analyzeのアップグレード前チェックによって報告されたすべての問題に対してアップグレード前修正(使用可能な場合)を実行します。すべてのチェックが実行されます。

    修正結果は、ファイルupgrade.xmlにレポートされます。このファイルはパスlog_dir/db_name/jobnumber/prefixups/prefixups.xmlに配置されます。ここで、log_dirはdir引数を使用して指定するログ・ディレクトリ、db_nameはソース・データベースの名前、jobnumberは自動アップグレード・ジョブ番号です。

  • postfixups: アップグレードの完了後に修正する必要があるアップグレード済データベースで、AutoUpgrade Analyzeのアップグレード前チェックによって報告されたすべての問題に対してアップグレード後修正(使用可能な場合)を実行します。

    修正後の結果は、ファイルpostfixups.xmlに報告されます。このファイルはパスlog_dir/db_name/jobnumber/postfixupsに配置されます。ここで、log_dirはdir引数を使用して指定するログ・ディレクトリ、db_nameはソース・データベースの名前、jobnumberは自動アップグレード・ジョブ番号です。

例

analyzeモードを使用してpreupgrade句を指定し、ターゲット・リリースがOracle Database 23cであることを指定してAutoUpgradeを実行します。 

java -jar autoupgrade.jar -preupgrade "target_version=23" -mode analyze

fixupsモードを使用してpreupgrade句を指定し、ターゲット・リリースがOracle Database 23cであることを指定してAutoUpgradeを実行します。 

java -jar autoupgrade.jar -preupgrade "target_version=23" -mode fixups

postfixupsモードを使用してpreupgrade句でAutoUpgradeを実行し、ターゲットのOracleホームがパスC:\app\oracle\product\23.0.0\dbhome_1に存在することを指定します。 

java -jar autoupgrade.jar -preupgrade "target_home=C:\app\oracle\product\23.0.0\dbhome_1" -mode postfixups

モードを指定せずにpreupgrade句を指定してAutoUpgradeを実行し、ターゲット・リリースがOracle Database 23cであることを指定します。この場合、使用されるモードはデフォルト・モードのanalyzeです。 

java -jar autoupgrade.jar -preupgrade "target_version=23"

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

settings

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

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

説明

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

使用上のノート

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

例

この例では、settingsでmy_custom_advanced_settings.cfgという設定入力ファイルを指定しています。 

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.version 22.1.220304
build.date 2022/03/04 13:29:34 -0500
build.hash 29007da
build.hash_date 2022/03/04 12:48:36 -0500
build.supported_target_versions 12.2,18,19,21
build.type production

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

restore

AutoUpgradeパラメータrestoreは、指定したAutoUpgradeジョブのシステム・レベルのリストアを実行します。

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

説明

このオプション・パラメータは、カンマ区切りのジョブ番号のリストを使用して、指定したジョブのシステムレベルのリストアを指定する場合に使用します。指定したアップグレード・ジョブのデータベースは、保証付きリストア・ポイント(GRP)にフラッシュバックされます。このコマンドを実行する前に、GRPがAutoUpgradeによって作成されている必要があります。

例

java -jar autoupgrade.jar -config config.cfg -restore -jobs 111
java -jar autoupgrade.jar -config config.cfg -restore -jobs 111,222 -console
java -jar autoupgrade.jar -config config.cfg -restore -jobs 111,222 -noconsole

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

restore_on_fail

AutoUpgradeパラメータrestore_on_failは、デプロイメント中に失敗したジョブを自動的にリストアします。

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

説明

このオプション・パラメータは、アップグレード・デプロイメント中に失敗したジョブをAutoUpgradeでリストアすることを指定する場合に使用します。

例

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

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション

zip

AutoUpgradeパラメータzipは、AutoUpgradeサービス・リクエストのファイリングに必要なログ・ファイルのzipファイルを作成します。

プロパティ 説明
パラメータ・タイプ 文字列
構文 
-zip [-sid sid] [-d dir] [-zip_exclusion_list exclusion_list]
デフォルト値 該当なし。

説明

このオプション・パラメータは、サービス・リクエストのオブジェクトであるジョブのログ・ファイルを含むOracleサポートに送信できるzipファイルを作成する場合に使用します。-sid句を使用して、ログ・ファイルを送信するデータベースのシステム識別子(SID)のカンマ区切りリストを指定できます。SID値が定義されていない場合は、AutoUpgradeによって、構成ファイルに指定されているすべてのデータベースのzipファイルが作成されます。-d 句を使用して、特定の出力ディレクトリを指定します。ディレクトリが指定されていない場合、コマンドの実行元の現在のディレクトリがzipファイルの出力に使用されます。-zip_exclusion_list句を使用して、通常の文字列に一致するファイルをzipファイルから除外するために使用される二重カンマ区切りの通常の文字列リストを指定します。

使用上のノート

ノート:

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

例

java -jar autoupgrade.jar -config yourconfig.cfg -zip java -jar autoupgrade.jar -config yourconfig.cfg -zip -sid sales1,sales2 -d /scratch/upgrd java -jar autoupgrade.jar -config yourconfig.cfg -zip -zip_exclusion_list ".*/db11204/.*" java -jar autoupgrade.jar -config yourconfig.cfg -zip -zip_exclusion_list "/home/oracle/autopatch/DB19X/100/goldimage/db_home_2023-09-21_09-18-13AM.zip,,/home/oracle/autopatch/DB19X/100/extract/35320081/.*"

親トピック: AutoUpgradeのコマンドライン・パラメータおよびオプション