AutoUpgrade構成ファイルの共通パラメータ(アップグレードとパッチ)

AutoUpgrade構成ファイル(config)の共通パラメータは、upgrade操作とソフトウェア・メンテナンス-patch操作の両方で使用できます。

AutoUpgrade構成ファイルのローカルに変更可能なグローバル共通パラメータ

AutoUpgrade構成ファイルの共通のローカルに変更可能なグローバル・パラメータを使用すると、データベース固有のローカル・パラメータで上書きできる変更可能なグローバル・パラメータを構成(config)ファイルに設定できます。

dictionary_stats_after

(オプション)アップグレードの完了後に、AutoUpgradeがターゲット・データベースのデータ・ディクショナリ統計を収集するように指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

データ・ディクショナリ表はアップグレード中に変更され、作成されるため、データベースのアップグレードの前後でディクショナリ統計を収集することをお薦めします。yesを指定すると、AutoUpgradeはアップグレードの完了後にディクショナリ統計を収集します。

オプション

[yes | no]

デフォルト値はYesです。

global.dictionary_stats_after=yes
sales.dictionary_stats_after=yes

dictionary_stats_before

(オプション)アップグレードを開始する前に、AutoUpgradeがソース・データベースのデータ・ディクショナリ統計を収集するように指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

データ・ディクショナリ表はアップグレード中に変更され、作成されるため、データベースのアップグレードの前後でディクショナリ統計を収集することをお薦めします。yesを指定すると、AutoUpgradeはアップグレードを開始する前にディクショナリ統計を収集します。

オプション

[yes | no]

デフォルト値はYesです。

global.dictionary_stats_before=yes
sales.dictionary_stats_before=yes

fixed_stats_before

(オプション)アップグレードを開始する前に、AutoUpgradeがソース・データベースの固定オブジェクトの統計を収集するように指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

アップグレードの前に、固定オブジェクトの統計を再収集することをお薦めします。

固定オブジェクトは、X$表とその索引です。V$パフォーマンス・ビューは、X$表を通じて定義されます。固定オブジェクトの統計の収集は、データベース・パフォーマンスにとって有益で(それらの統計はオプティマイザが適切な実行計画を生成する際に役立つため)、データベース・パフォーマンスが向上する可能性があります。代表的な統計を取得しないと、実行計画が最適ではなくなる可能性があり、深刻なパフォーマンス問題が発生する場合があります。

オプション

[yes | no]

デフォルト値はYesです。

global.fixed_stats_before=yes
sales.fixed_stats_before=yes

rman_catalog_connect_string

(オプション) RMANデータベースへの接続に使用するRMAN接続文字列を指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

この機能を使用するには、AutoUpgradeコマンドライン・パラメータload_passwordを使用して、RMANのユーザー名とパスワードをキーストアに保存する必要があります。

global.target_base=/u01/app/oracle
sales4.rman_catalog_connect_string=string-alias

target_home

(ターゲット・ホームがシステム上にない場合で、アップグレード・モードおよびデプロイ・モードの場合は必須です。分析および修正モードの場合はオプションです。)ターゲットOracleホーム(ORACLE_HOME)パスを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

このオプションを使用して、アップグレードまたはパッチ適用ジョブのターゲット・データベース・ホームへのパスを指定します。このパラメータは、グローバルなtarget_home設定を上書きできます。

sales1.target_home=/target/Oracle/home

オプション

以前のリリースのAutoUpgradeでは、target_homeおよびtarget_versionを設定する必要がありました。AutoUpgradeの以降のリリースでは、この制限はAnalyzeモードとFixupsモードの両方で解除されました。ただし、target_homeを設定しない場合は、target_versionを指定する必要があります。いずれかを指定する必要があります。


sales3.target_home=/U01/app/oracle/product/19.0.0/dbhome_1
sales1.target_home=/U01/app/oracle/product/23.0.0/dbhome_1

restoration

(オプション)データベースのリストアに保証付きリストア・ポイント(GRP)を生成します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

デフォルト値(yes)のままにした場合、GRPを作成するには高速リカバリ領域の構成が必要です。restoration=noを設定する場合は、データベースのバックアップおよびリストアを手動で実行する必要があります。NOARCHIVELOGモードで動作するデータベース、およびOracle Flashback Technology機能のフラッシュバック・データベースをサポートしていないStandard EditionおよびStandard Edition 2データベースの場合、noに設定します。パラメータを指定しない場合、デフォルト値(yes)が使用され、保証付きリストア・ポイントが作成されます。

オプション

[yes | no]

デフォルト値はyes

sales1.restoration=no

source_base

(オプション)ソースOracleホームのソースORACLE_BASEパスを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

source_base=/u01/app/oracle
sales4.source_base=/u04/app/oracle4

wincredential

(オプション) AutoUpgradeコマンドライン・パラメータload_win_credentialで以前に生成したMicrosoft Windows資格証明オブジェクト・ファイルの場所を指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

