AutoUpgradeユーザー構成ファイルのグローバル・パラメータ

構成ファイルで扱われるすべてのOracle Databaseアップグレードのパラメータに対するデフォルトの動作を指定するには、オプションのAutoUpgradeグローバル・パラメータを使用できます。

使用上のノート

グローバル・パラメータは、アップグレードまたはデプロイ・モードを使用する場合のtarget_homeを除き、すべてオプションです。すべてのグローバル・パラメータは接頭辞globalを使用します。

add_after_upgrade_pfileおよびdel_during_upgrade_pfileグローバルおよびローカルのPFILEパラメータ操作は、次の階層順序で実行されます。

1. グローバル・アクション
   1. グローバルの削除
   2. グローバルの追加
2. ローカル・アクション
   1. ローカルの削除
   2. ローカルの追加

• add_after_upgrade_pfile
  (オプション) PFILEをアップグレードした後にパラメータを追加するPFILEのパスおよびファイル名を指定します。
• add_during_upgrade_pfile
  (オプション) PFILEのアップグレード中にパラメータを追加するPFILEのパスおよびファイル名を指定します。
• after_action
  (オプション)すべてのアップグレード・ジョブが正常に終了した後に実行するカスタム・ユーザー・スクリプトのパスおよびファイル名を指定します。
• autoupg_log_dir
  (オプション) ログ・ファイルと、AutoUpgradeが使用するグローバル・モジュールに属する一時ファイルの場所を設定します。
• before_action
  (オプション)アップグレード・ジョブを開始する前にすべてのアップグレードに対して実行するカスタム・ユーザー・スクリプトを指定します。
• catctl_options
  (オプション) AutoUpgradeがcatctl.plに送信してデフォルトの動作をオーバーライドするために選択できるcatctl.plオプションのセットを1つ以上指定します。
• del_after_upgrade_pfile
  (オプション) PFILEのアップグレード後にパラメータを削除するPFILEのパスおよびファイル名を指定します。
• del_during_upgrade_pfile
  (オプション) PFILEのアップグレード中にパラメータを削除するPFILEのパスおよびファイル名を指定します。
• drop_grp_after_upgrade
  (オプション)データベースのアップグレード後に、保証付きリストア・ポイント(GRP)を削除します。
• keystore
  (オプション) AutoUpgradeがパスワードやその他の機密情報を格納するために排他的に使用する専用ソフトウェア・キーストアの場所を指定します。
• raise_compatible
  (オプション)アップグレードが正常に完了した後、compatibleパラメータをターゲット・リリースのデフォルト値まで増やします。
• replay
  (オプション)リプレイを使用してデータベースをアップグレードするかどうかを指定します。
• target_base
  (オプション)ターゲットOracleホームのターゲットORACLE_BASEパスを指定します。
• target_home
  (分析および修正モードの場合はオプションです。アップグレードおよびデプロイ・モードの場合は必須です。)構成ファイルで指定されたすべてのデータベースのグローバル・ターゲット・ホームを設定します。
• target_version
  (オプション) AutoUpgradeでアップグレードを実行するターゲット・リリース・バージョンを指定します。
• upgradexml
  (オプション) upgrade.xmlファイルを生成します。

add_after_upgrade_pfile

(オプション) PFILEをアップグレードした後にパラメータを追加するPFILEのパスおよびファイル名を指定します。

使用上のノート

この指定は、ユーザー構成ファイル内のすべてのデータベースに適用されます。

例

global.add_after_upgrade_pfile=/path/to/my/add_after.ora

add_during_upgrade_pfile

(オプション) PFILEのアップグレード中にパラメータを追加するPFILEのパスおよびファイル名を指定します。

使用上のノート

この指定は、ユーザー構成ファイル内のすべてのデータベースに適用されます。

例

global.add_during_upgrade_pfile=/path/to/my/add_during.ora

after_action

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

使用上のノート

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

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

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

スクリプトの出力が取得され、ファイルに格納されます。stdoutとstderrの両方が取得されます。ファイルは、特定のデータベースまたはジョブに一致するディレクトリの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が使用するログ・ファイルとグローバル・モジュールに属する一時ファイルの場所を設定します。

使用上のノート

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

このパラメータをパスに設定しない場合、デフォルトでは、ログ・ファイルは構成ファイルに含めるデータベースの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.auto_log_dir:different/path

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

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

before_action

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

使用上のノート

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

許可される拡張子オプションは、次のとおりです。

• UNIXシェル(.sh)

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

• Microsoft Windows PowerShell (.ps1)

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

スクリプトの出力が取得され、ファイルに格納されます。stdoutとstderrの両方が取得されます。ファイルは、特定のデータベースまたはジョブに一致するディレクトリの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

catctl_options

(オプション) AutoUpgradeがcatctl.plに送信してデフォルトの動作をオーバーライドするために選択できるcatctl.plオプションのセットを1つ以上指定します。

オプション

使用可能なcatctl.plオプション:

• -n パラレル操作に使用するプロセス数。リプレイ・アップグレードの場合、アップグレードに使用されるパラレル・プロセスの数は、CPU_COUNTを4で割った値にデフォルト設定されます。クラシック・アップグレードの場合、CDB$ROOTのデフォルトは8です。
• -N PDBのアップグレード時に使用するプロセッサの数。リプレイ・アップグレードの場合、アップグレードに使用されるパラレル・プロセスの数は、CPU_COUNTを4で割った値にデフォルト設定されます。クラシック・アップグレードの場合、デフォルトは2です
• -T オフラインのユーザー・スキーマベースの表領域を取得します。
• -z catcon.pmの本番デバッグ情報を有効にします。

例

global.catctl_options=-n 24 -N 4

del_after_upgrade_pfile

(オプション) PFILEのアップグレード後にパラメータを削除するPFILEのパスおよびファイル名を指定します。

使用上のノート

この指定は、ユーザー構成ファイル内のすべてのデータベースに適用されます。

例

global.del_after_upgrade_pfile=/path/to/my/del_after.ora

del_during_upgrade_pfile

(オプション) PFILEのアップグレード中にパラメータを削除するPFILEのパスおよびファイル名を指定します。

使用上のノート

この指定は、ユーザー構成ファイル内のすべてのデータベースに適用されます。

例

global.del_during_upgrade_pfile=/path/to/my/del_during.ora

drop_grp_after_upgrade

(オプション)データベースのアップグレード後に、保証付きリストア・ポイント(GRP)を削除します。

使用上のノート

このオプションを選択した場合、アップグレードが正常に完了した後にGRPが削除されます。raise_compatibleをyesに設定する場合は、パラメータdrop_grp_after_upgradeもyesに設定する必要があります。

オプション

[yes | no]

デフォルト値はnoです。

例

global.drop_grp_after_upgrade=yes

keystore

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

使用上のノート

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

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

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

注意:

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

例

次の例では、ORACLE_SIDを、キーストアを使用するデータベースのシステム識別子に置き換えます。

global.keystore=/etc/oracle/keystores/ORACLE_SID/autoupgrade

raise_compatible

(オプション)アップグレードが正常に完了した後、compatibleパラメータをターゲット・リリースのデフォルト値まで増やします。

使用上のノート

このオプションを選択した場合、アップグレードが正常に完了した後にGRPが削除されます。raise_compatibleをyesに設定する場合は、パラメータdrop_grp_after_upgradeもyesに設定する必要があります。

注意:

• COMPATIBLEパラメータを増やした後、データベースのダウングレードはできません。
• COMPATIBLEパラメータを現在のリリース・レベルに設定するのは、アップグレードしたデータベースを完全にテストした後にのみ行うことをお薦めします。
• autoupgradeコマンドライン・パラメータrestoreに使用する値に関係なく、構成ファイル・パラメータraise_compatibleの値をyesに設定した場合は、アップグレードを開始する前に、作成した保証付きリストア・ポイントを手動で削除する必要があります。アップグレードが正常に完了すると、アップグレードを開始する前にAutoUpgradeによって作成された保証付きリストア・ポイントは自動的に削除されます。AutoUpgradeによってPOSTUPGRADEステージが開始されると、データベースをリストアする方法はありません。
• raise_compatibleをyesに設定する場合は、パラメータdrop_grp_after_upgradeもyesに設定する必要があります。

オプション

[yes | no]

デフォルト値はnoです。

例

global.raise_compatible=yes

replay

(オプション)リプレイを使用してデータベースをアップグレードするかどうかを指定します。

使用上のノート

デフォルトでは、AutoUpgradeはクラシック・アップグレードを実行してデータベースをアップグレードします。

オプション

[yes | no]

デフォルト値はnoです。

例

global.replay=yes

target_base

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

使用上のノート

このパラメータを使用する必要があるのは、まれな場合のみです。

例

global.target_base=/u01/app/oracle
sales4.target_base=/u04/app/oracle4

target_home

(分析および修正モードの場合はオプションです。アップグレードおよびデプロイ・モードの場合は必須です。)構成ファイルで指定されたすべてのデータベースのグローバル・ターゲット・ホームを設定します。

使用上のノート

同じtarget_homeを複数回指定しないようにするには、このオプションを使用します。このパラメータはローカルで上書きできます。

例

global.target_home=/target/Oracle/home

target_version

(オプション)AutoUpgradeでアップグレードを実行するターゲット・リリース・バージョンを指定します。

使用上のノート

AutoUpgradeでは、このパラメータで指定したリリース・バージョン情報を使用して、アップグレード対象のターゲットのOracle Databaseリリースに対して正しいチェックおよび修正が使用されるようにします。このパラメータの形式は、有効なOracleバージョンのピリオド区切りの値です。

有効な値

• 12.2
• 18
• 19
• 21

このオプションは、ターゲット・ホームがシステムに存在しないか、ターゲット・ホームが12.2リリースの場合のみ必要です。それ以外の場合、AutoUpgradeはターゲット・リリース値を導出できます。

例

global.target_version=19
employees.target_version=12.2

upgradexml

(オプション) upgrade.xmlファイルを生成します。

使用上のノート

生成されたupgrade.xmlは、XMLパラメータを指定したときにアップグレード前パッケージが生成した以前のリリースのファイルと同等のものです。このファイルは、分析モード(mode -analyze)中に作成されます。これは、AutoUpgradeログ・ファイル用に定義された事前チェック・ディレクトリに生成されます。

オプション

[yes | no]

デフォルト値はnoです。

例

global.upgradexml=yes