Locally Modifiable Global Parameters for AutoUpgrade Configuration File

Locally modifiable global parameters are parameters that you set both globally, and as you require, set locally, so that you can better control AutoUpgrade job processing.

Usage Notes

Locally modifiable global parameters are required parameters. You must define these parameters in your AutoUpgrade configuration file, either globally, or locally. With locally modifiable global parameters, you can use the prefix global to set values as global parameters for all jobs in your AutoUpgrade configuration file, but reset the same parameter with a local job prefix for a particular job in the same configuration file. You can also choose to set locally modifiable global parameters only as local parameters for each AutoUpgrade job.

Note:

These parameters are available in the latest version of AutoUpgrade that you can download from My Oracle Support.

When a locally modifiable global parameter is set both with a global prefix, and with a local job prefix, the locally modified parameter value overrides the global parameter values for the job identified by the prefix that you use with the parameter. The syntax you use is in the form global.target_home=Global target Oracle home, and database.target_home=local target Oracle home.

Example:

In the AutoUpgrade configuration file, the required parameter target_home is set globally to one Oracle home path. But in the configuration file, the same parameter is set locally to a different Oracle home path. As AutoUpgrade processes the jobs in the configuration file, it uses the locally defined path for target_home for the job defined by the prefix upgrade3, overriding the global parameter setting:

global.target_home=/u01/app/oracle/21.0.0/dbhome01
upgrade3.target_home=/u03/app/oracle3/12.2.0.1/dbhome3

Table 2-4 Locally Modifiable Global Parameters for AutoUpgrade Configuration Files

Parameter Description

defer_standby_log_shipping

(Optional) Defers shipping logs from the primary database to the standby database before the upgrade, where you have a primary database with a physical standby database. When Autoupgrade defers log shipping, you will receive a notice that log shipping is deferred, and that after the upgrade completes successfully, you need to reenable shipping logs from the primary database to the secondary database. The default option is No. If you change the default to Yes, then log shipping is deferred.

drop_grp_after_upgrade

(Optional) Deletes the Guaranteed Restore Point (GRP) after database upgrade. If you select this option, then GRP is deleted after upgrade completes successfully.

Options:

[yes | no]

The default value is no.

Examples:

global.drop_grp_after_upgrade=yes
sales.drop_grp_after_upgrade=yes

enable_local_undo

(Optional) For a CDB upgrade, specifies whether or not LOCAL undo should be enabled before the upgrade of CDB$ROOT by running the following statement: ALTER DATABASE LOCAL UNDO ON; The allowed values are [YES | NO]. The default value is NO.

When local undo is first enabled, the size of the undo tablespace in PDB$SEED is determined as a factor of the size of the undo tablespace in CDB$ROOT. The default is 30 percent of the undo tablespace size. Every other PDB in the CDB inherits this property from PDB$SEED. Ensure that there is enough space to allocate new UNDO tablespaces.

manage_network_files

Specifies whether network files are processed during the upgrade.

Options:

[FULL|SKIP|IGNORE_READ_ONLY]

FULL: (default) Raise all exceptions encountered during the copy and merge of network files into the target Oracle home.

SKIP: Do not process network files during postupgrade.

IGNORE_READ_ONLY: Attempt to copy and merge network files, but do not raise an exception during the upgrade if the target file is read only

The following network files are processed: oranfstab, ldap.ora, tnsnames.ora, sqlnet.ora, and listener.ora

remove_underscore_parameters

(Optional) Removes underscore (hidden) parameters from PFILE files during upgrade, and after upgrade, for all Oracle Databases in the configuration file. Underscore parameters should only be used by advice of Oracle Support.

Options:

[yes | no]

The default value is no.

Example:

global.remove_underscore_parameters=yes

restoration

(Optional, available with Enterprise Edition only) Generates a Guaranteed Restore Point (GRP) for database restoration. If you select this option, then both database backup and database restoration must be performed manually by the DBA.

Options:

[yes | no]

The default value is yes.

Example:

global.restoration=no

Standard Edition does not support Flashback Database, so this option is not available for Standard Edition. If your database is a Standard Edition Oracle Database, then you must ensure that you have a separate fallback mechanism is in place.

target_version

(Optional) Specifies the target release version on which you want AutoUpgrade to perform the upgrade. AutoUpgrade uses the release version information that you provide in this parameter to ensure that the correct checks and fixups are used for the target Oracle Database release to which you are upgrading. The format for this parameter are period-delimited values of valid Oracle versions.

Valid values

  • 12.2
  • 18
  • 19
  • 21

This option is only required if the target home is not present on the system, or if the target home is a 12.2 release. Otherwise, AutoUpgrade can derive the target release value.

Example:

global.target_version=18
employees.target_version=12.2
target_home

Specifies the target Oracle home (ORACLE_HOME) path.

Example:

global.target_home=/u01/app/oracle/21.0.0/dbhome01
sales4.target_home=/u04/app/oracle4/21.0.0/dbhome04

If the mode is ANALYZE or FIXUPS, then the parameter target_home is optional.

target_base

(Optional) Specifies the target ORACLE_BASE path for the target Oracle home.

Example:

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