このパラメータの目的は、Oracleデータベース・バイナリの所有者のユーザーおよびパスワード資格証明を格納する資格証明ファイルを作成し、それらの資格証明の管理者PowerShell資格証明オブジェクトの場所を指定して、Oracle Databaseのアップグレード時にその資格証明オブジェクトを使用してAutoUpgradeを実行できるようにすることです。この機能を使用するには、WindowsのPowerShell資格証明オブジェクトをすでに作成し、wincredentialを使用して構成ファイルにその資格証明オブジェクトを指定する必要があります。

ユースケース:

Microsoft Windowsサーバー上のデータベース・バイナリの所有者の資格証明を指定するとします。これらの資格証明を指定するには、構成ファイルでwincredentialパラメータを入力した後、load_win_credentialsコマンドライン・パラメータを使用して構成モードでAutoUpgradeを実行し、プロンプトに従って資格証明を指定します。次に、Microsoft Windows Powershellによって資格証明オブジェクトが作成され、生成された資格証明オブジェクトがwincredentialで指定したパスの場所に格納されます。たとえば、次のファイルでは、資格証明ファイルの場所をupg1.wincredential=C:\Users\oracle\credで指定します


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

AutoUpgrade構成ファイルのローカル共通パラメータ

共通ローカル・パラメータを使用すると、ソフトウェア・メンテナンス(-patch)またはアップグレード(upgrade)のいずれかのために、特定のOracle Databaseの構成ファイル(config)でAutoUpgrade処理を構成できます。

after_action

(オプション) deployモードでは、接頭辞アドレスで識別されるデータベースのアップグレード・デプロイ・ジョブの完了後に実行するカスタム・アクションを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

使用するスクリプトはname.ext (たとえば、myscript.sh)の形式である必要があります。これにより、AutoUpgradeは実行するスクリプトのタイプを識別できます。

許可される拡張子オプション:

  • UNIXシェル(.sh)
  • Microsoft Windowsバッチ(.bat.cmd)
  • Microsoft Windows PowerShell (.ps1)
  • Oracle SQLファイル(.sql)。接頭辞によって指定されたローカル操作のみ。

ノート:

AutoUpgradeパッチ適用のafter_action.deployおよびafter_action.create_homeパラメータとローカル・パラメータafter_actionを同じ構成ファイルで指定することはできません。

デフォルトでは、スクリプトが失敗すると、AutoUpgradeが引き続き実行されます。オペレーティング・システムがスクリプトの失敗を検出した場合、Yフラグを使用してAutoUpgradeが停止するように指定します。スクリプトが0とは異なるステータスで終了すると、失敗して完了したとみなされます。

グローバルのafter_actionパラメータとは対照的に、ローカルのafter_actionパラメータはSQLスクリプトを指定でき、非CDBのOracleホーム上のターゲットOracleデータベース・バイナリまたはCDB$ROOTを使用してデータベースで実行されます。追加のコンテナ固有のアクションを実行する場合、コード内でこれらを設定する必要があります。より複雑なシナリオでは、シェルでコンテナ固有のアクションを実行できます。

スクリプトの出力が取得され、ファイルに格納されます。stdoutstderrの両方が取得されます。ファイルは、特定のデータベースまたはジョブに一致するディレクトリのpostupgradeサブディレクトリに格納されます。

次の環境変数はスクリプトを実行するシェルに設定されます。

  • ORACLE_SID
  • ORACLE_UNQNAME
  • ORACLE_BASE
  • ORACLE_HOME
  • TNS_ADMIN

AutoUpgradeが処理を開始した後に、指定したスクリプトを実行します。スクリプトが失敗した場合にAutoUpgradeを停止するには、次のようにYフラグを設定します。

sales2.after_action=/user/path/script.sh Y 

AutoUpgradeが処理を開始した後に、指定したスクリプトを実行します。スクリプトが失敗した場合に実行を継続するには、次のようにAutoUpgradeを設定します:

sales3.after_action=/user/path/script.sh 

before_action

(オプション) deployモードでは、接頭辞で指定された特定のデータベース・ジョブのアップグレード・ジョブの起動前に実行するカスタム・アクションを指定します。すべてのアップグレード・ジョブの前にスクリプトを実行する場合は、ローカル・パラメータ (global.before_action)を使用してそのスクリプトを指定します

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

使用するスクリプトはname.ext (たとえば、myscript.sh)の形式である必要があります。これにより、AutoUpgradeは実行するスクリプトのタイプを識別できます。許可される拡張子オプション:

  • UNIXシェル(.sh)
  • Microsoft Windowsバッチ(.bat.cmd)
  • Microsoft Windows PowerShell (.ps1)
  • Oracle SQLファイル(.sql)。接頭辞によって指定されたローカル操作の場合のみ。

ノート:

AutoUpgradeパッチ適用のbefore_action.deployパラメータとローカル・パラメータのbefore_actionパラメータを同じ構成ファイルで指定することはできません。

デフォルトでは、スクリプトが失敗すると、AutoUpgradeが引き続き実行されます。オペレーティング・システムがスクリプトの失敗を検出した場合、Yフラグを使用してAutoUpgradeが停止するように指定します。スクリプトが0とは異なるステータスで終了すると、失敗して完了したとみなされます。

