2011-2013ForgeRock ASupgrade1OpenDJupgradeupgrade OpenDJ configuration & application dataupgradeoptionsDescriptionThis utility upgrades OpenDJ configuration (schema, directory server
configuration, and other configuration files) and application data (primarily
directory data) so that it is compatible with the binary files and scripts
that are installed.The upgrade command thus performs only part of the
upgrade process, which includes the following phases for a single
server.Get and unpack a newer version of OpenDJ directory server
software.Stop the current OpenDJ directory server.Overwrite existing binary and script files with those of the
newer version, and then run this utility, the upgrade
command, before restarting OpenDJ.Start the upgraded OpenDJ directory server.The upgrade command does not back up
OpenDJ before you upgrade, nor does it restore OpenDJ if the
upgrade command fails. In order to revert a
failed upgrade, make sure you back up OpenDJ directory server before you
overwrite existing binary and script files.By default, the upgrade command requests
confirmation before making important configuration changes. You can use
the option to run the command
non-interactively.When using the option, if the
upgrade command cannot complete because it requires
confirmation for a potentially very long or critical task, then it exits
with an error and a message about how to finish making the changes. You can
add the option to force a non-interactive upgrade
to continue in this case, also performing long running and critical
tasks.After upgrading, see the resulting upgrade.log
file for a full list of operations performed.OptionsThe following options are supported.Forces a non-interactive upgrade to continue even if it requires
user interaction. In particular, long running or critical upgrade tasks,
such as re-indexing, which require user confirmation will be skipped. This
option may only be used with the option.Ignores any errors which occur during the upgrade. This option
should be used with caution and may be useful in automated deployments
where potential errors are known in advance and resolved after the upgrade
has completed.Utility Input/Output OptionsUse non-interactive mode. Prompt for any required information
rather than fail.Use quiet mode.Use verbose mode.General OptionsDisplay version information.Display usage information.Exit Codes0The command completed successfully.2The command was run in non-interactive mode, but could not complete
because confirmation was required to run a long or critical task.See the error message or the log for details.OtherAn error occurred.ExamplesThe following example shows the upgrade process for OpenDJ directory
server installed from the cross-platform (.zip) delivery.$ cd /path/to
$ ls
OpenDJ-2.4.6
$ ./OpenDJ-2.4.6/bin/stop-ds --quiet
... msg=The backend userRoot is now taken offline
... msg=The Directory Server is now stopped
$ zip -rq OpenDJ-backup.zip OpenDJ-2.4.6
$ unzip -q ~/Downloads/OpenDJ-.zip
$ cp -r opendj/* OpenDJ-2.4.6/
$ rm -rf opendj
$ mv OpenDJ-2.4.6 opendj
$ ./opendj/upgrade --no-prompt
>>>> OpenDJ Upgrade Utility
* OpenDJ will be upgraded from version 2.4.6.8102 to .revision
* See '/path/to/opendj/upgrade.log' for a detailed log of this operation
>>>> Preparing to upgrade
OpenDJ modified the default configuration of the 'isMemberOf' virtual
attribute so that it is included with group entries. This was done in order
to make it easier for users to determine which groups a 'nested' group
belongs to.
Do you want to make this configuration change? (yes/no) yes
The upgrade is ready to proceed. Do you wish to continue? (yes/no) yes
>>>> Performing upgrade
Fixing de-DE collation matching rule OID............................ 100%
Updating password policy configurations............................. 100%
Updating audit log publisher configuration.......................... 100%
Adding 'etag' virtual attribute schema.............................. 100%
Configuring 'etag' virtual attribute................................ 100%
Configuring 'ds-pwp-password-expiration-time' virtual attribute..... 100%
Updating certificate syntax configuration........................... 100%
Updating JPEG syntax configuration.................................. 100%
Updating country string syntax configuration........................ 100%
Modifying filter in 'isMemberOf' virtual attribute configuration.... 100%
Updating dictionary password validator configuration................ 100%
Updating attribute value password validator configuration........... 100%
Adding PBKDF2 password storage scheme configuration................. 100%
Replacing schema file '02-config.ldif'.............................. 100%
Archiving concatenated schema....................................... 100%
>>>> OpenDJ was successfully upgraded from version 2.4.6.8102 to .revision
* See '/path/to/opendj/upgrade.log' for a detailed log of this operation
$ ./opendj/bin/start-ds --quiet
$ Native packages (.deb, .rpm) perform more of the upgrade process,
stopping OpenDJ if it is running, overwriting older files with newer files,
running this utility, and starting OpenDJ if it was running when you upgraded
the package(s).