'\" t
.\"     Title: upgrade
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: April, 2013
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "UPGRADE" "1M" "April, 2013" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
upgrade \- upgrade OpenDJ directory server
.SH "SYNOPSIS"
.ad l
.hy 0
.HP \w'\fBupgrade\fR\ 'u
\fBupgrade\fR [\-n] [\-r] [\-a\ \fIdirectory\fR]
.br

.br
[\-Q] [\-v] [\-V] [\-H]
.ad
.hy
.SH "DESCRIPTION"
.PP
This utitility can be used to upgrade the data directory of one or more OpenDJ instances to the version of the OpenDJ server, which comes with the package containing this utility, or to revert them to a previous version\&.
.PP
When using the tool to revert to a previous version you must either indicate that you want to revert to the version before the most recent upgrade using the
\%\fB\-\-revertMostRecent\fR
option or specify the location of a reversion archive using the
\%\fB\-\-reversionArchive\fR
option\&.
.PP
The usual steps to upgrade to a new version should be executed as a normal user which has the
OpenDJ Admin
execution profile:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
Stop all OpenDJ server instances currently running\&. Use
\fBsvcadm\fR(1M)
to disable related services\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
Just to be sure, create a backup of all OpenDJ instance data directories\&. If you have them on a separate ZFS, just create a snapshot\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
For a major upgrade (change in the first or second number of the version string) just install the new package\&. Otherwise, for IPS packages, unfreeze the current version of the OpenDJ package and call
\%\fBpkg update opendj\fR\&. For old SYSV package versions uninstall the current version using
\fBpkgrm\fR(1M)
and install the new version using the
\fBpkgadd\fR(1M)
command\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  4." 4.2
.\}
For major upgrades, update the properties of the related SMF service (see the examples below, how to do that)\&. (TBD: let the upgrade script handle this)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 5.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  5." 4.2
.\}
Execute this utility for each data directory of the OpenDJ server instance you want to upgrade\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 6.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  6." 4.2
.\}
If everything went fine, re\-enable the related SMF service(s) using
\fBsvcadm\fR(1M)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 7.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  7." 4.2
.\}
Test, whether your OpenDJ server instances still work as expected\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 8.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  8." 4.2
.\}
Finally, for major upgrades you may now uninstall the old OpenDJ package using
\%\fBpkg uninstall\fR
for IPS or
\%\fBpkgrm\fR
for older SYSV packages to free up some disk space\&.
.RE
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\%\fB\-a, \-\-reversionArchive\fR \%\fIdirectory\fR
.RS 4
Directory where reversion files are stored\&. This should be one of the sub directories of the \'history\' directory located in the data directory of the related OpenDJ instance that is created when the upgrade tool is run\&.
.RE
.PP
\%\fB\-r, \-\-revertMostRecent\fR
.RS 4
The installation will be reverted to the state before the most recent upgrade\&.
.RE
.SS "Utility Input/Output Options"
.PP
\%\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the tool will fail\&.
.RE
.PP
\%\fB\-Q, \-\-quiet\fR
.RS 4
Use quiet mode (do not write progress information to standard output)\&.
.RE
.PP
\%\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode\&.
.RE
.SS "General Options"
.PP
\%\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\%\fB\-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXAMPLES"
.PP
The following example demonstrates upgrade without interaction (the data directory of the related instance in this case is
\%/var/share/ldap/opendj/):
.sp
.if n \{\
.RS 4
.\}
.nf
$ \%\fB\&./upgrade \-n\fR
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
See /var/tmp/logs/opendj\-upgrade\-5650414945123366149\&.log for a detailed log of this operation\&.

Initializing Upgrade \&.\&.\&.\&.\&. Done\&.
Calculating Schema Customizations \&.\&.\&.\&.\&. Done\&.
Calculating Configuration Customizations \&.\&.\&.\&.\&. Done\&.
Backing Up Files \&.\&.\&.\&.\&. Done\&.
Upgrading Components \&.\&.\&.\&.\&. Done\&.
Preparing Customizations \&.\&.\&.\&.\&. Done\&.
Applying Configuration Customizations \&.\&.\&.\&.\&. Done\&.
Verifying Upgrade \&.\&.\&.\&.\&. Done\&.
Cleaning Up \&.\&.\&.\&.\&. Done\&.
Recording Upgrade History \&.\&.\&.\&.\&. Done\&.
See /var/share/ldap/opendj/history/log for a detailed installation history\&.
QuickUpgrade Completed Successfully\&.  The OpenDJ installation at $INSTALL_ROOT has now been upgraded to version OpenDJ 2\&.5\&.0 (Build ID: YYYYMMDDhhmmssZ)\&.

See /var/tmp/logs/opendj\-upgrade\-5650414945123366149\&.log for a detailed log of this operation\&.
.fi
.if n \{\
.RE
.\}
.SH "ENVIRONMENT VARIABLES"
.PP
See
\fBopendj\fR(5)\&.
.SH "EXIT STATUS"
.PP
\%\fB0\fR
.RS 4
The command completed successfully\&.
.RE
.PP
\%\fB> 0\fR
.RS 4
An error occurred\&.
.RE
.SH "SEE ALSO"
.PP

\fBopendj\fR(5)\&.