グローバルbefore_actionパラメータとは対照的に、ローカルbefore_actionパラメータはSQLスクリプトを指定でき、これは前のリリースのOracle Databaseバイナリを使用して、ソース・データベースのOracleホームのデータベースで実行されます。スクリプトは非CDBのOracleホームまたはCDB$ROOTで実行されます。追加のコンテナ固有のアクションを実行する場合、コード内でこれらを設定する必要があります。より複雑なシナリオでは、シェルでコンテナ固有のアクションを実行できます。

スクリプトの出力が取得され、ファイルに格納されます。stdoutstderrの両方が取得されます。ファイルは、特定のデータベースまたはジョブに一致するディレクトリのpreupgradeサブディレクトリに格納されます。

次の環境変数はスクリプトを実行するシェルに設定されます。

  • ORACLE_SID
  • ORACLE_UNQNAME
  • ORACLE_BASE
  • ORACLE_HOME
  • TNS_ADMIN

AutoUpgradeがdeployモードの処理を開始する前に、指定したスクリプトを実行します。スクリプトが失敗した場合にAutoUpgradeを停止するには、次のようにYフラグを設定します。

sales.before_action=/user/path/script.sh Y 

AutoUpgradeが処理を開始する前に、指定したスクリプトを実行します。スクリプトが失敗した場合実行を継続するには、次のようにAutoUpgradeを設定します。

sales4.before_action=/user/path/script.sh 

checklist

(オプション)ポリシーまたはセキュリティ上の問題のために自動的に実装しない修正など、AutoUpgradeによって実行される修正のデフォルト・リストをオーバーライドするために使用できるチェックリストへのパスを指定します。

使用上のノート

他のAutoUpgradeモードでこのパラメータを使用するには、analyzeモードでAutoUpgradeを実行する必要があります。AutoUpgradeで分析が終了すると、事前チェック・ディレクトリ(dbname_checklist.cfg)の下のデータベース名によって識別されるチェックリスト・ファイルを検索できます。ファイルを手動で更新して、AutoUpgradeでバイパスする修正を除外し、ファイルを新しい名前で保存します。AutoUpgradeを再度実行すると、作成したチェックリスト・ファイルを指すパラメータを指定し、個々のデータベースに対して実行された修正を変更できます。チェックリスト・ファイル・パスを指定しない場合、アップグレード時に実行される修正のセットは、指定したデプロイ・モードで作成される最新バージョンのチェックリスト・ファイルです。

sales.checklist=/u01/app/oracle/upgrade-jobs/salesdb_checklist.cfg

前述の例では、salesdb_checklist.cfgはデータベースsalesdbのチェックリスト構成ファイルです。

create_listener

(オプション)アップグレード後に、新しいOracleホームにリスナーを作成します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

デプロイ・モードでは、AutoUpgradeは新しい(ターゲット) Oracleホームにリスナーを作成できます。4つのオプションがあります。

  • (デフォルト)ポート1521にLISTENERという名前の新しいリスナーを作成します。
  • カスタム・リスナー名とポート番号の両方を指定します。(例: my_listener:49152)
  • リスナー名およびポートのカンマ区切りリストを指定して、複数のリスナーを作成します。(例: listener_name1:listener_port1,listener_name2:listener_port2, . . .)。
  • リスナー設定を構成するレスポンス・ファイル(NETCAによって生成されたレスポンス・ファイルなど)へのパスを指定します。(例: /path/to/responsefile.rsp)

このパラメータは、新しいOracleホームにリスナーを作成する場合、特に特定の要件に基づいてリスナーを作成する場合に使用します。

ノート:

リスナーは一意の名前にする必要があります。以前のリリースのOracleホームから新しいリリースのOracleホームへの移行中に競合を回避し、このパラメータ・オプションを使用する場合は、現在のOracleホームに既存のリスナーが存在するので、一意のリスナー名を作成する必要があります。

その他のAutoUpgradeモードでは、create_listener構成の選択を検証できますが、リスナーの実際の作成は、アップグレード後のステージでデプロイ・モード中にのみ行われます。リスナーが作成されると、AutoUpgradeが自動的にリスナーを起動します。エラーが発生した場合、AutoUpgradeは中断せずにアップグレード・ジョブを完了し続けますが、リスナー作成プロセスが失敗した理由に関する情報を示す警告メッセージをログに記録します。これにより、リスナー作成プロセス中に発生する可能性のある問題を可視化しながら、シームレスなアップグレード・エクスペリエンスが保証されます。

このパラメータが設定されている場合、AutoUpgradeではレスポンス・ファイル・テンプレートを使用して、ターゲットOracleホームで指定したリスナー・オプションのレスポンス・ファイルを作成します。デフォルトでは、このレスポンス・ファイルはOracle_home/assistants/netca/netca.rspにあります。

