Local Parameters for the AutoUpgrade Configuration File
To configure information for specific Oracle Databases for the AutoUpgrade utility upgrade, you provide information in the AutoUpgrade local parameters.
Usage Notes
Local parameters take precedence over any global parameters set in the AutoUpgrade configuration file. Except where indicated with (Optional), all local parameters are required. All local parameters take a prefix (in examples, identified by a value you define to identify a particular database or upgrade. The prefix identifies the specific upgrade job to which the parameter applies in the configuration file.
Example: The set of parameters for the first upgrade in the configuration file
uses the prefix sales
, and the set of
parameters for the next upgrade in the configuration file uses the prefix employees
:
sales.source_home=/u01/app/oracle/12.2/dbhome1
.
.
.
employees.sid=salescdb
employees.source_home-/03/app/oracle/21/dbhome1
Table 2-2 Local Configuration Parameters for Oracle Database AutoUpgrade Utility
Parameter | Description |
---|---|
|
(Optional) Specifies a path and file name of a
Example:
|
|
(Optional) Specifies a path and file name of a Example:
|
|
(Optional) Specifies a custom action that you want to have performed after completing the upgrade job for the database identified by the prefix address. The script that you use must be in the form of
By default, if the script fails, then AutoUpgrade continues to run.
Use the In contrast to the global Examples: Run the specified script before AutoUpgrade starts processing, with
the
Run the specified script before AutoUpgrade starts processing, with AutoUpgrade set to continue to run if the script fails:
|
|
(Optional) Specifies a custom action that you want to have performed
before starting the upgrade job for the specific database job addressed by the
prefix. If you want to have a script run before all upgrade jobs, then specify
that script by using the local parameter
( The script that you use must be in the form of
By default, if the script fails, then AutoUpgrade continues to run.
Use the In contrast to the global Examples: Run the specified script before AutoUpgrade starts processing, with
the
Run the specified script before AutoUpgrade starts processing, with AutoUpgrade set to continue to run if the script fails:
|
|
(Optional) Specifies one or more of a set of Available
Example:
|
|
(Optional) Specifies the path to a checklist that you can use to override the default list of fixups that AutoUpgrade performs, such as fixups that you do not want implemented automatically, due to policy or security concerns. To use this parameter during other AutoUpgrade modes, you must run
AutoUpgrade in Example:
In the preceding example, |
|
(Optional) Specifies a path and file name of a
Example:
|
|
(Optional) Specifies a path and file name of a Example:
|
|
(Optional) Specifies custom operating system environment variables
set on your operating system, excluding Use case: Use this parameter to provide environment setting that are indicated
in the database Syntax:
For example, assume that for the PDB
In that case, for AutoUpgrade to know what those custom environment
variables are, you must provide them using the
|
|
(Optional with AutoUpgrade 19.8) Sets the location of log files that are generated for database upgrades that are in the set of databases included in the upgrade job identified by the prefix for the parameter. When set, AutoUpgrade creates a hierarchical directory based on a
local log file path that you specify. For example, where the job identifier prefix
is
You cannot use wild cards for paths, such as tilde
( Example:
By default, if the global configuration file parameter
When neither If the |
|
(Optional) Sets a list of PDBs on which you want the upgrade to run. This parameter only applies to upgrades of multitenant architecture (CDB) databases. If you are plugging in and upgrading a non-CDB database, then this parameter is ignored. The PDB list is comma-deliminated. The list can contain either PDB
names, or a star character ( Example:
|
|
(Optional) Increases the compatible parameter to the default value of the target release after the upgrade is completed successfully. Options:
The default value is CAUTION:
Example:
|
|
(Optional) Removes underscore (hidden) parameters from
Options:
The default value is Example:
|
|
(Optional) Generates a Guaranteed Restore Point (GRP) for database
restoration. If you set Options:
The default value is Example:
|
|
(Optional) Enables or disables running The Example:
|
|
(Required) Identifies the Oracle system identifier (SID) of the database that you want to upgrade. Example:
|
|
(Optional) The default is |
|
(Required for Example:
|
|
(Optional) Specifies the path to the Example:
|
|
(Optional) Sets a future start time for the upgrade job to run. Use this parameter to schedule upgrade jobs to balance the load on your server, and to prevent multiple jobs from starting immediately. Values must either take the form Example:
Permitted values:
If more than one job is started with the Values are invalid that use the wrong deliminator for the date or time element, or use the wrong date or hour format. Example:
|
target_base |
(Optional) Specifies the target Example:
|
target_cdb |
(Optional) Specifies the SID of the target CDB into which a non-CDB Oracle Database is plugged in. This parameter is mandatory when you want to upgrade and convert a non-CDB Oracle Database. Example:
|
|
(Optional) This option is only used when creating a pluggable
database within the target CDB. It specifies the
On the target CDB, if you have the parameters
If you want one or more data file names changed during conversion,
then enter values for the parameter to indicate the filename you want to change,
and the filename to which you want the existing files copied, using the syntax
Example: In this example, AutoUpgrade will copy existing datafiles during
conversion of a database specified with the prefix string
To convert OMF files with
In this example, the parameter is configured so that data files that
are stored on Oracle ASM, but not stored as Oracle-managed files, are copied from
|
|
(Optional) Specifies the name that you want to assign to a non-CDB source Oracle Database after is plugged in to the target CDB. The default value is to use the database unique name of the non-CDB Oracle Database. If you want to specify a name that is different from the existing name of the non-CDB when you plug it in to the CDB, then you must set this parameter. Example:
|
|
(Optional) Specifies the path to the TNS_ADMIN directory in the target database home. Example:
|
|
(Optional) Enables or disables running the time zone upgrade as part
of the AutoUpgrade process. To preserve data integrity, Oracle recommends that you
upgrade the time zone settings at the time of your database upgrade. In
particular, upgrade the timezone when you have data that depend on the time zone,
such as Example:
|
|
(Optional) Specifies the node on which the current user configuration
is valid. The default value is The purpose of this parameter is to prevent AutoUpgrade from
processing databases that are listed in the configuration file that you use with
AutoUpgrade, where the value for the Use case: The configuration file Example:
|
Parent topic: Preparing to Upgrade Oracle Database