mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opendj3/src/main/docbkx/admin-guide/appendix-rest2ldap.xml
@@ -44,7 +44,7 @@ the RESTful API over HTTP (or HTTPS). You configure the mapping between JSON resources and LDAP entries by editing the configuration file for the HTTP connection handler, by default <filename>/path/to/OpenDJ/config/http-config.json</filename>.</para> <filename>/path/to/opendj/config/http-config.json</filename>.</para> </listitem> <listitem> opendj3/src/main/docbkx/admin-guide/chap-account-lockout.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-account-lockout' @@ -194,7 +194,7 @@ <para>OpenDJ can send mail about account status changes. OpenDJ needs an SMTP server to send messages, and needs templates for the mail it sends. By default, message templates are in English, under <filename>/path/to/OpenDJ/config/messages/</filename>.</para> <filename>/path/to/opendj/config/messages/</filename>.</para> <para>OpenDJ generates notifications only when OpenDJ writes to an entry or evaluates a user entry for authentication. OpenDJ generates account enabled opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-admin-tools' @@ -171,13 +171,13 @@ <itemizedlist> <para>Setup, upgrade, and uninstall tools are located in the directory where you unpacked OpenDJ, such as <filename>/path/to/OpenDJ</filename>. Find the you unpacked OpenDJ, such as <filename>/path/to/opendj</filename>. Find the additional command-line tools for your platform.</para> <listitem> <para>(UNIX) In OpenDJ/bin.</para> <para>(UNIX) In opendj/bin.</para> </listitem> <listitem> <para>(Windows) In OpenDJ\bat.</para> <para>(Windows) In opendj\bat.</para> </listitem> </itemizedlist>
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-backup-restore' @@ -76,7 +76,7 @@ --bindDN "cn=Directory Manager" --bindPassword password --backendID userRoot --backupDirectory /path/to/OpenDJ/bak --backupDirectory /path/to/opendj/bak --start 0 Backup task 20110613143715983 scheduled to start Jun 13, 2011 2:37:15 PM CEST</screen> </step> @@ -92,7 +92,7 @@ msg=The backend userRoot is now taken offline [13/Jun/2011:14:31:00 +0200] category=CORE severity=NOTICE msgID=458955 msg=The Directory Server is now stopped $ backup --backendID userRoot -d /path/to/OpenDJ/bak $ backup --backendID userRoot -d /path/to/opendj/bak [13/Jun/2011:14:33:48 +0200] category=TOOLS severity=NOTICE msgID=10944792 msg=Starting backup for backend userRoot [13/Jun/2011:14:33:48 +0200] category=JEB severity=NOTICE msgID=8847446 @@ -112,7 +112,7 @@ --bindDN "cn=Directory Manager" --bindPassword password --backUpAll --backupDirectory /path/to/OpenDJ/bak --backupDirectory /path/to/opendj/bak --start 0 Backup task 20110613143801866 scheduled to start Jun 13, 2011 2:38:01 PM CEST</screen> </step> @@ -134,7 +134,7 @@ --bindDN "cn=Directory Manager" --bindPassword password --backUpAll --backupDirectory /path/to/OpenDJ/bak --backupDirectory /path/to/opendj/bak --recurringTask "00 02 * * *" --completionNotify diradmin@example.com --errorNotify diradmin@example.com @@ -182,7 +182,7 @@ msg=The backend userRoot is now taken offline [13/Jun/2011:15:44:06 +0200] category=CORE severity=NOTICE msgID=458955 msg=The Directory Server is now stopped $ restore --backupDirectory /path/to/OpenDJ/bak --listBackups $ restore --backupDirectory /path/to/opendj/bak --listBackups Backup ID: 20110613080032 Backup Date: 13/Jun/2011:08:00:45 +0200 Is Incremental: false @@ -191,7 +191,7 @@ Has Unsigned Hash: false Has Signed Hash: false Dependent Upon: none $ restore --backupDirectory /path/to/OpenDJ/bak --backupID 20110613080032 $ restore --backupDirectory /path/to/opendj/bak --backupID 20110613080032 [13/Jun/2011:15:47:41 +0200] category=JEB severity=NOTICE msgID=8847445 msg=Restored: 00000000.jdb (size 341835) $ start-ds @@ -206,7 +206,7 @@ --port 4444 --bindDN "cn=Directory Manager" --bindPassword password --backupDirectory /path/to/OpenDJ/bak --backupDirectory /path/to/opendj/bak --backupID 20110613080032 --start 0 Restore task 20110613155052932 scheduled to start Jun 13, 2011 3:50:52 PM CEST</screen> @@ -275,7 +275,7 @@ msg=The backend userRoot is now taken offline [13/Jun/2011:15:44:06 +0200] category=CORE severity=NOTICE msgID=458955 msg=The Directory Server is now stopped $ restore --backupDirectory /path/to/OpenDJ/bak --listBackups $ restore --backupDirectory /path/to/opendj/bak --listBackups Backup ID: 20110613080032 Backup Date: 13/Jun/2011:08:00:45 +0200 Is Incremental: false @@ -284,7 +284,7 @@ Has Unsigned Hash: false Has Signed Hash: false Dependent Upon: none $ restore --backupDirectory /path/to/OpenDJ/bak --backupID 20110613080032 $ restore --backupDirectory /path/to/opendj/bak --backupID 20110613080032 [13/Jun/2011:15:47:41 +0200] category=JEB severity=NOTICE msgID=8847445 msg=Restored: 00000000.jdb (size 341835) $ start-ds opendj3/src/main/docbkx/admin-guide/chap-change-certs.xml
@@ -46,7 +46,7 @@ <itemizedlist> <para>By default the key stores are located in the <filename>/path/to/OpenDJ/config</filename> directory.</para> <filename>/path/to/opendj/config</filename> directory.</para> <listitem> <para>The <filename>keystore</filename> and <filename>truststore</filename> @@ -154,7 +154,7 @@ <step> <para>Check the alias of the key pair and certificate copy to replace.</para> <screen>$ cd /path/to/OpenDJ/config <screen>$ cd /path/to/opendj/config $ keytool -list -keystore admin-keystore -storepass `cat admin-keystore.pin` Keystore type: JKS @@ -291,7 +291,7 @@ <step> <para>Restart OpenDJ to make sure it reloads the key stores.</para> <screen>$ cd /path/to/OpenDJ/bin <screen>$ cd /path/to/opendj/bin $ stop-ds --restart</screen> </step> @@ -394,8 +394,8 @@ -list -v -alias ads-certificate -keystore /path/to/OpenDJ/config/ads-truststore -storepass `cat /path/to/OpenDJ/config/ads-truststore.pin` -keystore /path/to/opendj/config/ads-truststore -storepass `cat /path/to/opendj/config/ads-truststore.pin` Alias name: ads-certificate Creation date: Feb 7, 2013 Entry type: PrivateKeyEntry opendj3/src/main/docbkx/admin-guide/chap-ldap-operations.xml
@@ -1519,8 +1519,8 @@ -import -alias myapp-cert -file /path/to/myapp-cert.crt -keystore /path/to/OpenDJ/config/truststore -storepass `cat /path/to/OpenDJ/config/keystore.pin` -keystore /path/to/opendj/config/truststore -storepass `cat /path/to/opendj/config/keystore.pin` Owner: CN=My App, OU=Apps, DC=example, DC=com Issuer: CN=My App, OU=Apps, DC=example, DC=com Serial number: 5ae2277 @@ -1564,8 +1564,8 @@ -import -alias ca-cert -file ca.crt -keystore /path/to/OpenDJ/config/truststore -storepass `cat /path/to/OpenDJ/config/keystore.pin` -keystore /path/to/opendj/config/truststore -storepass `cat /path/to/opendj/config/keystore.pin` Owner: EMAILADDRESS=admin@example.com, CN=Example CA, O=Example Corp, C=FR Issuer: EMAILADDRESS=admin@example.com, CN=Example CA, O=Example Corp, C=FR Serial number: d4586ea05c878b0c @@ -1768,8 +1768,8 @@ -export -alias server-cert -file server-cert.crt -keystore /path/to/OpenDJ/config/keystore -storepass `cat /path/to/OpenDJ/config/keystore.pin` -keystore /path/to/opendj/config/keystore -storepass `cat /path/to/opendj/config/keystore.pin` $ keytool -import -trustcacerts opendj3/src/main/docbkx/admin-guide/chap-listeners.xml
@@ -168,8 +168,8 @@ -import -alias myapp-cert -file myapp-cert.crt -keystore /path/to/OpenDJ/config/truststore -storepass `cat /path/to/OpenDJ/config/keystore.pin` -keystore /path/to/opendj/config/truststore -storepass `cat /path/to/opendj/config/keystore.pin` Owner: CN=My App, OU=Apps, DC=example, DC=com Issuer: CN=My App, OU=Apps, DC=example, DC=com Serial number: 5ae2277 @@ -213,8 +213,8 @@ -export -alias server-cert -file server-cert.crt -keystore /path/to/OpenDJ/config/keystore -storepass `cat /path/to/OpenDJ/config/keystore.pin` -keystore /path/to/opendj/config/keystore -storepass `cat /path/to/opendj/config/keystore.pin` Certificate stored in file <server-cert.crt></screen> <para>Importing the server certificate is similar to importing the client @@ -244,7 +244,7 @@ -alias server-cert -keyalg rsa -dname "CN=opendj.example.com,O=Example Corp,C=FR" -keystore /path/to/OpenDJ/config/keystore -keystore /path/to/opendj/config/keystore -storepass changeit -keypass changeit</screen> @@ -261,7 +261,7 @@ <screen>$ keytool -certreq -alias server-cert -keystore /path/to/OpenDJ/config/keystore -keystore /path/to/opendj/config/keystore -storepass changeit -file server-cert.csr</screen> </step> @@ -336,7 +336,7 @@ <screen>$ keytool -import -keystore /path/to/OpenDJ/config/keystore -keystore /path/to/opendj/config/keystore -file ca.crt -alias ca-cert -storepass changeit @@ -393,7 +393,7 @@ -trustcacerts -alias server-cert -file ~/Downloads/server-cert.crt -keystore /path/to/OpenDJ/config/keystore -keystore /path/to/opendj/config/keystore -storepass changeit -keypass changeit Certificate reply was installed in keystore</screen> @@ -463,7 +463,7 @@ -alias server-cert -keyalg rsa -dname "CN=opendj.example.com,O=Example Corp,C=FR" -keystore /path/to/OpenDJ/config/keystore -keystore /path/to/opendj/config/keystore -storepass changeit -keypass changeit</screen> <para>In this example, OpenDJ is running on a system with fully qualified @@ -483,7 +483,7 @@ <screen>$ keytool -selfcert -alias server-cert -keystore /path/to/OpenDJ/config/keystore -keystore /path/to/opendj/config/keystore -storepass changeit</screen> </step> <step> @@ -854,7 +854,7 @@ <para>You configure the mapping between JSON resources and LDAP entries by editing the configuration file for the HTTP connection handler, by default <filename>/path/to/OpenDJ/config/http-config.json</filename>. The default <filename>/path/to/opendj/config/http-config.json</filename>. The configuration is described in the appendix, <link xlink:show="new" xlink:href="admin-guide#appendix-rest2ldap" xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP @@ -926,8 +926,8 @@ -export -rfc -alias server-cert -keystore /path/to/OpenDJ/config/keystore -storepass `cat /path/to/OpenDJ/config/keystore.pin` -keystore /path/to/opendj/config/keystore -storepass `cat /path/to/opendj/config/keystore.pin` -file server-cert.pem Certificate stored in file <server-cert.pem> $ curl - -cacert server-cert.pem https://opendj.example.com:8443/users/bjensen?_prettyPrint @@ -1195,7 +1195,7 @@ </step> <step> <para>Add the directory where you put LDIF to be processed.</para> <screen>$ mkdir /path/to/OpenDJ/config/auto-process-ldif</screen> <screen>$ mkdir /path/to/opendj/config/auto-process-ldif</screen> <para>This example uses the default value of the <literal>ldif-directory</literal> property for the LDIF connection handler.</para> opendj3/src/main/docbkx/admin-guide/chap-monitoring.xml
@@ -55,7 +55,7 @@ objectClass: top objectClass: ds-monitor-entry objectClass: extensibleObject disk-dir: /path/to/OpenDJ/db/userRoot disk-dir: /path/to/opendj/db/userRoot disk-free: 343039315968 cn: userRoot backend @@ -168,7 +168,7 @@ <screen>$ snmpwalk -v 2c -c OpenDJ@OpenDJ localhost:11161 SNMPv2-SMI::mib-2.66.1.1.1.1 = STRING: "OpenDJ <?eval ${docTargetVersion}?>..." SNMPv2-SMI::mib-2.66.1.1.2.1 = STRING: "/path/to/OpenDJ" SNMPv2-SMI::mib-2.66.1.1.2.1 = STRING: "/path/to/opendj" ...</screen> </section> @@ -244,7 +244,7 @@ --- Server Details --- Host Name: localhost Administrative Users: cn=Directory Manager Installation Path: /path/to/OpenDJ Installation Path: /path/to/opendj Version: OpenDJ <?eval ${docTargetVersion}?> Java Version: 1.6.0_24 Administration Connector: Port 4444 (LDAPS) @@ -502,7 +502,7 @@ <para>A common development troubleshooting technique consists of sending client requests while tailing the access log:</para> <screen>$ tail -f /path/to/OpenDJ/logs/access</screen> <screen>$ tail -f /path/to/opendj/logs/access</screen> <para>Trouble is, when OpenDJ Control Panel is running, or when you are also adapting your configuration using the <command>dsconfig</command> command, OpenDJ writes access log messages related to administration. @@ -545,7 +545,7 @@ you perform a simple <command>ldapsearch --port 1389 --baseDN dc=example,dc=com uid=bjensen cn</command>, then all you see in the access log is the effect of the <command>ldapsearch</command> command.</para> <screen>$ tail -f /path/to/OpenDJ/logs/access <screen>$ tail -f /path/to/opendj/logs/access [19/Oct/2011:16:37:16 +0200] CONNECT conn=8 from=127.0.0.1:54165 to=127.0.0.1:1389 protocol=LDAP [19/Oct/2011:16:37:16 +0200] SEARCH REQ conn=8 op=0 msgID=1 opendj3/src/main/docbkx/admin-guide/chap-pta.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-pta' @@ -138,7 +138,7 @@ <step> <para>Import the authentication server certificate into OpenDJ's key store.</para> <screen>$ cd /path/to/OpenDJ/config <screen>$ cd /path/to/opendj/config $ keytool -importcert -alias pta-cert @@ -292,7 +292,7 @@ </step> <step> <para>Import the server certificate into OpenDJ's key store.</para> <screen>$ cd /path/to/OpenDJ/config <screen>$ cd /path/to/opendj/config $ keytool -importcert -alias ad-cert opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml
@@ -450,7 +450,7 @@ <listitem> <para>In the configuration file for the HTTP Connection Handler, by default <filename>/path/to/OpenDJ/config/http-config.json</filename>, set <filename>/path/to/opendj/config/http-config.json</filename>, set <literal>"useSubtreeDelete" : true</literal>.</para> <note> opendj3/src/main/docbkx/admin-guide/chap-schema.xml
@@ -326,7 +326,7 @@ <para>Used to specify the relative path to the schema file containing the schema element such as <literal>X-SCHEMA-FILE '00-core.ldif'</literal>. Schema definitions are located by default in <filename>/path/to/OpenDJ/config/schema/*.ldif</filename> files.</para> <filename>/path/to/opendj/config/schema/*.ldif</filename> files.</para> </listitem> </varlistentry> </variablelist> opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -164,14 +164,14 @@ <para>You can find Berkeley Java Edition database recovery messages in the database log file, such as <filename>/path/to/OpenDJ/db/userRoot/je.info.0</filename>. The following <filename>/path/to/opendj/db/userRoot/je.info.0</filename>. The following shows two example messages from that log, the first written at the beginning of the recovery process, the second written at the end of the process.</para> <screen>111104 10:23:48:967 CONFIG [/path/to/OpenDJ/db/userRoot]Recovery <screen>111104 10:23:48:967 CONFIG [/path/to/opendj/db/userRoot]Recovery underway, found end of log ... 111104 10:23:49:015 CONFIG [/path/to/OpenDJ/db/userRoot]Recovery finished: 111104 10:23:49:015 CONFIG [/path/to/opendj/db/userRoot]Recovery finished: Recovery Info ...</screen> <para>What can take some time during server startup is preloading database opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml
@@ -103,7 +103,7 @@ <step> <para>Generate the encoded version of the new password using the OpenDJ <command>encode-password</command> command.</para> <screen>$ cd /path/to/OpenDJ/bin/ <screen>$ cd /path/to/opendj/bin/ $ ./encode-password --storageScheme SSHA512 --clearPassword password Encoded Password: "{SSHA512}yWqHnYV4a5llPvE7WHLe5jzK27oZQWLIlVcs9gySu4TyZJMg NQNRtnR/Xx2xces1wu1dVLI9jVVtl1W4BVsmOKjyjr0rWrHt"</screen> @@ -117,7 +117,7 @@ <step> <para>Find Directory Manager's entry, which has DN <literal>cn=Directory Manager,cn=Root DNs,cn=config</literal>, in <filename>/path/to/OpenDJ/config/config.ldif</filename>, and carefully <filename>/path/to/opendj/config/config.ldif</filename>, and carefully replace the <literal>userpassword</literal> attribute value with the encoded version of the new password, taking care not to leave any whitespace at the end of the line.</para> @@ -180,7 +180,7 @@ <step> <para>Use the <command>ldappasswordmodify</command> command to reset the global administrator's password</para> <screen>$ cd /path/to/OpenDJ/bin/ <screen>$ cd /path/to/opendj/bin/ $ ./ldappasswordmodify --useStartTLS --port 1389 @@ -756,7 +756,7 @@ --no-prompt</screen> <para>Alternatively, stop OpenDJ, edit the corresponding ACI carefully in <filename>/path/to/OpenDJ/config/config.ldif</filename>, and restart OpenDJ. <filename>/path/to/opendj/config/config.ldif</filename>, and restart OpenDJ. <footnote><para>Unlike the <command>dsconfig</command> command, the <filename>config.ldif</filename> file is not a public interface, so this alternative should not be used in production.</para></footnote></para> opendj3/src/main/docbkx/admin-guide/index.xml
@@ -94,7 +94,7 @@ <partintro> <para>You can find the tools under the <filename>bin/</filename> or <filename>bat\</filename> folder where you installed OpenDJ directory server. For example, <filename>/path/to/OpenDJ/bin</filename>.</para> server. For example, <filename>/path/to/opendj/bin</filename>.</para> </partintro> <xinclude:include href='../shared/man-backup.xml' /> opendj3/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -68,12 +68,7 @@ </listitem> </varlistentry> <varlistentry> <term>opendj.zip</term> <listitem> <para>SVR4 format native packages for Solaris</para> </listitem> </varlistentry> <!-- TODO: .deb, .rpm not yet posted on a download page --> <varlistentry> <term>OpenDJ-<?eval ${docTargetVersion}?>-DSML.war</term> @@ -126,7 +121,7 @@ <step> <para>Run the <command>setup --cli</command> command found in the <filename>OpenDJ-<?eval ${docTargetVersion}?></filename> directory.</para> <filename>opendj</filename> directory.</para> <para>This command starts the setup program in interactive mode on the command line, prompting you for each option. Alternatively, use @@ -145,7 +140,7 @@ GUI installer with your local version of software, as does Java WebStart with a remote version of the software.</para> <screen>$ /path/to/OpenDJ-<?eval ${docTargetVersion}?>/setup --cli <screen>$ /path/to/opendj/setup --cli OpenDJ <?eval ${docTargetVersion}?> Please wait while the setup program initializes... @@ -216,7 +211,7 @@ Starting Directory Server ........... Done. To see basic server configuration status and configuration you can launch \ /path/to/OpenDJ-<?eval ${docTargetVersion}?>/bin/status</screen> /path/to/opendj/bin/status</screen> <variablelist> <para>Some notes on the options follow.</para> @@ -340,7 +335,7 @@ <para>Run the <command>status</command> command to make sure your OpenDJ server is working as expected.</para> <screen>$ /path/to/OpenDJ-<?eval ${docTargetVersion}?>/bin/status <screen>$ /path/to/opendj/bin/status >>>> Specify OpenDJ LDAP connection parameters @@ -355,7 +350,7 @@ --- Server Details --- Host Name: opendj.example.com Administrative Users: cn=Directory Manager Installation Path: /path/to/OpenDJ-<?eval ${docTargetVersion}?> Installation Path: /path/to/opendj Version: OpenDJ <?eval ${docTargetVersion}?> Java Version: 1.6.0_29 Administration Connector: Port 4444 (LDAPS) @@ -435,7 +430,7 @@ <screen>$ cat /net/install/dj/1/setup.sh #!/bin/sh unzip -d /path/to /net/install/dj/OpenDJ-<?eval ${docTargetVersion}?> && cd /path/to/OpenDJ-<?eval ${docTargetVersion}?> unzip -d /path/to /net/install/dj/OpenDJ-<?eval ${docTargetVersion}?> && cd /path/to/opendj ./setup --cli --propertiesFilePath /net/install/dj/1/setup.props --no-prompt</screen> </step> @@ -444,11 +439,11 @@ <screen>$ /net/install/dj/1/setup.sh Archive: /net/install/dj/OpenDJ-<?eval ${docTargetVersion}?>.zip creating: /path/to/OpenDJ-2.5.0/ creating: /path/to/opendj ... inflating: /path/to/OpenDJ-2.5.0/setup inflating: /path/to/OpenDJ-2.5.0/uninstall inflating: /path/to/OpenDJ-2.5.0/upgrade inflating: /path/to/opendj/setup inflating: /path/to/opendj/uninstall inflating: /path/to/opendj/upgrade OpenDJ <?eval ${docTargetVersion}?> Please wait while the setup program initializes... @@ -461,7 +456,7 @@ Starting Directory Server ....... Done. To see basic server configuration status and configuration you can launch /path/to/OpenDJ-<?eval ${docTargetVersion}?>/bin/status</screen> /path/to/opendj/bin/status</screen> <para>At this point you can use OpenDJ directory server, or you can perform additional configuration.</para> opendj3/src/main/docbkx/install-guide/chap-uninstall.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-uninstall' @@ -83,7 +83,7 @@ <command>uninstall</command> options to specify choices for the options. See <command>uninstall --help</command> for more information.</para> <screen>$ cd /path/to/OpenDJ-<?eval ${docTargetVersion}?> <screen>$ cd /path/to/opendj $ ./uninstall --cli Do you want to remove all components of the server or select the components to remove? @@ -105,7 +105,7 @@ The Uninstall Completed Successfully. To complete the uninstallation, you must delete manually the following files and directories: /path/to/OpenDJ-<?eval ${docTargetVersion}?>/lib /path/to/opendj/lib See /var/....log for a detailed log of this operation.</screen> </step> @@ -113,7 +113,7 @@ <para>If the command output tells you to delete files manually, then remove those remaining files to complete the process.</para> <screen>$ rm -rf /path/to/OpenDJ-<?eval ${docTargetVersion}?></screen> <screen>$ rm -rf /path/to/opendj</screen> </step> </procedure> </chapter> opendj3/src/main/docbkx/install-guide/chap-upgrade.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-upgrade' @@ -32,197 +32,181 @@ <title>Upgrading to OpenDJ <?eval ${docTargetVersion}?></title> <indexterm><primary>Upgrading</primary></indexterm> <para>You can upgrade from an earlier version of OpenDJ either directly from within the Java WebStart installer, or on the command-line using the <command>upgrade</command> command.</para> <para>This chapter covers upgrade from OpenDJ 2.4.5 and later versions.</para> <note> <para>Upgrade from OpenDS 2.2 or OpenDJ 2.4 has been tested most thoroughly on Solaris, Mac OS X, and Linux. On Windows systems, export directory data to LDIF, start with a fresh installation of the OpenDJ software, and then import your data from LDIF.</para> </note> <para>For upgrades from earlier versions, upgrade first to OpenDJ <?eval ${stableServerVersion}?>, and then follow the procedures in this chapter. See <link xlink:show="new" xlink:href="https://wikis.forgerock.org/confluence/display/OPENDJ/OpenDJ+Installation+Guide#OpenDJInstallationGuide-UpgradingOpenDJDirectoryServer" >Upgrading OpenDJ Directory Server</link> in the OpenDJ Wiki for details on upgrading to OpenDJ <?eval ${stableServerVersion}?> from earlier versions.</para> <section xml:id="before-you-upgrade"> <procedure xml:id="before-you-upgrade"> <title>Before You Upgrade</title> <para>You must perform the upgrade procedure as the user who own the OpenDJ server. Make sure you have the credentials to run commands as the user who owns the server.</para> <step> <para>Prepare to perform the upgrade procedure as the user who owns the OpenDJ server files. </para> <para>Do a full backup of your current OpenDJ installation.</para> <para>Make sure you have the credentials to run commands as the user who owns the server.</para> </step> <para>When running a server version earlier than OpenDJ 2.4.1 fix the upgrade schema by following the appropriate steps depending on your platform.</para> <step> <xinclude:include href="../shared/itemizedlist-download.xml" /> </step> <para>(UNIX) Download and apply <link xlink:href='http://wikis.forgerock.org/confluence/download/attachments/11632664/opendj_patch4upgrade.sh' >opendj_patch4upgrade.sh</link> to your current server, by running the shell script from the directory where the server is installed.</para> <step> <para>In order to revert should the upgrade fail, make sure you perform a full backup of your current OpenDJ installation.</para> <screen>$ cd /path/to/OpenDJ $ sh /downloads/opendj_patch4upgrade.sh /path/to/OpenDJ has been patched, you can proceed with the upgrade program now</screen> <para>It might be most expedient to back up the file system directory where the current OpenDJ server is installed as part of the upgrade process.</para> <para>The <filename>opendj_patch4upgrade.sh</filename> script fixes a schema issuethat prevents smooth upgrades from earlier server versions. You can apply the script while the server is running.</para> <para>Alternatively, see <link xlink:href="admin-guide#chap-backup-restore" xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink" ><citetitle>Backing Up & Restoring Data</citetitle></link> for instructions.</para> </step> </procedure> <para>(Windows) Follow these steps.</para> <orderedlist> <listitem> <para>With the <command>edit</command> command line tool, open and then save <filename>OpenDJ-old-version\config\upgrade\schema.ldif.<replaceable>####</replaceable></filename> where <replaceable>####</replaceable> represents four digits, such as 6677 for 2.4.0.</para> <para>This step changes the line endings from UNIX to Windows format.</para> </listitem> <listitem> <para>Open the same file in Notepad.</para> </listitem> <listitem> <para>Add the following <literal>ldapSyntaxes</literal> definition verbatim, before the last blank line at the end of the file, leaving a blank line at the end of the file, and taking care not to add additional spaces at the end of the lines you add. <emphasis>If the result is not valid LDIF, your fix will fail.</emphasis></para> <literallayout class="monospaced">ldapSyntaxes: ( 1.3.6.1.4.1.26027.1.3.6 DESC ' Collective Conflict Behavior' X-ENUM ( 'real-overrides-virtual' ' virtual-overrides-real' 'merge-real-and-virtual' ) X-SCHEMA-FILE ' 00-core.ldif' )</literallayout> <para>This fixes a schema issue that prevents upgrades from earlier server versions. You can make the change while the server is running.</para> </listitem> </orderedlist> </section> <procedure xml:id="upgrade-zip"> <title>To Upgrade an OpenDJ Directory Server</title> <section xml:id="upgrade-servers"> <title>Upgrading OpenDJ Servers</title> <step> <para>Login as the user who owns the current OpenDJ server.</para> </step> <para>You can upgrade from the graphical installer, or from the command line.</para> <step> <para>Stop the current OpenDJ server.</para> </step> <procedure xml:id="upgrade-gui"> <title>To Upgrade From the Graphical Installer</title> <step> <para>Login to a session where you can use a GUI as the user who owns the current OpenDJ server.</para> </step> <step performance="optional"> <para>If you have not already backed up the current OpenDJ server, make a back up copy of the directory where OpenDJ is installed.</para> </step> <step performance='optional'> <para><link xlink:href='http://www.forgerock.org/opendj.html' >Download OpenDJ</link>, and unzip the downloaded file.</para> </step> <step performance="optional"> <para>If OpenDJ is currently installed in a directory such as <filename>OpenDJ-2.4.6</filename>, you can change the directory name to <filename>opendj</filename> to make it easier to unpack subsequent .zip deliveries for future upgrades.</para> </step> <step> <para>Start the installer.</para> <itemizedlist> <listitem> <para>(WebStart) <link>http://www.forgerock.org/downloads/opendj/<?eval ${docTargetVersion}?>/install/QuickSetup.jnlp</link></para> </listitem> <listitem> <para>(UNIX) Run <command>OpenDJ-<?eval ${docTargetVersion}?>/setup</command>.</para> </listitem> <listitem> <para>(Windows) Double-click <filename>OpenDJ-<?eval ${docTargetVersion}?>\setup.bat</filename></para> </listitem> </itemizedlist> </step> <step> <para>Unpack the new files from the .zip delivery over the current server files.</para> <step> <para>In the OpenDJ QuickSetup Welcome screen, select Upgrade Existing Server Instance, and make sure Server to Upgrade points to the current OpenDJ server before clicking Next.</para> </step> <para>If your directory is not named <filename>opendj</filename>, then you can first unpack the files, then copy everything in the <filename>opendj</filename> over the current server files.</para> </step> <step> <para>Follow the instructions in the QuickSetup wizard to complete the upgrade.</para> </step> <step> <para>Run the <command>upgrade</command> command to bring OpenDJ configuration and application data up to date with the new binary and script files that you copied over the current server files.</para> <step> <para>If you upgraded from OpenDS 2.2, open the OpenDJ control panel, select Indexes > Rebuild Indexes..., and use the Rebuild Indexes dialog box to rebuild the <literal>dn2id</literal> index.</para> </step> <para>By default, the <command>upgrade</command> command requests confirmation before making important configuration changes. You can use the <option>--no-prompt</option> option to run the command non-interactively.</para> <step> <para>If you upgraded from OpenDJ 2.4.4 or earlier, also rebuild the <literal>ds-sync-hist</literal> index before restarting OpenDJ.</para> </step> </procedure> <para>When using the <option>--no-prompt</option> option, if the <command>upgrade</command> 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>--force</option> option to force a non-interactive upgrade to continue in this case, also performing long running and critical tasks.</para> </step> <procedure xml:id="upgrade-cli"> <title>To Upgrade On the Command Line</title> <step> <para>Start the upgraded OpenDJ server.</para> <step> <para>Login as the user who owns the current OpenDJ server.</para> </step> <para>At this point the upgrade process is complete. See the resulting <filename>upgrade.log</filename> file for a full list of operations performed.</para> </step> </procedure> <step> <para>Download the OpenDJ .zip file.</para> <screen>$ cd /tmp $ wget http://www.forgerock.org/downloads/opendj/<?eval ${docTargetVersion}?>/OpenDJ-<?eval ${docTargetVersion}?>.zip</screen> </step> <step> <para>Change to the directory at the root of the server instance.</para> <screen>$ cd /path/to/OpenDJ</screen> </step> <step> <para>Pass the .zip file name to the <command>upgrade</command> command.</para> <screen>$ ./upgrade --file /tmp/OpenDJ-<?eval ${docTargetVersion}?>.zip See /var/....log for a detailed log of this operation. <example xml:id="upgrade-zip-example"><?dbfo keep-together="auto"?> <title>Upgrading From OpenDJ 2.4.6</title> Initializing Upgrade ..... Done. Calculating Schema Customizations ..... Done. Calculating Configuration Customizations ..... Done. Backing Up Files ..... Done. Upgrading Components ..... Done. Preparing Customizations ..... Done. Applying Schema Customizations ..... Done. Applying Configuration Customizations ..... Done. Verifying Upgrade ..... Done. Stopping Directory Server ..... Done. Cleaning Up ..... Done. Recording Upgrade History ..... Done. See /path/to/OpenDJ/history/log for a detailed installation history. QuickUpgrade Completed Successfully. The OpenDJ installation at /path/to/OpenDJ has now been upgraded to version OpenDJ <?eval ${docTargetVersion}?> (Build ID: <replaceable>buildId</replaceable>). <para>The following example upgrades an OpenDJ 2.4.6 directory server installed in <filename>/path/to/OpenDJ-2.4.6</filename>, backing up the current server directory in case the upgrade process fails, and changing the directory name to <filename>/path/to/opendj</filename> to simplify future upgrades.</para> See /var/....log for a detailed log of this operation.</screen> </step> <step> <para>If you upgraded from OpenDS 2.2, use the <command>rebuild-index</command> command to rebuild the <literal>dn2id</literal> index for your suffixes.</para> <screen>$ 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-<?eval ${docTargetVersion}?>.zip $ cp -r opendj/* OpenDJ-2.4.6/ $ rm -rf opendj $ mv OpenDJ-2.4.6 opendj $ ./opendj/upgrade --no-prompt <screen>$ ./bin/rebuild-index --index dn2id --baseDN "dc=example,dc=com" ...Rebuild complete. Processed 160 entries in 0 seconds (average rate 401.0/sec)</screen> </step> >>>> OpenDJ Upgrade Utility <step> <para>If you upgraded from OpenDJ 2.4.4 or earlier, also rebuild the <literal>ds-sync-hist</literal> index before restarting OpenDJ.</para> </step> </procedure> * OpenDJ will be upgraded from version 2.4.6.8102 to <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable> * See '/path/to/opendj/upgrade.log' for a detailed log of this operation <procedure xml:id="upgrade-repl"> <title>To Upgrade Replicated Servers</title> <step> <para>Upgrade each server sequentially, as described above.</para> </step> </procedure> >>>> Preparing to upgrade <procedure xml:id="upgrade-dsml"> <title>To Upgrade OpenDJ DSML Gateway</title> <step> <para>Replace the gateway web application with the newer version, as for a fresh installation.</para> </step> </procedure> </section> OpenDJ <?eval ${docTargetVersion}?> 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 <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable> * See '/path/to/opendj/upgrade.log' for a detailed log of this operation $ ./opendj/bin/start-ds --quiet $ </screen> </example> <procedure xml:id="upgrade-repl"> <title>To Upgrade Replicated Servers</title> <step> <para>Upgrade each server sequentially, as described above.</para> </step> </procedure> <procedure xml:id="upgrade-dsml"> <title>To Upgrade OpenDJ DSML Gateway</title> <step> <para>Replace the gateway web application with the newer version, as for a fresh installation.</para> </step> </procedure> </chapter> opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <chapter xml:id='chap-compatibility' @@ -38,15 +38,16 @@ <title>Major Changes to Existing Functionality</title> <para>OpenDJ <?eval ${docTargetVersion}?> improves on earlier releases introducing many new features and important fixes without major, backwards-incompatible changes. Take the following into account, however.</para> introducing many new features. Also take the following into account.</para> <itemizedlist> <listitem> <para>When upgrading from 2.4.4 or earlier, after you upgrade but before you restart OpenDJ, you must rebuild the <literal>ds-sync-hist</literal> index.</para> <para>The upgrade process and <command>upgrade</command> command have changed to facilitate native packaging on more platforms. See <link xlink:show="new" xlink:href="install-guide#chap-upgrade" xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Upgrading to OpenDJ <?eval ${docTargetVersion}?></citetitle></link> for instructions.</para> </listitem> <listitem> <para>The default DB cache size is now 50%, rather than 10%.</para> @@ -72,7 +73,7 @@ </listitem> </itemizedlist> <!-- Not yet for OpenDJ 2.5. <!-- Not yet for OpenDJ 2.6.0. <para>The <command>ldif-diff</command> command has been renamed <command>ldifdiff</command>, and the <option>-\-outputLDIF</option>, <option>-\-overwriteExisting</option>, <option>-\-sourceLDIF</option>, @@ -93,9 +94,6 @@ <section xml:id="removed-functionality"> <title>Removed Functionality</title> <para>No functionality has been removed in OpenDJ <?eval ${docTargetVersion}?>.</para> <para>No functionality is planned to be removed at this time.</para> <para>Native packages in SVR4 format for Solaris are no longer provided.</para> </section> </chapter> opendj3/src/main/docbkx/release-notes/chap-whats-new.xml
@@ -65,7 +65,7 @@ <itemizedlist> <listitem> <para>TODO: Bring this list up to date post OpenDJ 2.5.0-Xpress1.</para> <para>TODO: Bring this list up to date with issue tracker</para> </listitem> <listitem> <para>OpenDJ now provides RESTful access to directory data (<link @@ -108,6 +108,20 @@ xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-469" >OPENDJ-469</link>).</para> </listitem> <listitem> <para>The OpenDJ upgrade process and <command>upgrade</command> command have changed to facilitate native packaging on more platforms and to make upgrade easier to handle over time (<link xlink:show="new" xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-455" >OPENDJ-455</link>).</para> <para>See <link xlink:show="new" xlink:href="install-guide#chap-upgrade" xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Upgrading to OpenDJ <?eval ${docTargetVersion}?></citetitle></link> for instructions.</para> </listitem> <listitem> <para>The mechanism to determine during setup whether the configuration has been modified runs a more effective check (<link xlink:show="new" opendj3/src/main/docbkx/shared/man-backup.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='backup-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>backup</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -331,27 +331,27 @@ <para>The following example backs up all user data while the server is online.</para> <screen>$ backup -p 4444 -D "cn=Directory Manager" -w password -a -d /path/to/OpenDJ/bak -t 0 -a -d /path/to/opendj/bak -t 0 Backup task 20110613143801866 scheduled to start Jun 13, 2011 2:38:01 PM CEST</screen> <para>The following example schedules back up of all user data every night at 2 AM when the server is online, and notifies diradmin@example.com when finished, or on error.</para> <screen>$ backup -p 4444 -D "cn=Directory Manager" -w password -a -d /path/to/OpenDJ/bak --recurringTask "00 02 * * *" -d /path/to/opendj/bak --recurringTask "00 02 * * *" --completionNotify diradmin@example.com --errorNotify diradmin@example.com Recurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0 scheduled successfully</screen> <para>The following example backs up all user data while the server is offline.</para> <screen>$ /path/to/OpenDJ/bin/stop-ds <screen>$ /path/to/opendj/bin/stop-ds Stopping Server... ... $ /path/to/OpenDJ/bin/backup --backupAll --backupDirectory /path/to/OpenDJ/bak $ /path/to/opendj/bin/backup --backupAll --backupDirectory /path/to/opendj/bak ... [28/Sep/2012:12:14:22 +0200] ... msg=The backup process completed successfully $ /path/to/OpenDJ/bin/start-ds $ /path/to/opendj/bin/start-ds [28/Sep/2012:12:15:48 +0200] ... The Directory Server has started successfully </screen> </refsect1> opendj3/src/main/docbkx/shared/man-dsconfig.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='dsconfig-1' @@ -233,7 +233,7 @@ <term><option>-P, --trustStorePath {trustStorePath}</option></term> <listitem> <para>Certificate trust store path</para> <para>Default value: /path/to/OpenDJ/config/admin-truststore</para> <para>Default value: /path/to/opendj/config/admin-truststore</para> </listitem> </varlistentry> <varlistentry> @@ -405,8 +405,8 @@ <!-- TODO: Automate generation of the following list of subcommands. Currently, there's a secret setting in dsconfig to produce the content. $ export OPENDS_JAVA_ARGS="-Dorg.forgerock.opendj.gendoc=true" $ /path/to/OpenDJ/bin/dsconfig -? $ export OPENDJ_JAVA_ARGS="-Dorg.forgerock.opendj.gendoc=true" $ /path/to/opendj/bin/dsconfig -? --> <refsect2 xml:id="dsconfig-create-access-log-filtering-criteria"> <title>dsconfig create-access-log-filtering-criteria</title> @@ -5513,7 +5513,7 @@ --set enabled:true \ --hostname opendj.example.com \ --port 4444 \ --trustStorePath /path/to/OpenDJ/config/admin-truststore \ --trustStorePath /path/to/opendj/config/admin-truststore \ --bindDN cn=Directory\ Manager \ --bindPassword ****** \ --no-prompt @@ -5526,7 +5526,7 @@ --set enabled:false \ --hostname opendj.example.com \ --port 4444 \ --trustStorePath /path/to/OpenDJ/config/admin-truststore \ --trustStorePath /path/to/opendj/config/admin-truststore \ --bindDN cn=Directory\ Manager \ --bindPassword password \ --no-prompt @@ -5542,7 +5542,7 @@ --port 4444 --trustStorePath /path/to/OpenDJ/config/admin-truststore /path/to/opendj/config/admin-truststore --bindDN cn=Directory Manager --bindPassword opendj3/src/main/docbkx/shared/man-dsframework.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='dsframework-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>dsframework</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -157,7 +157,7 @@ <term><option>-P, --trustStorePath {trustStorePath}</option></term> <listitem> <para>Certificate trust store path</para> <para>Default value: /path/to/OpenDJ/config/admin-truststore</para> <para>Default value: /path/to/opendj/config/admin-truststore</para> </listitem> </varlistentry> <varlistentry> opendj3/src/main/docbkx/shared/man-dsjavaproperties.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='dsjavaproperties-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>dsjavaproperties</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -51,7 +51,7 @@ <para>This utility can be used to change the Java arguments and Java home that are used by other server commands.</para> <para>Before launching the command, edit the properties file located in <filename>/path/to/OpenDJ/config/java.properties</filename> to specify the <filename>/path/to/opendj/config/java.properties</filename> to specify the Java arguments and Java home. When you have edited the properties file, run this command for the changes to be taken into account.</para> <para>Changes apply to the current server installation. No modifications @@ -109,6 +109,6 @@ <screen>$ dsjavaproperties The operation was successful. The server commands will use the java arguments and java home specified in the properties file located in /path/to/OpenDJ/config/java.properties</screen> /path/to/opendj/config/java.properties</screen> </refsect1> </refentry> opendj3/src/main/docbkx/shared/man-dsreplication.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='dsreplication-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>dsreplication</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -226,7 +226,7 @@ <term><option>-P, --trustStorePath {trustStorePath}</option></term> <listitem> <para>Certificate trust store path</para> <para>Default value: /path/to/OpenDJ/config/admin-truststore</para> <para>Default value: /path/to/opendj/config/admin-truststore</para> </listitem> </varlistentry> <varlistentry> opendj3/src/main/docbkx/shared/man-make-ldif-template.xml
@@ -178,7 +178,7 @@ an absolute path to the file such as <literal><file:/path/to/myDescriptions></literal>, or you specify a path relative to the <filename>/path/to/OpenDJ/config/MakeLDIF/</filename> directory such as <filename>/path/to/opendj/config/MakeLDIF/</filename> directory such as <literal><file:streets></literal>. For the second argument, if you specify <literal>sequential</literal> then lines from the file are read in sequential order. Otherwise, lines from the file are read in @@ -190,7 +190,7 @@ <term><First></term> <listitem> <para>The first name tag gets replaced by a random line from <filename>/path/to/OpenDJ/config/MakeLDIF/first.names</filename>. <filename>/path/to/opendj/config/MakeLDIF/first.names</filename>. Combinations of generated first and last names are unique, with integers appended to the name strings if not enough combinations are available.</para> @@ -234,7 +234,7 @@ <term><Last></term> <listitem> <para>The last name tag gets replaced by a random line from <filename>/path/to/OpenDJ/config/MakeLDIF/last.names</filename>. <filename>/path/to/opendj/config/MakeLDIF/last.names</filename>. Combinations of generated first and last names are unique, with integers appended to the name strings if not enough combinations are available.</para> @@ -447,6 +447,6 @@ <para><link xlink:href="admin-guide#make-ldif-1" xlink:role="http://docbook.org/xlink/role/olink"><citerefentry><refentrytitle >make-ldif</refentrytitle><manvolnum>1</manvolnum></citerefentry></link >, <filename>/path/to/OpenDJ/config/MakeLDIF/example.template</filename></para> >, <filename>/path/to/opendj/config/MakeLDIF/example.template</filename></para> </refsect1> </refentry> opendj3/src/main/docbkx/shared/man-restore.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='restore-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>restore</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -295,14 +295,14 @@ <para>The following example schedules a restore as a task to begin immediately while OpenDJ directory server is online.</para> <screen>$ restore -p 4444 -D "cn=Directory Manager" -w password -d /path/to/OpenDJ/bak -I 20110613080032 -t 0 -d /path/to/opendj/bak -I 20110613080032 -t 0 Restore task 20110613155052932 scheduled to start Jun 13, 2011 3:50:52 PM CEST</screen> <para>The following example restores data while OpenDJ is offline.</para> <screen>$ /path/to/OpenDJ/bin/stop-ds <screen>$ /path/to/opendj/bin/stop-ds Stopping Server... ... $ /path/to/OpenDJ/bin/restore --backupDirectory /path/to/OpenDJ/bak/userRoot $ /path/to/opendj/bin/restore --backupDirectory /path/to/opendj/bak/userRoot --listBackups Backup ID: 20120928102414Z Backup Date: 28/Sep/2012:12:24:17 +0200 @@ -313,10 +313,10 @@ Has Signed Hash: false Dependent Upon: none $ /path/to/OpenDJ/bin/restore --backupDirectory /path/to/OpenDJ/bak/userRoot $ /path/to/opendj/bin/restore --backupDirectory /path/to/opendj/bak/userRoot --backupID 20120928102414Z [28/Sep/2012:12:26:20 +0200] ... msg=Restored: 00000000.jdb (size 355179) $ /path/to/OpenDJ/bin/start-ds $ /path/to/opendj/bin/start-ds [28/Sep/2012:12:27:29 +0200] ... The Directory Server has started successfully</screen> </refsect1> </refentry> opendj3/src/main/docbkx/shared/man-setup.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='setup-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>setup</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -325,7 +325,7 @@ <title>Examples</title> <para>The following command installs OpenDJ directory server, enabling StartTLS and importing 100 example entries without interaction.</para> <screen>$ ./OpenDJ/setup --cli -b dc=example,dc=com -d 100 -D "cn=Directory Manager" <screen>$ ./opendj/setup --cli -b dc=example,dc=com -d 100 -D "cn=Directory Manager" -w password -h `hostname` -p 1389 --generateSelfSignedCertificate --enableStartTLS -n @@ -340,6 +340,6 @@ Starting Directory Server .......... Done. To see basic server configuration status and configuration you can launch /path/to/OpenDJ/bin/status</screen> /path/to/opendj/bin/status</screen> </refsect1> </refentry> opendj3/src/main/docbkx/shared/man-status.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='status-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>status</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -218,7 +218,7 @@ --- Server Details --- Host Name: localhost.localdomain Administrative Users: cn=Directory Manager Installation Path: /path/to/OpenDJ Installation Path: /path/to/opendj Version: OpenDJ <?eval ${docTargetVersion}?> Java Version: 1.6.0_29 Administration Connector: Port 4444 (LDAPS) opendj3/src/main/docbkx/shared/man-uninstall.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='uninstall-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>uninstall</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -288,7 +288,7 @@ <title>Examples</title> <para>The following command removes OpenDJ directory server without interaction.</para> <screen>$ ./OpenDJ/uninstall -a --cli -I admin -w password -n <screen>$ ./opendj/uninstall -a --cli -I admin -w password -n Stopping Directory Server ..... Done. Deleting Files under the Installation Path ..... Done. @@ -296,8 +296,8 @@ The Uninstall Completed Successfully. To complete the uninstallation, you must delete manually the following files and directories: /path/to/OpenDJ/lib /path/to/opendj/lib See /var/.../opends-uninstall-3...0.log for a detailed log of this operation. $ rm -rf OpenDJ</screen> $ rm -rf opendj</screen> </refsect1> </refentry> opendj3/src/main/docbkx/shared/man-upgrade.xml
@@ -20,7 +20,7 @@ ! ! CCPL HEADER END ! ! Copyright 2011-2012 ForgeRock AS ! Copyright 2011-2013 ForgeRock AS ! --> <refentry xml:id='upgrade-1' @@ -30,7 +30,7 @@ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd' xmlns:xlink='http://www.w3.org/1999/xlink' xmlns:xinclude='http://www.w3.org/2001/XInclude'> <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info> <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info> <refmeta> <refentrytitle>upgrade</refentrytitle><manvolnum>1</manvolnum> <refmiscinfo class="software">OpenDJ</refmiscinfo> @@ -38,7 +38,7 @@ </refmeta> <refnamediv> <refname>upgrade</refname> <refpurpose>upgrade OpenDJ directory server</refpurpose> <refpurpose>upgrade OpenDJ configuration & application data</refpurpose> </refnamediv> <refsynopsisdiv> <cmdsynopsis> @@ -48,43 +48,78 @@ </refsynopsisdiv> <refsect1> <title>Description</title> <para>This utility can be used to upgrade the directory server to a newer version or revert to a previous version.</para> <para>When using this tool to upgrade the server you should first downloaded an OpenDJ install package (.zip) file and specify its location using the -f/--file option. You can also upgrade your server using the Java Web Start version of this tool by visiting the OpenDJ web site at www.forgerock.org/opendj.html.</para> <para>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 -r/--revertMostRecent option or specify the location of a reversion archive using the -a/--reversionArchive option.</para> <para>This 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.</para> <para>The <command>upgrade</command> command thus performs only part of the upgrade process, which includes the following phases for a single server.</para> <orderedlist> <listitem> <para>Get and unpack a newer version of OpenDJ directory server software.</para> </listitem> <listitem> <para>Stop the current OpenDJ directory server.</para> </listitem> <listitem> <para>Overwrite existing binary and script files with those of the newer version, and then run this utility, the <command>upgrade</command> command, before restarting OpenDJ.</para> </listitem> <listitem> <para>Start the upgraded OpenDJ directory server.</para> </listitem> </orderedlist> <important> <para>The <command>upgrade</command> command <emphasis>does not back up OpenDJ before you upgrade, nor does it restore OpenDJ if the <command>upgrade</command> command fails</emphasis>. In order to revert a failed upgrade, make sure you back up OpenDJ directory server before you overwrite existing binary and script files.</para> </important> <para>By default, the <command>upgrade</command> command requests confirmation before making important configuration changes. You can use the <option>--no-prompt</option> option to run the command non-interactively.</para> <para>When using the <option>--no-prompt</option> option, if the <command>upgrade</command> 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>--force</option> option to force a non-interactive upgrade to continue in this case, also performing long running and critical tasks.</para> <para>After upgrading, see the resulting <filename>upgrade.log</filename> file for a full list of operations performed.</para> </refsect1> <refsect1> <title>Options</title> <para>The following options are supported.</para> <variablelist> <varlistentry> <term><option>-a, --reversionArchive {directory}</option></term> <term><option>--force</option></term> <listitem> <para>Directory where reversion files are stored. This should be one of the child directories of the 'history' directory that is created when the upgrade tool is run.</para> <para>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>--no-prompt</option> option.</para> </listitem> </varlistentry> <varlistentry> <term><option>-f, --file {file}</option></term> <term><option>--ignoreErrors</option></term> <listitem> <para>Specifies an existing server package (.zip) file to which the current build will be upgraded using the command line version of this tool</para> </listitem> </varlistentry> <varlistentry> <term><option>-r, --revertMostRecent</option></term> <listitem> <para>The installation will be reverted to the state before the most recent upgrade</para> <para>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.</para> </listitem> </varlistentry> </variablelist> @@ -94,21 +129,20 @@ <varlistentry> <term><option>-n, --no-prompt</option></term> <listitem> <para>Use non-interactive mode. If data in the command is missing, the user is not prompted and the tool will fail</para> <para>Use non-interactive mode. Prompt for any required information rather than fail.</para> </listitem> </varlistentry> <varlistentry> <term><option>-Q, --quiet</option></term> <listitem> <para>Run setup in quiet mode. Quiet mode will not output progress information to standard output</para> <para>Use quiet mode.</para> </listitem> </varlistentry> <varlistentry> <term><option>-v, --verbose</option></term> <listitem> <para>Use verbose mode</para> <para>Use verbose mode.</para> </listitem> </varlistentry> </variablelist> @@ -119,13 +153,13 @@ <varlistentry> <term><option>-V, --version</option></term> <listitem> <para>Display version information</para> <para>Display version information.</para> </listitem> </varlistentry> <varlistentry> <term><option>-?, -H, --help</option></term> <listitem> <para>Display usage information</para> <para>Display usage information.</para> </listitem> </varlistentry> </variablelist> @@ -141,7 +175,15 @@ </listitem> </varlistentry> <varlistentry> <term>> 0</term> <term>2</term> <listitem> <para>The command was run in non-interactive mode, but could not complete because confirmation was required to run a long or critical task.</para> <para>See the error message or the log for details.</para> </listitem> </varlistentry> <varlistentry> <term>Other</term> <listitem> <para>An error occurred.</para> </listitem> @@ -150,29 +192,77 @@ </refsect1> <refsect1> <title>Examples</title> <para>The following example demonstrates upgrade without interaction.</para> <screen>$ ./OpenDJ/upgrade -f ~/Downloads/OpenDJ-<?eval ${docTargetVersion}?>.zip -n See /var/.../opends-upgrade-5650414945123366149.log for a detailed log of this operation. <para>The following example shows the upgrade process for OpenDJ directory server installed from the cross-platform (.zip) delivery.</para> 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 /path/to/OpenDJ/history/log for a detailed installation history. QuickUpgrade Completed Successfully. The OpenDJ installation at /path/to/OpenDJ has now been upgraded to version OpenDJ <?eval ${docTargetVersion}?> (Build ID: YYYYMMDDhhmmssZ). <!-- Intentionally not using <?eval ${stableServerVersion}?> instead of 2.4.6: See /var/.../opends-upgrade-5650414945123366149.log for a detailed log of this operation. </screen> Once the ${stableServerVersion} has moved to the new file name, the directory names will change, so 2.4.6 is not a variable here, but instead an example that should be common for the first release with the new upgrade command. Perhaps people will forgive details missing in this upgrade that happened after the example was run. --> <screen>$ 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-<?eval ${docTargetVersion}?>.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 <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable> * See '/path/to/opendj/upgrade.log' for a detailed log of this operation >>>> Preparing to upgrade OpenDJ <?eval ${docTargetVersion}?> 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 <?eval ${docTargetVersion}?>.<replaceable>revision</replaceable> * See '/path/to/opendj/upgrade.log' for a detailed log of this operation $ ./opendj/bin/start-ds --quiet $ </screen> <para>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).</para> </refsect1> </refentry> opendj3/src/main/docbkx/shared/sec-formatting-conventions.xml
@@ -43,8 +43,8 @@ and so forth are marked (UNIX). Sections pertaining to Microsoft Windows might be marked (Windows). To avoid repetition, however, file system directory names are often given only in UNIX format as in <filename>/path/to/OpenDJ</filename>, even if the text applies to <filename>C:\path\to\OpenDJ</filename> as well.</para> <filename>/path/to/opendj</filename>, even if the text applies to <filename>C:\path\to\opendj</filename> as well.</para> <para>Absolute path names usually begin with the placeholder <filename>/path/to/</filename>, which might translate to opends/resource/man/man1/backup.1
@@ -2,12 +2,12 @@ .\" Title: backup .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 09/28/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "BACKUP" "1" "09/28/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "BACKUP" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -249,7 +249,7 @@ .\} .nf $ backup \-p 4444 \-D "cn=Directory Manager" \-w password \-a \-d /path/to/OpenDJ/bak \-t 0 \-a \-d /path/to/opendj/bak \-t 0 Backup task 20110613143801866 scheduled to start Jun 13, 2011 2:38:01 PM CEST .fi .if n \{\ @@ -263,7 +263,7 @@ .\} .nf $ backup \-p 4444 \-D "cn=Directory Manager" \-w password \-a \-d /path/to/OpenDJ/bak \-\-recurringTask "00 02 * * *" \-d /path/to/opendj/bak \-\-recurringTask "00 02 * * *" \-\-completionNotify diradmin@example\&.com \-\-errorNotify diradmin@example\&.com Recurring Backup task BackupTask\-988d6adf\-4d65\-44bf\-8546\-6ea74a2480b0 scheduled successfully @@ -278,13 +278,13 @@ .RS 4 .\} .nf $ /path/to/OpenDJ/bin/stop\-ds $ /path/to/opendj/bin/stop\-ds Stopping Server\&.\&.\&. \&.\&.\&. $ /path/to/OpenDJ/bin/backup \-\-backupAll \-\-backupDirectory /path/to/OpenDJ/bak $ /path/to/opendj/bin/backup \-\-backupAll \-\-backupDirectory /path/to/opendj/bak \&.\&.\&. [28/Sep/2012:12:14:22 +0200] \&.\&.\&. msg=The backup process completed successfully $ /path/to/OpenDJ/bin/start\-ds $ /path/to/opendj/bin/start\-ds [28/Sep/2012:12:15:48 +0200] \&.\&.\&. The Directory Server has started successfully .fi .if n \{\ @@ -292,5 +292,5 @@ .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/dsconfig.1
@@ -2,12 +2,12 @@ .\" Title: dsconfig .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 07/17/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "DSCONFIG" "1" "07/17/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "DSCONFIG" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -207,7 +207,7 @@ .RS 4 Certificate trust store path .sp Default value: /path/to/OpenDJ/config/admin\-truststore Default value: /path/to/opendj/config/admin\-truststore .RE .PP \fB\-T, \-\-trustStorePassword {trustStorePassword}\fR @@ -4370,7 +4370,7 @@ \-\-set enabled:true \e \-\-hostname opendj\&.example\&.com \e \-\-port 4444 \e \-\-trustStorePath /path/to/OpenDJ/config/admin\-truststore \e \-\-trustStorePath /path/to/opendj/config/admin\-truststore \e \-\-bindDN cn=Directory\e Manager \e \-\-bindPassword ****** \e \-\-no\-prompt @@ -4383,7 +4383,7 @@ \-\-set enabled:false \e \-\-hostname opendj\&.example\&.com \e \-\-port 4444 \e \-\-trustStorePath /path/to/OpenDJ/config/admin\-truststore \e \-\-trustStorePath /path/to/opendj/config/admin\-truststore \e \-\-bindDN cn=Directory\e Manager \e \-\-bindPassword password \e \-\-no\-prompt @@ -4399,7 +4399,7 @@ \-\-port 4444 \-\-trustStorePath /path/to/OpenDJ/config/admin\-truststore /path/to/opendj/config/admin\-truststore \-\-bindDN cn=Directory Manager \-\-bindPassword opends/resource/man/man1/dsframework.1
@@ -2,12 +2,12 @@ .\" Title: dsframework .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 03/21/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "DSFRAMEWORK" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "DSFRAMEWORK" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -126,7 +126,7 @@ .RS 4 Certificate trust store path .sp Default value: /path/to/OpenDJ/config/admin\-truststore Default value: /path/to/opendj/config/admin\-truststore .RE .PP \fB\-T, \-\-trustStorePassword {trustStorePassword}\fR @@ -239,5 +239,5 @@ .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/dsjavaproperties.1
@@ -2,12 +2,12 @@ .\" Title: dsjavaproperties .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 03/21/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "DSJAVAPROPERTIES" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "DSJAVAPROPERTIES" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -37,7 +37,7 @@ This utility can be used to change the Java arguments and Java home that are used by other server commands\&. .PP Before launching the command, edit the properties file located in /path/to/OpenDJ/config/java\&.properties /path/to/opendj/config/java\&.properties to specify the Java arguments and Java home\&. When you have edited the properties file, run this command for the changes to be taken into account\&. .PP Changes apply to the current server installation\&. No modifications are made to your environment variables\&. @@ -84,12 +84,12 @@ $ dsjavaproperties The operation was successful\&. The server commands will use the java arguments and java home specified in the properties file located in /path/to/OpenDJ/config/java\&.properties /path/to/opendj/config/java\&.properties .fi .if n \{\ .RE .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/dsreplication.1
@@ -2,12 +2,12 @@ .\" Title: dsreplication .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 07/17/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "DSREPLICATION" "1" "07/17/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "DSREPLICATION" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -163,7 +163,7 @@ .RS 4 Certificate trust store path .sp Default value: /path/to/OpenDJ/config/admin\-truststore Default value: /path/to/opendj/config/admin\-truststore .RE .PP \fB\-T, \-\-trustStorePassword {trustStorePassword}\fR @@ -309,5 +309,5 @@ .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/restore.1
@@ -2,12 +2,12 @@ .\" Title: restore .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 09/28/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "RESTORE" "1" "09/28/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "RESTORE" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -219,7 +219,7 @@ .\} .nf $ restore \-p 4444 \-D "cn=Directory Manager" \-w password \-d /path/to/OpenDJ/bak \-I 20110613080032 \-t 0 \-d /path/to/opendj/bak \-I 20110613080032 \-t 0 Restore task 20110613155052932 scheduled to start Jun 13, 2011 3:50:52 PM CEST .fi .if n \{\ @@ -232,10 +232,10 @@ .RS 4 .\} .nf $ /path/to/OpenDJ/bin/stop\-ds $ /path/to/opendj/bin/stop\-ds Stopping Server\&.\&.\&. \&.\&.\&. $ /path/to/OpenDJ/bin/restore \-\-backupDirectory /path/to/OpenDJ/bak/userRoot $ /path/to/opendj/bin/restore \-\-backupDirectory /path/to/opendj/bak/userRoot \-\-listBackups Backup ID: 20120928102414Z Backup Date: 28/Sep/2012:12:24:17 +0200 @@ -246,10 +246,10 @@ Has Signed Hash: false Dependent Upon: none $ /path/to/OpenDJ/bin/restore \-\-backupDirectory /path/to/OpenDJ/bak/userRoot $ /path/to/opendj/bin/restore \-\-backupDirectory /path/to/opendj/bak/userRoot \-\-backupID 20120928102414Z [28/Sep/2012:12:26:20 +0200] \&.\&.\&. msg=Restored: 00000000\&.jdb (size 355179) $ /path/to/OpenDJ/bin/start\-ds $ /path/to/opendj/bin/start\-ds [28/Sep/2012:12:27:29 +0200] \&.\&.\&. The Directory Server has started successfully .fi .if n \{\ @@ -257,5 +257,5 @@ .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/setup.1
@@ -2,12 +2,12 @@ .\" Title: setup .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 03/21/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "SETUP" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "SETUP" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -240,11 +240,11 @@ .RS 4 .\} .nf $ \&./OpenDJ/setup \-\-cli \-b dc=example,dc=com \-d 100 \-D "cn=Directory Manager" $ \&./opendj/setup \-\-cli \-b dc=example,dc=com \-d 100 \-D "cn=Directory Manager" \-w password \-h `hostname` \-p 1389 \-\-generateSelfSignedCertificate \-\-enableStartTLS \-n OpenDJ 2\&.5\&.0 OpenDJ 2\&.6\&.0 Please wait while the setup program initializes\&.\&.\&. See /var/\&.\&.\&./opends\-setup\-484\&.\&.\&.561\&.log for a detailed log of this operation\&. @@ -255,12 +255,12 @@ Starting Directory Server \&.\&.\&.\&.\&.\&.\&.\&.\&.\&. Done\&. To see basic server configuration status and configuration you can launch /path/to/OpenDJ/bin/status /path/to/opendj/bin/status .fi .if n \{\ .RE .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/status.1
@@ -2,12 +2,12 @@ .\" Title: status .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 07/17/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "STATUS" "1" "07/17/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "STATUS" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -166,8 +166,8 @@ \-\-\- Server Details \-\-\- Host Name: localhost\&.localdomain Administrative Users: cn=Directory Manager Installation Path: /path/to/OpenDJ Version: OpenDJ 2\&.5\&.0 Installation Path: /path/to/opendj Version: OpenDJ 2\&.6\&.0 Java Version: 1\&.6\&.0_29 Administration Connector: Port 4444 (LDAPS) @@ -204,5 +204,5 @@ .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/uninstall.1
@@ -2,12 +2,12 @@ .\" Title: uninstall .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 03/21/2012 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "UNINSTALL" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "UNINSTALL" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -216,7 +216,7 @@ .RS 4 .\} .nf $ \&./OpenDJ/uninstall \-a \-\-cli \-I admin \-w password \-n $ \&./opendj/uninstall \-a \-\-cli \-I admin \-w password \-n Stopping Directory Server \&.\&.\&.\&.\&. Done\&. Deleting Files under the Installation Path \&.\&.\&.\&.\&. Done\&. @@ -224,14 +224,14 @@ The Uninstall Completed Successfully\&. To complete the uninstallation, you must delete manually the following files and directories: /path/to/OpenDJ/lib /path/to/opendj/lib See /var/\&.\&.\&./opends\-uninstall\-3\&.\&.\&.0\&.log for a detailed log of this operation\&. $ rm \-rf OpenDJ $ rm \-rf opendj .fi .if n \{\ .RE .\} .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man1/upgrade.1
@@ -2,12 +2,12 @@ .\" Title: upgrade .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 03/21/2012 .\" Date: 05/17/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "UPGRADE" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "UPGRADE" "1" "05/17/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,61 +28,141 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" upgrade \- upgrade OpenDJ directory server upgrade \- upgrade OpenDJ configuration & application data .SH "SYNOPSIS" .HP \w'\fBupgrade\fR\ 'u \fBupgrade\fR {options} .SH "DESCRIPTION" .PP This utility can be used to upgrade the directory server to a newer version or revert to a previous version\&. This 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\&. .PP When using this tool to upgrade the server you should first downloaded an OpenDJ install package (\&.zip) file and specify its location using the \-f/\-\-file option\&. You can also upgrade your server using the Java Web Start version of this tool by visiting the OpenDJ web site at www\&.forgerock\&.org/opendj\&.html\&. The \fBupgrade\fR command thus performs only part of the upgrade process, which includes the following phases for a single server\&. .sp .RS 4 .ie n \{\ \h'-04' 1.\h'+01'\c .\} .el \{\ .sp -1 .IP " 1." 4.2 .\} Get and unpack a newer version of OpenDJ directory server software\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 2.\h'+01'\c .\} .el \{\ .sp -1 .IP " 2." 4.2 .\} Stop the current OpenDJ directory server\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 3.\h'+01'\c .\} .el \{\ .sp -1 .IP " 3." 4.2 .\} Overwrite existing binary and script files with those of the newer version, and then run this utility, the \fBupgrade\fR command, before restarting OpenDJ\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 4.\h'+01'\c .\} .el \{\ .sp -1 .IP " 4." 4.2 .\} Start the upgraded OpenDJ directory server\&. .RE .if n \{\ .sp .\} .RS 4 .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBImportant\fR .ps -1 .br .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 \-r/\-\-revertMostRecent option or specify the location of a reversion archive using the \-a/\-\-reversionArchive option\&. The \fBupgrade\fR command \fIdoes not back up OpenDJ before you upgrade, nor does it restore OpenDJ if the \fR\fI\fBupgrade\fR\fR\fI command fails\fR\&. In order to revert a failed upgrade, make sure you back up OpenDJ directory server before you overwrite existing binary and script files\&. .sp .5v .RE .PP By default, the \fBupgrade\fR command requests confirmation before making important configuration changes\&. You can use the \fB\-\-no\-prompt\fR option to run the command non\-interactively\&. .PP When using the \fB\-\-no\-prompt\fR option, if the \fBupgrade\fR 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 \fB\-\-force\fR option to force a non\-interactive upgrade to continue in this case, also performing long running and critical tasks\&. .PP After upgrading, see the resulting upgrade\&.log file for a full list of operations performed\&. .SH "OPTIONS" .PP The following options are supported\&. .PP \fB\-a, \-\-reversionArchive {directory}\fR \fB\-\-force\fR .RS 4 Directory where reversion files are stored\&. This should be one of the child directories of the \*(Aqhistory\*(Aq directory that is created when the upgrade tool is run\&. 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 \fB\-\-no\-prompt\fR option\&. .RE .PP \fB\-f, \-\-file {file}\fR \fB\-\-ignoreErrors\fR .RS 4 Specifies an existing server package (\&.zip) file to which the current build will be upgraded using the command line version of this tool .RE .PP \fB\-r, \-\-revertMostRecent\fR .RS 4 The installation will be reverted to the state before the most recent upgrade 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\&. .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 Use non\-interactive mode\&. Prompt for any required information rather than fail\&. .RE .PP \fB\-Q, \-\-quiet\fR .RS 4 Run setup in quiet mode\&. Quiet mode will not output progress information to standard output Use quiet mode\&. .RE .PP \fB\-v, \-\-verbose\fR .RS 4 Use verbose mode Use verbose mode\&. .RE .SS "General Options" .PP \fB\-V, \-\-version\fR .RS 4 Display version information Display version information\&. .RE .PP \fB\-?, \-H, \-\-help\fR .RS 4 Display usage information Display usage information\&. .RE .SH "EXIT CODES" .PP @@ -91,45 +171,84 @@ The command completed successfully\&. .RE .PP > 0 2 .RS 4 The command was run in non\-interactive mode, but could not complete because confirmation was required to run a long or critical task\&. .sp See the error message or the log for details\&. .RE .PP Other .RS 4 An error occurred\&. .RE .SH "EXAMPLES" .PP The following example demonstrates upgrade without interaction\&. The following example shows the upgrade process for OpenDJ directory server installed from the cross\-platform (\&.zip) delivery\&. .sp .if n \{\ .RS 4 .\} .nf $ \&./OpenDJ/upgrade \-f ~/Downloads/OpenDJ\-2\&.5\&.0\&.zip \-n See /var/\&.\&.\&./opends\-upgrade\-5650414945123366149\&.log for a detailed log of this operation\&. $ 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\-2\&.6\&.0\&.zip $ cp \-r opendj/* OpenDJ\-2\&.4\&.6/ $ rm \-rf opendj $ mv OpenDJ\-2\&.4\&.6 opendj $ \&./opendj/upgrade \-\-no\-prompt 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 /path/to/OpenDJ/history/log for a detailed installation history\&. QuickUpgrade Completed Successfully\&. The OpenDJ installation at /path/to/OpenDJ has now been upgraded to version OpenDJ 2\&.5\&.0 (Build ID: YYYYMMDDhhmmssZ)\&. >>>> OpenDJ Upgrade Utility See /var/\&.\&.\&./opends\-upgrade\-5650414945123366149\&.log for a detailed log of this operation\&. * OpenDJ will be upgraded from version 2\&.4\&.6\&.8102 to 2\&.6\&.0\&.\fIrevision\fR * See \*(Aq/path/to/opendj/upgrade\&.log\*(Aq for a detailed log of this operation >>>> Preparing to upgrade OpenDJ 2\&.6\&.0 modified the default configuration of the \*(AqisMemberOf\*(Aq 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 \*(Aqnested\*(Aq 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 \*(Aqetag\*(Aq virtual attribute schema\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% Configuring \*(Aqetag\*(Aq virtual attribute\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% Configuring \*(Aqds\-pwp\-password\-expiration\-time\*(Aq virtual attribute\&.\&.\&.\&.\&. 100% Updating certificate syntax configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% Updating JPEG syntax configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% Updating country string syntax configuration\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% Modifying filter in \*(AqisMemberOf\*(Aq 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 \*(Aq02\-config\&.ldif\*(Aq\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% Archiving concatenated schema\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\&. 100% >>>> OpenDJ was successfully upgraded from version 2\&.4\&.6\&.8102 to 2\&.6\&.0\&.\fIrevision\fR * See \*(Aq/path/to/opendj/upgrade\&.log\*(Aq for a detailed log of this operation $ \&./opendj/bin/start\-ds \-\-quiet $ .fi .if n \{\ .RE .\} .PP 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)\&. .SH "COPYRIGHT" .br Copyright \(co 2011-2012 ForgeRock AS Copyright \(co 2011-2013 ForgeRock AS .br opends/resource/man/man5/make-ldif.template.5
@@ -2,12 +2,12 @@ .\" Title: make-ldif.template .\" Author: .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: 03/26/2013 .\" Date: 05/16/2013 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Source: OpenDJ 2.6.0 .\" Language: English .\" .TH "MAKE\-LDIF\&.TEMPLAT" "5" "03/26/2013" "OpenDJ 2\&.5\&.0" "Tools Reference" .TH "MAKE\-LDIF\&.TEMPLAT" "5" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -187,7 +187,7 @@ or sequential\&. For the file argument, either you specify an absolute path to the file such as <file:/path/to/myDescriptions>, or you specify a path relative to the /path/to/OpenDJ/config/MakeLDIF/ /path/to/opendj/config/MakeLDIF/ directory such as <file:streets>\&. For the second argument, if you specify sequential @@ -197,7 +197,7 @@ <First> .RS 4 The first name tag gets replaced by a random line from /path/to/OpenDJ/config/MakeLDIF/first\&.names\&. Combinations of generated first and last names are unique, with integers appended to the name strings if not enough combinations are available\&. /path/to/opendj/config/MakeLDIF/first\&.names\&. Combinations of generated first and last names are unique, with integers appended to the name strings if not enough combinations are available\&. .RE .PP <GUID> @@ -223,7 +223,7 @@ <Last> .RS 4 The last name tag gets replaced by a random line from /path/to/OpenDJ/config/MakeLDIF/last\&.names\&. Combinations of generated first and last names are unique, with integers appended to the name strings if not enough combinations are available\&. /path/to/opendj/config/MakeLDIF/last\&.names\&. Combinations of generated first and last names are unique, with integers appended to the name strings if not enough combinations are available\&. .RE .PP <List> @@ -531,7 +531,7 @@ .SH "SEE ALSO" .PP \m[blue]\fB\fBmake-ldif\fR(1)\fR\m[], /path/to/OpenDJ/config/MakeLDIF/example\&.template /path/to/opendj/config/MakeLDIF/example\&.template .SH "COPYRIGHT" .br Copyright \(co 2012-2013 ForgeRock AS