Microsoft Windowsプラットフォームでは、Oracleホームはセキュアなユーザー権限でインストールされるため、AutoUpgradeでは、リスナーを作成するために明示的な認証権限が必要です。したがって、このパラメータを使用する場合は、次のようにSERVICEUSERPASSWORDパラメータを更新して、デフォルトのnetca.rspファイルを変更する必要があります。

  1. 先頭のハッシュ記号(#)を削除します。

  2. ハッシュ記号を、引用符で囲まれたデータベース・インストール所有者ユーザー・アカウントの実際のパスワードに置き換えます。たとえば:

    SERVICEUSERPASSWORD="*******"

構文

create_lister[=default|my_listener:my_port|listener_name1:listener_port1,listener_name2:listener_port2, . . .|/path/to/responsefile.rsp]

制限事項

  • 名前には英数字、ポートには数値を使用してリスナーを指定する必要があります。
  • レスポンス・ファイルへのパスを使用する場合、レスポンス・ファイル・ターゲットは有効なレスポンス・ファイルである必要があります。

デフォルト値でリスナーを作成します:

upg1.create_listener=default 

ポート54321にsales_listenerという名前のリスナーを作成します:

upg1.create_listener=sales_listener:54321 

delete_wincredential_file

(オプション) AutoUpgradeジョブの完了時にMicrosoft Windows資格証明オブジェクト・ファイルを削除します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

NOに設定すると、AutoUpgradeは、Microsoft Windowsファイル資格証明を最初に使用するAutoUpgradeジョブの完了後に資格証明を削除しません。デフォルト値はYESです。

このパラメータの目的は、wincredentialパラメータでロードされたMicrosoft Windowsオブジェクト資格証明が最初に使用された後に、AutoUpgradeでこれらの資格証明をすぐに削除するか、他のAutoUpgradeパッチ適用またはアップグレード操作でWindowsオブジェクト資格証明を再利用できるようにするかを選択できるようにすることです。

ノート:

delete_wincredential_fileNOに設定した場合は、AutoUpgradeジョブの完了後にその資格証明を手動で削除する必要があります。AutoUpgradeから、アップグレード後のサマリー・レポートに、Windows資格証明ファイルが削除されなかったことと、この資格証明ファイルを手動で削除する必要があることが通知されます。

ユースケース:

AutoUpgradeを使用して複数のアップグレードまたはパッチ適用操作を実行しており、複数のアップグレードまたはパッチ適用操作がすべて自動的に完了できるように、Microsoft Windowsサーバー上のデータベース・バイナリの所有者の資格証明を指定したいと考えています。wincredentialパラメータを指定して資格証明をロードし、さらにdelete_wincredential_fileNOに指定すると、AutoUpgradeは、同じOracle Databaseの複数のアップグレードまたはパッチに対しても、異なるOracle Databasesに対してもその資格証明を使用できます。この機能を使用するには、WindowsのPowerShell資格証明オブジェクトをすでに作成し、wincredentialを使用して構成ファイルにその資格証明オブジェクトを指定する必要があります。

次の例では、ローカル構成ファイル設定wincredentialは、Microsoft Windows資格証明がロードされた場所を指定し、delete_wincredential_file=NOは、db12201データベース操作の完了後にAutoUpgradeでWindowsオブジェクト資格証明ファイルを自動的に削除しないことを指定します。

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
upg1.delete_wincredential_file=NO

em_blackout_suffix

(オプション)デフォルトのAutoUpgradeブラックアウトに追加する接尾辞を指定できます。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

Enterprise Managerコマンドライン・インタフェース(EMCLI)を使用すると、AutoUpgradeでスケジュール済のブラックアウトを使用して、1つ以上のモニター対象ターゲットのデータ収集アクティビティを一時停止できます。このパラメータを使用して、AutoUpgradeブラックアウトに特定の接尾辞を指定します。デフォルトでは、EMCLIを使用してブラックアウトを作成できるようにすると、EMCLIログ・ファイル内のデフォルトのブラックアウト名は次のようになります。sidはブラックアウトが有効になっているデータベースのシステム識別子です:

blackout_AutoUpgrade_sid

em_blackout_suffixを指定すると、システム識別子(sid)の他に接尾辞(blackout-suffix)を指定できるため、AutoUpgradeプロセスをより正確に追跡できます。

構文

em_blackout_AutoUpgrade_sid_blackout-suffix

構成ファイルのアップグレード・セットを更新していて、接頭辞upg1が指定されたアップグレード・セットで、システム識別子sales1のデータベースに接尾辞を付加するとします。選択した接尾辞はq3-updatesです。これを行うには、次のようにem_blackout_autoupgradeを使用します:

upg1.em_blackout_autoupgrade_sid_q3-updates

em_target_name

(オプション)名前を付けたデータベースがEnterprise Managerによってモニターされるように指定して、モニタリングを新しいOracleホームに更新できるようにします。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

AutoUpgadeでは、Enterprise Managerコマンドライン・インタフェース(EMCLI)を使用して、Enterprise Managerのモニタリングを新しいOracle Databaseホームに更新できます。ただし、データベースを新しいOracleホームに更新するようにAutoUpgadeが構成されるように、Enterprise Managerターゲット名を指定する必要があります。

構文

構成ファイルにパラメータを入力します。ここで、em-target-nameは、Oracleホーム属性を更新する必要があるEnterprise Managerターゲット名です:

em_target_name=em-target-name

完全なEnterprise Managerターゲット名を入力する必要があります。

新しいOracleホームを指すように、Enterprise Managerのモニター対象データベースsales1_host1.domain.internalを更新します

upg1.em_target_name=sales1_host1.domain.internal

emcli_path

(オプション) Enterprise Managerコマンドライン・インタフェース(EMCLI)コマンドへのパスを指定できます。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

AutoUpgadeでは、Enterprise Managerコマンドライン・インタフェース(EMCLI)を使用して、アップグレードまたはパッチ適用中にタスクを実行できます。ただし、コマンドにアクセスするには、モニター対象データベースを新しいOracleホームに更新するためにEMCTLがモニターしているデータベースのEMCTLパスへのパスをAutoUpgradeに指定する必要があります。

構文

emctl_path=path-to-emctl-location

構成ファイルのアップグレード・セットを更新していて、接頭辞upg1が指定されたアップグレード・セットで、Enterprise Managerのモニター対象データベースを新しいOracleホームに更新するとします。Enterprise Managerコマンドライン・インタフェースのホームへのパスはvar/opt/dbascripts/emcli/です。これを行うには、次のようにemctl_pathを使用します:

upg1.emctl_path=var/opt/dbascripts/emcli/

env

(オプション) ORACLE_SIDORACLE_HOMEORACLE_BASEおよびTNS_ADMINを除く、オペレーティング・システムに設定されているカスタム・オペレーティング・システム環境変数を指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

このパラメータを使用して、データベースsqlnet.oraファイルに示されている環境設定(Oracleウォレットに使用されるセキュア・ソケット・レイヤー暗号スイートなど)を指定します。複数設定するには、カンマで区切ります。

構文:

prefix=VARIABLE1=value1 [, VARIABLE2=value2, ...]

PDB sales2の場合、WALLET_LOCATIONの値はカスタム環境変数を使用して設定されるとします。

WALLET_LOCATION=
  (SOURCE=
    (METHOD=file)
    (METHOD_DATA=(DIRECTORY=/databases/wallets/$CUSTOM_ENV1/$CUSTOM_ENV2))

その場合、AutoUpgradeでそれらのカスタム環境変数の値を認識するには、envパラメータ(dir1は環境変数CUSTOM_ENV1によって指定されるパス、dir2CUSTOM_ENV2によって指定されるパス)を使用して指定する必要があります。

sales2.env=CUSTOM_ENV1=dir1,CUSTOM_ENV2=dir2

log_dir

(オプション)パラメータの接頭辞で識別されるアップグレード・ジョブに含まれるデータベース・セットにあるデータベース・アップグレード用に生成されるログ・ファイルの場所を設定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

設定すると、AutoUpgradeは、指定したローカル・ログ・ファイル・パスに基づいて階層ディレクトリを作成します。たとえば、ジョブ識別子の接頭辞はsalesで、log_dirupgrade-jobsとして識別され、stage1stage2およびstagenはアップグレードのステージを表します。

/u01/app/oracle/upgrade-jobs
                                      /temp/
                                      /sales/
                                      /sales/stage1
                                      /sales/stage2
                                      /sales/stagen

チルダ(~)など、パスにワイルド・カードを使用することはできません。完全なパスを使用する必要があります。

ノート:

Microsoft Windowsプラットフォームでは、global.autoupg_loglog_dirを同じドライブで構成する必要があります。

salesdb.log_dir=/u01/app/oracle/upgrade-jobs

デフォルトでは、グローバル構成ファイル・パラメータglobal.autoupg_log_dirが指定され、log_dirを指定しない場合、global.autoupg_log_dirで指定されたパスがデフォルトになります。

global.autoupg_log_dirlog_dirも指定されていない場合、デフォルトでは、ログ・ファイルは構成ファイルに含めるデータベースのorabaseユーティリティで示される場所に配置されます。その場合、デフォルトのログ・ディレクトリはパスORACLE_BASE/cfgtoollogs/autoupgradeにあります。

構成ファイルに含まれるすべてのデータベースについてorabaseユーティリティが失敗した場合、ログ・ファイルの場所は、AutoUpgradeを実行しているユーザーのtempディレクトリに基づきます。

revert_after_action

(オプション)接頭辞によって指定された特定のデータベース・ジョブに対してシステムのリストアが完了し、データベースが稼働した後にオペレーティング・システムで実行するカスタム・アクションを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

revert_after_actionで指定するアクションは、リストア・プロセスが完了し、データベースが稼働した後、ターゲットのOracleホーム・バイナリで実行されます。

実行するように指定するスクリプトはname.ext (例: myscript.sh)の形式である必要があります。これにより、AutoUpgradeは実行するスクリプトのタイプを識別できます。許可される拡張子オプション:

  • UNIXシェル(.sh)
  • Microsoft Windowsバッチ(.bat.cmd)
  • Microsoft Windows PowerShell (.ps1)
  • Oracle SQLスクリプト(.sql)。revert_before_actionパラメータ接頭辞で指定されたデータベースのローカル操作の場合。

オプション

失敗時に停止します: [Y|N]。デフォルトはNです。

デフォルトでは、指定したスクリプトが失敗すると、AutoUpgradeは引き続き実行されます(N)。スクリプトが失敗した場合にAutoUpgradeが停止するように指定するには、Yフラグを使用します。スクリプトが0以外のステータスでオペレーティング・システムで実行を終了した場合、AutoUpgradeはスクリプトを失敗として識別します。

AutoUpgradeがリストアの処理を完了した後に、オペレーティング・システムで指定したスクリプトを実行します。スクリプトが失敗した場合にAutoUpgradeを停止するには、Yフラグを設定します。

sales3.revert_after_action =/user/path/script.sh Y

AutoUpgradeがリストアの処理を完了した後に、オペレーティング・システムで指定したスクリプトを実行します。フラグを指定しないと、デフォルトの失敗時に停止するオプションはNであるため、スクリプトが失敗した場合、AutoUpgradeは引き続き実行されます。

sales3.revert_after_action =/user/path/script.sh

revert_before_action

(オプション)接頭辞によって指定された特定のデータベース・ジョブに対してシステムのリストアが完了し、データベースが稼働する前にオペレーティング・システムで実行するカスタム・アクションを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

revert_before_actionで指定するアクションは、データベースのリストアが開始されてデータベースが稼働する前に、ターゲットのOracleホーム・バイナリで実行されます。

実行するように指定するスクリプトはname.ext (例: myscript.sh)の形式である必要があります。これにより、AutoUpgradeは実行するスクリプトのタイプを識別できます。許可される拡張子オプション:

  • UNIXシェル(.sh)
  • Microsoft Windowsバッチ(.bat.cmd)
  • Microsoft Windows PowerShell (.ps1)
  • Oracle SQLスクリプト(.sql)。revert_before_actionパラメータ接頭辞で指定されたデータベースのローカル操作の場合。

オプション

失敗時に停止します: [Y|N]。デフォルトはNです。

デフォルトでは、指定したスクリプトが失敗すると、AutoUpgradeは引き続き実行されます(N)。スクリプトが失敗した場合にAutoUpgradeが停止するように指定するには、Yフラグを使用します。スクリプトが0以外のステータスでオペレーティング・システムで実行を終了した場合、AutoUpgradeはスクリプトを失敗として識別します。

AutoUpgradeがリストアを開始する前に、オペレーティング・システムで指定するスクリプトを実行します。スクリプトが失敗した場合にAutoUpgradeを停止するには、Yフラグを設定します。

sales3.revert_before_action =/user/path/script.sh Y

AutoUpgradeがリストアを開始する前に、オペレーティング・システムで指定したスクリプトを実行します。フラグを指定しないと、デフォルトの失敗時に停止するオプションはNであるため、スクリプトが失敗した場合、AutoUpgradeは引き続き実行されます。

sales3.revert_before_action =/user/path/script.sh

run_utlrp

(オプション)アップグレード後の処理の一部として、utlrp.sqlの1つのバージョンの実行を有効または無効にして、Oracle管理スキーマの無効なオブジェクトのみを再コンパイルします。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

utlrpユーティリティは、データベース・アップグレード時に無効になるすべてのデータ・ディクショナリ・オブジェクトを再コンパイルします。run_utlrp=noを設定した場合、または無効なユーザー・オブジェクトも再コンパイルする必要がある場合は、AutoUpgradeでアップグレードした後に、このユーティリティを使用して無効なオブジェクトを再コンパイルすることをお薦めします。

ノート:

AutoUpgrade 23.1以降、AutoUpgradeユーティリティを実行すると、AutoUpgradeによってutlprpom.sqlスクリプトが実行され、utlrp.sqlは実行されません。Oracle Database 12cリリース2 (12.2.0.1)以降のリリースへのアップグレードにAutoUpgradeを使用すると、AutoUpgradeはOracle管理スキーマが所有する無効なオブジェクトのみを再コンパイルします。データベースのアップグレードではユーザー・オブジェクトにアクセスする必要がないため、AutoUpgradeは無効なオブジェクトを再コンパイルするときにこのポリシーを維持します。

オプション

[yes | no]

デフォルト値はyes

prefix.run_utlrp=yes

sid

(必須)アップグレードするデータベースのOracleシステム識別子(SID)を示します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用する必要があります。

このパラメータでは、大/小文字が区別されます。

sales1.sid=salesdb

source_home

(分析モード、修正モードおよびデプロイ・モードの場合は必須です。アップグレード・モードの場合はオプションです。)アップグレードまたはパッチ適用するデータベースの現在のOracleホーム(ORACLE_HOME)。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

upgradeモードの場合、ソース・ホームとターゲット・ホームの値は同じパスにできます。

sales2.source_home=/path/to/my/source/oracle/home

source_ldap_admin_dir

(オプション)ソース・データベース・ホームのLDAP_ADMINディレクトリへのパスを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

WindowsではLDAP_ADMIN環境変数がレジストリ内で設定されているため、このパラメータはMicrosoft Windowsには影響しません。

sales1.source_ldap_admin_dir=/u01/app/oracle/12.2/dbhome01/ldap/admin

source_tns_admin_dir

(オプション)ソース・データベース・ホームのTNS_ADMINディレクトリへのパスを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

WindowsではTNS_ADMIN環境変数がレジストリ内で設定されているため、このパラメータはMicrosoft Windowsには影響しません。

sales1.source_tns_admin_dir=/u01/app/oracle/12.2/dbhome01/network/admin

start_time

(オプション)アップグレードまたはパッチ適用ジョブを実行する未来の起動時間を設定します。このパラメータは、ジョブをスケジュールしてサーバーの負荷を分散し、複数のジョブが即時に起動されないようにするために使用します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

値は、now (すぐに開始)の形式にするか、英語日付書式の形式DD/MM/YYYYまたはMM/DD/YYYYにする必要があります。ここで、MMは月、DDは日、YYYYは年です。値を設定しない場合、デフォルトはnowです。

設定できる値:

now
30/12/2019 15:30:00
01/11/2020 01:30:15
2/5/2020 3:30:50

start_time値をnowに設定して複数のジョブが起動されると、AutoUpgradeではシステムで使用可能なリソースに基づいて起動時間をスケジュールします。ジョブの起動時間は数分単位でずれる場合があります。

日付要素または時刻要素に間違ったデリミネータを使用している値、または次のような間違った日付書式または時間書式を使用している値は無効です。

30-12-2019 15:30:00
01/11/2020 3:30:15pm
2020/06/01 01:30:15   

sales1.start_time=now
sales2.start_time=07/11/2020 01:30:15

AutoUpgrade構成ファイルのグローバル共通パラメータ

AutoUpgrade構成ファイル(config)の共通グローバル・パラメータを使用すると、ソフトウェア・メンテナンス(-patch)とアップグレード(upgrade)の両方に対してグローバル・パラメータを設定できます。

after_action

(オプション)すべてのアップグレード・ジョブが正常に終了した後に実行するカスタム・ユーザー・スクリプトのパスおよびファイル名を指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

使用するスクリプトはname.ext (たとえば、myscript.sh)の形式である必要があります。これにより、AutoUpgradeは実行するスクリプトのタイプを識別できます。許可される拡張子オプション:

  • UNIXシェル(.sh)
  • Microsoft Windowsバッチ(.bat.cmd)
  • Microsoft Windows PowerShell (.ps1)

デフォルトでは、スクリプトが失敗すると、AutoUpgradeが引き続き実行されます。オペレーティング・システムがスクリプトの失敗を検出した場合、Yフラグを使用してAutoUpgradeが停止するように指定します。スクリプトが0とは異なるステータスで終了すると、失敗して完了したとみなされます。

スクリプトの出力が取得され、ファイルに格納されます。stdoutstderrの両方が取得されます。ファイルは、特定のデータベースまたはジョブに一致するディレクトリのpostupgradeサブディレクトリに格納されます。

次の環境変数はスクリプトを実行するシェルに設定されます。

  • ORACLE_SID
  • ORACLE_UNQNAME
  • ORACLE_BASE
  • ORACLE_HOME
  • TNS_ADMIN

スクリプトが失敗した場合、AutoUpgradeを停止します。

global.after_action=/path/to/my/script.sh Y 

スクリプトが失敗した場合、AutoUpgradeを続行します。


global.after_action=/path/to/my/script.sh

autoupg_log_dir

(非推奨) AutoUpgradeが使用するログ・ファイルとグローバル・モジュールに属する一時ファイルの場所を設定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

このパラメータは現在では非推奨となっており、かわりに、AutoUpgradeのアップグレードとパッチ適用の両方で使用されるglobal_log_dirが使用されています。

特定の接頭辞のログ・ディレクトリにあるuserconfigファイルに、異なるログ・ディレクトリ・パスを構成できます

このパラメータは、AutoUpgradeパッチ適用では使用できません。

ノート:

Microsoft Windowsプラットフォームでは、global.autoupg_loglog_dirを同じドライブで構成する必要があります。

このパラメータをパスに設定しない場合、デフォルトでは、ログ・ファイルは構成ファイルに含めるデータベースのorabaseユーティリティで示される場所に配置されます。その場合、デフォルトのログ・ディレクトリはパスORACLE_BASE/cfgtoollogs/autoupgradeにあります。

構成ファイルに含まれるすべてのデータベースについてorabaseユーティリティが失敗した場合、ログ・ファイルの場所は、AutoUpgradeを実行しているユーザーのtempディレクトリに基づきます。

global.autoupg_log_dir=/path/to/my/global/log/dir

特定の接頭辞のログ・ディレクトリにあるuserconfigファイルに、異なるログ・ディレクトリ・パスを構成します

global.autoupg_log_dir=/path/to/my/global/log/dir
myprefix.log_dir=global.global_log_dir:different/path

この構文が使用されると、ログ・ファイルおよび一時ファイルは、接頭辞myprefixで識別されるデータベースの次のパスに配置されます。

/path/to/my/global/log/dir/different/path

before_action

(オプション) アップグレード・ジョブを開始する前にすべてのアップグレードに対して実行するカスタム・ユーザー・スクリプトを指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

使用するスクリプトはname.ext (たとえば、myscript.sh)の形式である必要があります。これにより、AutoUpgradeは実行するスクリプトのタイプを識別できます。特定のアップグレード・ジョブの前にスクリプトを実行する場合は、ローカル・パラメータ(local.before_action)を使用してそのスクリプトを指定します

許可される拡張子オプション:

  • UNIXシェル(.sh)

  • Microsoft Windowsバッチ(.bat.cmd)

  • Microsoft Windows PowerShell (.ps1)

デフォルトでは、スクリプトが失敗すると、AutoUpgradeが引き続き実行されます。オペレーティング・システムがスクリプトの失敗を検出した場合、Yフラグを使用してAutoUpgradeが停止するように指定します。スクリプトが0とは異なるステータスで終了すると、失敗して完了したとみなされます。

スクリプトの出力が取得され、ファイルに格納されます。stdoutstderrの両方が取得されます。ファイルは、特定のデータベースまたはジョブに一致するディレクトリのpreupgradeサブディレクトリに格納されます。

次の環境変数はスクリプトを実行するシェルに設定されます。

  • ORACLE_SID
  • ORACLE_UNQNAME
  • ORACLE_BASE
  • ORACLE_HOME
  • TNS_ADMIN

スクリプトが失敗した場合、AutoUpgradeを停止します。

global.before_action=/path/to/my/script.sh Y 

スクリプトが失敗した場合、AutoUpgradeを続行します。


global.before_action=/path/to/my/script.sh

global_log_dir

(オプション) AutoUpgradeログ・ファイルと、AutoUpgradeが使用するグローバル・モジュールに属する一時ファイルの場所を設定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

この構成パラメータは、パッチ適用およびアップグレードに使用されます。このパラメータは、非推奨のautoupg_log_dirパラメータを置き換えます。特定の接頭辞のログ・ディレクトリにあるuserconfigファイルに、異なるログ・ディレクトリ・パスを構成できます

このパラメータをパスに設定しない場合、デフォルトでは、ログ・ファイルは構成ファイルに含めるデータベースのorabaseユーティリティで示される場所に配置されます。その場合、デフォルトのログ・ディレクトリはパスORACLE_BASE/cfgtoollogs/autoupgrade_patchingにあります。

構成ファイルに含まれるすべてのデータベースについてorabaseユーティリティが失敗した場合、ログ・ファイルの場所は、AutoUpgradeを実行しているユーザーのtempディレクトリに基づきます。

global.global_log_dir=/path/to/my/global/log/dir

特定の接頭辞のログ・ディレクトリにあるuserconfigファイルに、異なるログ・ディレクトリ・パスを構成します

global.global_log_dir=/path/to/my/global/log/dir
myprefix.log_dir=global.global_log_dir:different/path

この構文が使用されると、ログ・ファイルおよび一時ファイルは、接頭辞myprefixで識別されるデータベースの次のパスに配置されます。

/path/to/my/global/log/dir/different/path

global_log_dirパラメータを使用する構成ファイルの例を次に示します:

global.global_log_dir=/logs/patching
global.keystore=/secure/keystore
upg1.sid=DB19X
upg1.source_home=/databases/19x/dbhome_1
upg1.target_home=/databases/19x/dbhome_2
upg1.folder=/storage/patches
upg1.download=YES

json_progress_writing_interval

(オプション) AutoUpgrade進捗JSONレポートの書込み間隔の時間を設定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

このパラメータは、AutoUpgrade進捗JSONレポートが書き込まれる頻度を指定します。このパラメータを設定しない場合、デフォルトではAutoUpgrade進捗JSONレポートの間隔は30秒です

次の例では、global.json_progress_writing_interval=90を使用して、JSON進捗レポートがglobal.autoupg_log_dirで指定されたログ・ディレクトリに90秒ごとに書き込まれるように指定します:
global.json_progress_writing_interval=90
global.autoupg_log_dir=/path/to/my/global/log/dir

keystore

(オプション)AutoUpgradeがパスワードを格納するために排他的に使用する専用ソフトウェア・キーストアの場所と、その他の機密情報を指定します。

使用上のノート

ノート:

このパラメータは、AutoUpgradeアップグレードとAutoUpgradeパッチ適用の両方で使用できます。

キーストア・パラメータを使用して、AutoUpgradeが排他的に使用する専用ソフトウェア・キーストアを作成する場所を指定できます。

AutoUpgradeキーストアには、ファイルewallet.p12が格納されます(データベースで使用される他の種類のキーストアと同様)。ファイルは、TDEプロンプトでsaveコマンドを使用すると作成されます。自動ログイン・キーストアの生成を選択すると、ファイルcwallet.ssoも作成されます。自動ログイン・キーストアがある場合、AutoUpgradeの起動時にキーストア・パスワードの入力を求められません。

AutoUpgradeによって生成されたキーストアには機密情報が格納され、キーストアを初めて使用するときに選択したパスワードで保護されます。キーストアを変更するたびに、パスワードを指定する必要があります。AutoUpgradeの自動ログイン・キーストアを作成することにした場合を除き、AutoUpgradeを起動し、AutoUpgradeがキーストアからの情報を要求するたびに、キーストア・パスワードを指定する必要があります。

注意:

global.keystoreで指定するディレクトリにはソフトウェア・キーストアが含まれているため、他のすべての高度にセキュアなキーストア・ファイルと同じセキュリティのベスト・プラクティスを使用して保護する必要があります。

次の例では、ORACLE_SIDを、キーストアを使用するデータベースのシステム識別子に置き換えます。
global.keystore=/etc/oracle/keystores/ORACLE_SID/autoupgrade