Global Parameters for the AutoUpgrade User Configuration File
To specify a default behavior for a parameter for all Oracle Database upgrades addressed in the configuration file, you can use the optional AutoUpgrade global parameters.
Usage Notes
All global parameters are optional, except for target_home when using
upgrade or deploy mode. All global parameters take the prefix
global
.
The add_after_upgrade_pfile
and
del_during_upgrade_pfile
global and local
PFILE
parameters operations are run in the following
hierarchical order:
- Global Actions
- Remove global
- Add global
- Local Actions
- Remove local
- Add local
- add_after_upgrade_pfile
(Optional) Specifies a path and file name of aPFILE
whose parameters you want to add after thePFILE
is upgraded. - add_during_upgrade_pfile
(Optional) Specifies a path and file name of aPFILE
whose parameters you want to add during thePFILE
is upgraded. - after_action
(Optional) Specifies a path and a file name for a custom user script that you want to have run after all the upgrade jobs finish successfully. - autoupg_log_dir
(Deprecated) Sets the location of the log files, and temporary files that belong to global modules, which AutoUpgrade uses. - before_action
(Optional) Specifies a custom user script that you want to have run for all upgrades before starting the upgrade jobs. - del_after_upgrade_pfile
(Optional) Specifies a path and file name of aPFILE
whose parameters you want to have removed after thePFILE
upgrade. - del_during_upgrade_pfile
(Optional) Specifies a path and file name of aPFILE
whose parameters you want to have removed during thePFILE
upgrade. - global_log_dir
(Optional) Sets the location of the AutoUpgrade log files, and temporary files that belong to global modules, which AutoUpgrade uses. - json_progress_writing_interval
(Optional) Sets the time interval for how often to write the AutoUpgrade progress JSON report. - keystore
(Optional) Specifies the location for a dedicated software keystore used exclusively by AutoUpgrade to store passwords, and other sensitive information. - upgradexml
(Optional) Generates theupgrade.xml
file.
add_after_upgrade_pfile
(Optional) Specifies a path and file name of a PFILE
whose
parameters you want to add after the PFILE
is upgraded.
Usage Notes
This specification applies to all databases in the user configuration file.
Example
global.add_after_upgrade_pfile=/path/to/my/add_after.ora
add_during_upgrade_pfile
(Optional) Specifies a path and file name of a PFILE
whose
parameters you want to add during the PFILE
is upgraded.
Usage Notes
This specification applies to all databases in the user configuration file.
Example
global.add_during_upgrade_pfile=/path/to/my/add_during.ora
after_action
(Optional) Specifies a path and a file name for a custom user script that you want to have run after all the upgrade jobs finish successfully.
Usage Notes
The script that you use must be in the form of
name.ext
(for example,
myscript.sh
, so that AutoUpgrade can
identify the type of script that you want to run. Permitted
extension options:
- Unix shell (
.sh
) - Microsoft Windows batch (
.bat
,.cmd
) - Microsoft Windows PowerShell
(
.ps1
)
By default, if the script fails, then AutoUpgrade continues
to run. Use the Y
flag to specify that AutoUpgrade
stops if the operating system detects that your script fails. If the
script finishes with a status different than 0
,
then it is considered a failed completion.
The output of the script is captured and stored in files.
Both stdout
and stderr
are
captured. The files are stored in the postupgrade
subdirectory in the directory matching the specific database or job.
The following environment variables are set in the shell that runs the script:
ORACLE_SID
ORACLE_UNQNAME
ORACLE_BASE
ORACLE_HOME
TNS_ADMIN
Examples
If the script fails, then stop AutoUpgrade:
global.after_action=/path/to/my/script.sh Y
If the script fails, then continue AutoUpgrade:
global.after_action=/path/to/my/script.sh
autoupg_log_dir
(Deprecated) Sets the location of the log files, and temporary files that belong to global modules, which AutoUpgrade uses.
Usage Notes
This parameters is now deprecated in favor of
global_log_dir
, which is now used with both
AutoUpgrade upgrades and patching.
You can configure different log directory path in the
userconfig
file in the logs directory for a
specific prefix
This parameter cannot be used with AutoUpgrade Patching.
Note:
On Microsoft Windows platforms,global.autoupg_log
and log_dir
should be configured on the same drive.
If you do not set this parameter to a path, then by default
the log files are placed in the location indicated by the
orabase
utility for the databases that you
include in your configuration file. In that case, the default logs
directory is in the path ORACLE_BASE/cfgtoollogs/autoupgrade
.
If the orabase
utility fails for all
databases included in the configuration file, then the log file
location is then based on the temp
directory for
the user running AutoUpgrade.
Examples
global.autoupg_log_dir=/path/to/my/global/log/dir
Configure different log directory path in the
userconfig
file in the logs directory for a
specific prefix
global.autoupg_log_dir=/path/to/my/global/log/dir
myprefix.log_dir=global.global_log_dir:different/path
The result of using this syntax is that log files and
temporary files are placed in the following path for databases
identified by the prefix myprefix
:
/path/to/my/global/log/dir/different/path
before_action
(Optional) Specifies a custom user script that you want to have run for all upgrades before starting the upgrade jobs.
Usage Notes
The script that you use must be in the form of
name.ext
(for example,
myscript.sh
), so that AutoUpgrade can identify the
type of script that you want to run. If you want to have a script
run before a specific upgrade job, then specify that script by using
the local parameter (local.before_action
)
Permitted extension options:
-
Unix shell (
.sh
) -
Microsoft Windows batch (
.bat
,.cmd
) -
Microsoft Windows PowerShell (
.ps1
)
By default, if the script fails, then AutoUpgrade continues
to run. Use the Y
flag to specify that AutoUpgrade
stops if the operating system detects that your script fails. If the
script finishes with a status different than 0
,
then it is considered a failed completion.
The output of the script is captured and stored in files. Both
stdout
and stderr
are
captured. The files are stored in the preupgrade
subdirectory in the directory matching the specific database or job.
The following environment variables are set in the shell that runs the script:
ORACLE_SID
ORACLE_UNQNAME
ORACLE_BASE
ORACLE_HOME
TNS_ADMIN
Examples
If the script fails, then stop AutoUpgrade:
global.before_action=/path/to/my/script.sh Y
If the script fails, then continue AutoUpgrade:
global.before_action=/path/to/my/script.sh
del_after_upgrade_pfile
(Optional) Specifies a path and file name of a PFILE
whose
parameters you want to have removed after the PFILE
upgrade.
Usage Notes
This specification applies to all databases in the user configuration file.
Example
global.del_after_upgrade_pfile=/path/to/my/del_after.ora
del_during_upgrade_pfile
(Optional) Specifies a path and file name of a PFILE
whose
parameters you want to have removed during the PFILE
upgrade.
Usage Notes
This specification applies to all databases in the user configuration file.
Example
global.del_during_upgrade_pfile=/path/to/my/del_during.ora
global_log_dir
(Optional) Sets the location of the AutoUpgrade log files, and temporary files that belong to global modules, which AutoUpgrade uses.
Usage Notes
This configuration parameter is used for patching and
upgrade. This parameter replaces autoupg_log_dir
parameter, which is deprecated. You can configure a different log
directory path in the userconfig
file in the logs
directory for a specific prefix.
If you do not set this parameter to a path, then by default
the log files are placed in the location indicated by the
orabase
utility for the databases that you
include in your configuration file. In that case, the default logs
directory is in the path ORACLE_BASE/cfgtoollogs/autoupgrade_patching
.
If the orabase
utility fails for all
databases included in the configuration file, then the log file
location is then based on the temp
directory for
the user running AutoUpgrade.
Examples
global.global_log_dir=/path/to/my/global/log/dir
Configure different log directory path in the
userconfig
file in the logs directory for a
specific prefix
global.global_log_dir=/path/to/my/global/log/dir
myprefix.log_dir=global.global_log_dir:different/path
The result of using this syntax is that log files and
temporary files are placed in the following path for databases
identified by the prefix myprefix
:
/path/to/my/global/log/dir/different/path
The following is an example of a configuration file suing the global_log_dir parameter:
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
Usage Notes
This parameter specifies how often the AutoUpgrade progress JSON report is written. If you do not set this parameter, then by default the AutoUpgrade progress JSON report interval is 30 seconds
Example
In the following example,global.json_progress_writing_interval=90
is used to
specify that the JSON progress report is written every 90 seconds to the log
directory specified by global.autoupg_log_dir
:
global.json_progress_writing_interval=90
global.autoupg_log_dir=/path/to/my/global/log/dir
keystore
Usage Notes
You can use the keystore parameter to specify where you want AutoUpgrade to create a dedicated software keystore that is used exclusively by AutoUpgrade.
The AutoUpgrade keystore contains the file ewallet.p12
(similar to other kind of keystores used by the database). The file
is created when you use the save
command in the TDE
prompt. If you choose to generate an auto-login keystore, then the
file cwallet.sso
is created as well. If you have an
auto-login keystore, then AutoUpgrade does not prompt for a keystore
password when AutoUpgrade starts.
The keystore generated by AutoUpgrade contains sensitive information, and is protected by a password that you choose when the keystore is used for the first time. Each time changes are made to the keystore, the password must be supplied. Unless you decide to create an auto-login keystore for AutoUpgrade, each time you start AutoUpgrade, and AutoUpgrade requires information from the keystore, you must provide the keystore password.
Caution:
Because the directory you specify withglobal.keystore
contains a software keystore, it should be protected using the same
security best practices as you use with all other highly secure
keystore files.
Example
In the following example, replaceORACLE_SID
with the system
identifier of the database using the keystore.
global.keystore=/etc/oracle/keystores/ORACLE_SID/autoupgrade
upgradexml
(Optional) Generates the upgrade.xml
file.
Usage Notes
The upgrade.xml
generated is equivalent to
the file in earlier releases that the preupgrade package generated
when you specified the XML parameter. This file is created during
the analyze mode (mode -analyze
). It is generated
in the prechecks directory defined for the AutoUpgrade log
files.
Options
[yes | no]
The default value is no
.
Example
global.upgradexml=yes