mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opendj-sdk/opends/resource/man/man1/dsreplication.1
@@ -1,540 +1,337 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems Inc. All .\" Rights Reserved. .TH dsreplication 1 "December 2008" "1.1" "User Commands" .SH NAME dsreplication \- configures replication between directory servers so that the data of the servers is synchronized .SH SYNOPSIS .LP '\" t .\" Title: dsreplication .\" Author: Mark Craig .\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: October\ \&20,\ \&2011 .\" Manual: Tools Reference .\" Source: OpenDJ 2.5.0 .\" Language: English .\" .TH "DSREPLICATION" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" dsreplication \- manage OpenDJ directory data replication .SH "SYNOPSIS" .HP \w'\fBdsreplication\fR\fB\fIsubcommand\fR\fR\ 'u \fBdsreplication\fR\fB\fIsubcommand\fR\fR [options] .SH "DESCRIPTION" .PP This utility can be used to configure replication between servers so that the data of the servers is synchronized\&. For replication to work you must first enable replication using the \fBenable\fR subcommand and then initialize the contents of one of the servers with the contents of the other using the \fBinitialize\fR subcommand\&. .SH "SUBCOMMANDS" .PP The following subcommands are supported\&. .PP \fBdisable\fR .RS 4 Disable replication on the specified server for the provided base DN and removes references in the other servers with which it is replicating data\&. .RE .PP \fBenable\fR .RS 4 Update the configuration of the servers to replicate the data under the specified base DN\&. If one of the specified servers is already replicating the data under the base DN with other servers, executing this subcommand will update the configuration of all the servers\&. Thus it is sufficient to execute the command line once for each server added to the replication topology\&. .RE .PP \fBinitialize\fR .RS 4 Initialize the contents of the data under the specified base DN on the destination server with the contents on the source server\&. This operation is required after enabling replication in order replication to work\&. \fBinitialize\-all\fR can also be used for this purpose\&. .RE .PP \fBinitialize\-all\fR .RS 4 Initialize the contents of the data under the specified base DN on all the servers whose contents are being replicated with the contents on the specified server\&. This operation is required after enabling replication for replication to work\&. Run \fBinitialize\fR for each server to achieve the same effect\&. .RE .PP \fBpost\-external\-initialization\fR .RS 4 This subcommand must be called after initializing the contents of all the replicated servers using the \fBimport\-ldif\fR command, or by copying the database\&. You must specify the list of base DNs that have been initialized, and you must provide the credentials of any of the servers that are being replicated\&. See \fBpre\-external\-initialization \-\-help\fR for more information\&. .RE .PP \fBpre\-external\-initialization\fR .RS 4 This subcommand must be called before initializing the contents of all the replicated servers using the \fBimport\-ldif\fR command, or by copying the database\&. You must specify the list of base DNs that have been initialized, and you must provide the credentials of any of the servers that are being replicated\&. After calling this subcommand, initialize the contents of all the servers in the topology, either by using the same LDIF file or by copying the database to each of the servers, then call the \fBpost\-external\-initialization\fR subcommand\&. .RE .PP \fBpurge\-historical\fR .RS 4 Launch a purge processing of the historical information stored in the user entries by replication\&. Since this processing may take a while, you must specify a maximum duration\&. .RE .PP \fBstatus\fR .RS 4 Display a list with the basic replication configuration of the base DNs of the servers defined in the registration information\&. If no base DNs are specified as parameter, information for all base DNs is displayed\&. .RE .SH "OPTIONS" .PP The following options are supported\&. .PP \fB\-\-advanced\fR .RS 4 Access advanced settings when running this command in interactive mode\&. .RE .PP \fB\-b, \-\-baseDN {baseDN}\fR .RS 4 Base DN of the data to be replicated, initialized or for which you want to disable replication\&. Multiple base DNs can be provided by using this option multiple times\&. .RE .SS "LDAP Connection Options" .PP \fB\-\-connectTimeout {timeout}\fR .RS 4 Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&. .sp Default value: 30000 .RE .PP \fB\-h, \-\-hostname {host}\fR .RS 4 Directory server hostname or IP address .sp Default value: localhost\&.localdomain .RE .PP \fB\-I, \-\-adminUID {adminUID}\fR .RS 4 User ID of the global administrator to use to bind to the server\&. For the \fBenable\fR subcommand, if no global administrator was defined previously for any servers, the global administrator will be created using the UID provided\&. .sp Default value: admin .RE .PP \fB\-j, \-\-adminPasswordFile {bindPasswordFile}\fR .RS 4 Global administrator password file .RE .PP \fB\-K, \-\-keyStorePath {keyStorePath}\fR .RS 4 Certificate key store path .RE .PP \fB\-N, \-\-certNickname {nickname}\fR .RS 4 Nickname of certificate for SSL client authentication .RE .PP \fB\-o, \-\-saslOption {name=value}\fR .RS 4 SASL bind options .RE .PP \fB\-p, \-\-port {port}\fR .RS 4 Directory server administration port number .sp Default value: 4444 .RE .PP \fB\-P, \-\-trustStorePath {trustStorePath}\fR .RS 4 Certificate trust store path .sp Default value: /path/to/OpenDJ/config/admin\-truststore .RE .PP \fB\-T, \-\-trustStorePassword {trustStorePassword}\fR .RS 4 Certificate trust store PIN .RE .PP \fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR .RS 4 Certificate key store PIN file .RE .PP \fB\-U, \-\-trustStorePasswordFile {path}\fR .RS 4 Certificate trust store PIN file .RE .PP \fB\-w, \-\-adminPassword {bindPassword}\fR .RS 4 Password for the global administrator .RE .PP \fB\-W, \-\-keyStorePassword {keyStorePassword}\fR .RS 4 Certificate key store PIN .RE .PP \fB\-X, \-\-trustAll\fR .RS 4 Trust all server SSL certificates .RE .SS "Utility Input/Output Options" .PP \fB\-\-commandFilePath {path}\fR .RS 4 The full path to the file where the equivalent non\-interactive commands will be written when this command is run in interactive mode\&. .RE .PP \fB\-\-displayCommand\fR .RS 4 Display the equivalent non\-interactive option on standard output when this command is run in interactive mode\&. .RE .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 command exits with an error\&. .RE .PP \fB\-\-noPropertiesFile\fR .RS 4 No properties file will be used to get default command line argument values .RE .PP \fB\-\-propertiesFilePath {propertiesFilePath}\fR .RS 4 Path to the file containing default property values used for command line arguments .RE .PP \fB\-Q, \-\-quiet\fR .RS 4 Do not write progress information to standard output .RE .SS "General Options" .PP \fB\-\-version\fR .RS 4 Display version information .RE .PP \fB\-?, \-H, \-\-help\fR .RS 4 Display usage information .RE .SH "EXIT CODES" .PP 0 .RS 4 The command completed successfully\&. .RE .PP > 0 .RS 4 An error occurred\&. .RE .SH "EXAMPLES" .PP The following example enables and then initializes replication for a new replica whose admin port is 5444 from an existing replica whose admin port is 4444\&. .sp .if n \{\ .RS 4 .\} .nf \fBdsreplication\fR \fIsubcommand\fR \fIoptions\fR $ dsreplication enable \-I admin \-w password \-X \-n \-b dc=example,dc=com \-\-host1 `hostname` \-\-port1 4444 \-\-bindDN1 "cn=Directory Manager" \-\-bindPassword1 password \-\-replicationPort1 8989 \-\-host2 `hostname` \-\-port2 5444 \-\-bindDN2 "cn=Directory Manager" \-\-bindPassword2 password \-\-replicationPort2 9989 Establishing connections \&.\&.\&.\&.\&. Done\&. Checking registration information \&.\&.\&.\&.\&. Done\&. Updating remote references on server localhost:4444 \&.\&.\&.\&.\&. Done\&. Configuring Replication port on server localhost:5444 \&.\&.\&.\&.\&. Done\&. Updating replication configuration for baseDN dc=example,dc=com on server localhost:4444 \&.\&.\&.\&.\&. Done\&. Updating replication configuration for baseDN dc=example,dc=com on server localhost:5444 \&.\&.\&.\&.\&. Done\&. Updating registration configuration on server localhost:4444 \&.\&.\&.\&.\&. Done\&. Updating registration configuration on server localhost:5444 \&.\&.\&.\&.\&. Done\&. Updating replication configuration for baseDN cn=schema on server localhost:4444 \&.\&.\&.\&.\&. Done\&. Updating replication configuration for baseDN cn=schema on server localhost:5444 \&.\&.\&.\&.\&. Done\&. Initializing registration information on server localhost:5444 with the contents of server localhost:4444 \&.\&.\&.\&.\&. Done\&. Initializing schema on server localhost:5444 with the contents of server localhost:4444 \&.\&.\&.\&.\&. Done\&. Replication has been successfully enabled\&. Note that for replication to work you must initialize the contents of the base DN\*(Aqs that are being replicated (use dsreplication initialize to do so)\&. See /var/\&.\&.\&./opends\-replication\-7958637258600693490\&.log for a detailed log of this operation\&. $ dsreplication initialize\-all \-I admin \-w password \-X \-n \-b dc=example,dc=com \-h `hostname` \-p 4444 Initializing base DN dc=example,dc=com with the contents from localhost:4444: 160 entries processed (100 % complete)\&. Base DN initialized successfully\&. See /var/\&.\&.\&./opends\-replication\-5020375834904394170\&.log for a detailed log of this operation\&. .fi .SH DESCRIPTION .sp .LP The \fBdsreplication\fR command can be used to configure replication between directory servers so that the data of the servers is synchronized. First enable replication by using the \fBenable\fR subcommand and then initialize the contents of one directory server with the contents of another server by using the \fBinitialize\fR subcommand. .sp .LP Like the \fBdsconfig\fR command, \fBdsreplication\fR can be run in interactive mode, which walks you through the replication setup process. To run \fBdsreplication\fR in interactive mode, type the command name with no parameters. .sp .LP Run \fBdsreplication --help\fR for more information, or use the dsreplication online documentation at http://docs.opends.org/1.2/page/Dsreplication\&. .SH SUB-COMMANDS .sp .LP The following subcommands are used with the \fBdsreplication\fR command. .sp .ne 2 .mk .na \fB\fBdisable\fR\fR .ad .sp .6 .RS 4n Disable replication on the specified directory server for the specified base DN. This subcommand removes references to the specified server in the configuration of the servers with which this server is replicating data. Suboptions are as follows: .sp \fB-D, --bindDN \fIbindDN\fR\fR. The DN used to bind to the server on which replication will be disabled. This option must be used if no global administrator has been defined on the server or if you do not want to remove references in the other replicated servers. The password provided for the global administrator is used when this option is specified. .sp \fB-h, --hostname \fIhost\fR\fR. Directory server host name or IP address. .sp \fB-p, --port \fIport\fR\fR. Directory server administration port number. .if n \{\ .RE .sp .ne 2 .mk .na \fB\fBenable\fR\fR .ad .sp .6 .RS 4n Update the configuration of the directory servers to replicate data under the specified base DN. If one of the specified servers is already replicating the data under the base DN to other servers, executing this subcommand updates the configuration of all the servers. It is therefore sufficient to execute the subcommand once for each server that is added to the replication topology. Suboptions are as follows: .sp \fB--bindDN2 \fIbindDN\fR\fR. The DN used to bind to the second server whose contents will be replicated. If no bind DN is specified, the global administrator is used to bind. .sp \fB--bindPassword1 \fIbindPassword\fR\fR. The password used to bind to the first server whose contents will be replicated. If no bind DN was specified for the first server, the password of the global administrator is used to bind. .sp \fB--bindPassword2 \fIpassword\fR\fR. The password used to bind to the second server whose contents will be replicated. If no bind DN was specified for the second server, the password of the global administrator is used to bind. .sp \fB--bindPasswordFile1 \fIfilename\fR\fR \fB\fR. The file containing the password used to bind to the first server whose contents will be replicated. If no bind DN was specified for the first server, the password of the global administrator is used to bind. .sp \fB-D, --bindDN1 \fIbindDN\fR\fR. The DN used to bind to the first server whose contents will be replicated. If no bind DN is specified, the global administrator is used to bind. .sp \fB-F, --bindPasswordFile2 \fIfilename\fR\fR. The file containing the password used to bind to the second server whose contents will be replicated. If no bind DN was specified for the second server, the password of the global administrator is used to bind. .sp \fB-h, --host1 \fIhost\fR\fR. Host name or IP address of the first server whose contents will be replicated. .sp \fB--noSchemaReplication\fR. Do not replicate the schema between the servers. Note that schema replication is enabled by default. Use this option if you do not want the schema to be synchronized between servers. .sp \fB-O, --host2 \fIhost\fR\fR. Hostname or IP address of the second server whose contents will be replicated. .sp \fB-p, --port1 \fIport\fR\fR. Directory server administration port number of the first server whose contents will be replicated. .sp \fB--port2 \fIport\fR\fR. Directory server administration port number of the second server whose contents will be replicated. .sp \fB-r, --replicationPort1 \fIport\fR\fR. The port that will be used by the replication mechanism in the first directory server to communicate with other servers. Only specify this option if replication was not previously configured on the first directory server. .sp \fB-R, --replicationPort2 \fIport\fR\fR. The port that will be used by the replication mechanism in the second directory server to communicate with other servers. Only specify this option if replication was not previously configured in the second server. .sp \fB-S, --skipPortCheck\fR. Skip the check to determine whether the specified replication ports are usable. If this argument is not specified, the server checks that the port is available only if you are configuring the local host. .sp \fB--secureReplication1\fR. Specifies whether communication through the replication port of the first server is encrypted. This option is only taken into account the first time replication is configured on the first server. .sp \fB--secureReplication2\fR. Specifies whether communication through the replication port of the second server is encrypted. This option is only taken into account the first time replication is configured on the second server. .sp \fB--useSecondServerAsSchemaSource\fR. Use the second server to initialize the schema of the first server. If neither this option nor the \fB--noSchemaReplication\fR option is specified, the schema of the first server is used to initialize the schema of the second server. .\} .SH "AUTHORS" .PP \fBMark Craig\fR .RS 4 Author. .RE .sp .ne 2 .mk .na \fB\fBinitialize\fR\fR .ad .sp .6 .RS 4n Initialize the contents of the data under the specified base DN on the destination directory server with the contents on the source server. This operation is required after enabling replication. Suboptions are as follows: .sp \fB-h, --hostSource \fIhost\fR\fR. Directory server host name or IP address of the source server whose contents will be used to initialize the destination server. .sp \fB-O, --hostDestination \fIhost\fR\fR \fBhost\fR. Directory server hostname or IP address of the destination server whose contents will be initialized. .sp \fB-p, --portSource\fR \fBport\fR. Directory server administration port number of the source server whose contents will be used to initialize the destination server. .sp \fB--portDestination\fR \fBport\fR. Directory server administration port number of the destination server whose contents will be initialized. .PP \fBNemanja Lukić\fR .RS 4 Author. .RE .SH "COPYRIGHT" .br Copyright \(co 2011 ForgeRock AS .br .sp .ne 2 .mk .na \fB\fBinitialize-all\fR\fR .ad .sp .6 .RS 4n Initialize the data under the specified base DN, on all the directory servers in the topology, with the data on the specified server. This operation is required after enabling replication for replication to work. Alternatively, you can use the \fBinitialize\fR sub-command on each individual server in the topology. Suboptions are as follows: .sp \fB-h, --hostname \fIhost\fR\fR. Directory server host name or IP address of the source server. .sp \fB-p, --port \fIport\fR\fR. Directory server administration port number of the source server. .RS 4 [IMAGE] .PP This work is licensed under the \m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[]. .RE .PP To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA. .PP Trademarks are the property of their respective owners. .PP UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. .PP EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. .sp .ne 2 .mk .na \fB\fBpost-external-initialization\fR\fR .ad .sp .6 .RS 4n Enable replication to work after the entire topology has been reinitialized by using \fBimport-ldif\fR or binary copy. This subcommand must be called after you initialize the contents of all directory servers in a topology by using \fBimport-ldif\fR or binary copy. If you do not run this subcommand, replication will no longer work after the initialization. Suboptions are as follows: .sp \fB-h, --hostname \fIhost\fR\fR. Directory server host name or IP address. .sp \fB-p, --port \fIport\fR\fR. Directory server administration port number. .RE .sp .ne 2 .mk .na \fB\fBpre-external-initialization\fR\fR .ad .sp .6 .RS 4n Prepare a replication topology for initialization by using \fBimport-ldif\fR or binary copy. This subcommand must be called before you initialize the contents of all directory servers in a topology by using \fBimport-ldif\fR or binary copy. If you do not run this subcommand, replication will no longer work after the initialization. After running this subcommand, initialize the contents of all the servers in the topology, then run the subcommand \fBpost-external-initialization\fR. Suboptions are as follows: .sp \fB-h, --hostname \fIhost\fR\fR. Directory server host name or IP address. .sp \fB-l, --local-only\fR. Use this option when the contents of only the specified directory server will be initialized with an external method. .sp \fB-p, --port \fIport\fR\fR. Directory server administration port number. .RE .sp .ne 2 .mk .na \fB\fBstatus\fR\fR .ad .sp .6 .RS 4n List the replication configuration for the specified base DNs of all directory servers defined in the registration information. If no base DNs are specified, the information for all base DNs is displayed. Suboptions are as follows: .sp \fB-h, --hostname \fIhost\fR\fR. Directory server host name or IP address. .sp \fB-p, --port \fIport\fR\fR. Directory server administration port number. .sp \fB-s, --script-friendly\fR. Display the status in a format that can be parsed by a script. .RE .SH OPTIONS .sp .LP The following global options are supported: .sp .ne 2 .mk .na \fB\fB-b, --baseDN \fIbaseDN\fR\fR\fR .ad .sp .6 .RS 4n Specify the base DN of the data to be replicated or initialized, or for which replication should be disabled. Multiple base DNs can be specified by using this option multiple times. .RE .sp .ne 2 .mk .na \fB\fB-j, --adminPasswordFile \fIfilename\fR\fR\fR .ad .sp .6 .RS 4n Use the global administrator password in the specified file when authenticating to the directory server. This option must not be used in conjunction with \fB--adminPassword\fR. .RE .sp .ne 2 .mk .na \fB\fB-w, --adminPassword \fIpassword\fR\fR\fR .ad .sp .6 .RS 4n Use the global administrator password when authenticating to the directory server. .RE .sp .LP The following LDAP connection options are supported: .sp .ne 2 .mk .na \fB\fB-I, --adminUID \fIUID\fR\fR\fR .ad .sp .6 .RS 4n Specify the User ID of the global administrator to bind to the server. If no global administrator was defined previously for any of the servers, this option creates a global administrator by using the data provided. .RE .sp .ne 2 .mk .na \fB\fB-K, --keyStorePath \fIpath\fR\fR\fR .ad .sp .6 .RS 4n Use the client keystore certificate in the specified path. .RE .sp .ne 2 .mk .na \fB\fB-N, --certNickname \fInickname\fR\fR\fR .ad .sp .6 .RS 4n Use the specified certificate for authentication. .RE .sp .ne 2 .mk .na \fB\fB-o, --saslOption \fIname\fR=\fIvalue\fR\fR\fR .ad .sp .6 .RS 4n Use the specified options for SASL authentication. .RE .sp .ne 2 .mk .na \fB\fB-P, --trustStorePath \fIpath\fR\fR\fR .ad .sp .6 .RS 4n Use the client trust store certificate in the specified path. This option is not needed if \fB--trustAll\fR is used, although a trust store should be used when working in a production environment. .RE .sp .ne 2 .mk .na \fB\fB-T, --trustStorePassword \fIpassword\fR\fR\fR .ad .sp .6 .RS 4n Use the password needed to access the certificates in the client trust store. This option is only required if \fB--trustStorePath\fR is used and the specified trust store requires a password in order to access its contents (which most trust stores do not require). This option must not be used in conjunction with \fB--trustStorePasswordFile\fR. .RE .sp .ne 2 .mk .na \fB\fB-u, --keyStorePasswordFile \fIfilename\fR\fR\fR .ad .sp .6 .RS 4n Use the password in the specified file to access the certificates in the client keystore. This option is only required if \fB--keyStorePath\fR is used. This option must not be used in conjunction with \fB--keyStorePassword\fR. .RE .sp .ne 2 .mk .na \fB\fB-U, --TrustStorePasswordFile \fIfilename\fR\fR\fR .ad .sp .6 .RS 4n Use the password in the specified file to access the certificates in the client trust store. This option is only required if \fB--trustStorePath\fR is used and the specified trust store requires a password in order to access its contents (most trust stores do not require this). This option must not be used in conjunction with \fB--trustStorePassword\fR. .RE .sp .ne 2 .mk .na \fB\fB-W, --keyStorePassword \fIpassword\fR\fR\fR .ad .sp .6 .RS 4n Use the password needed to access the certificates in the client keystore. This option is only required if \fB--keyStorePath\fR is used. This option must not be used in conjunction with \fB--keyStorePasswordFile\fR. .RE .sp .ne 2 .mk .na \fB\fB-X, --trustAll\fR\fR .ad .sp .6 .RS 4n Trust any certificate that the directory server might present during SSL or StartTLS negotiation. This option can be used for convenience and testing purposes, but for security reasons a trust store should be used to determine whether the client should accept the server certificate. .RE .sp .LP The following input/output options are supported: .sp .ne 2 .mk .na \fB\fB-n, --no-prompt\fR\fR .ad .RS 29n .rt Run in non-interactive mode. If some data in the command is missing, the user will not be prompted and the tool will fail. .RE .sp .ne 2 .mk .na \fB\fB--noPropertiesFile\fR\fR .ad .RS 29n .rt Indicate that the utility will not use a properties file to get the default command-line options. .RE .sp .ne 2 .mk .na \fB\fB--propertiesFilePath \fIpath\fR\fR\fR .ad .RS 29n .rt Specify the path to the properties file that contains the default command-line options. .RE .sp .ne 2 .mk .na \fB\fB-Q, --quiet\fR\fR .ad .RS 29n .rt Run in quiet mode. No output will be generated unless a significant error occurs during the process. .RE .sp .LP The following general options are supported: .sp .ne 2 .mk .na \fB\fB-?, -H, --help\fR\fR .ad .RS 18n .rt Display command-line usage information for the utility and exit without making any attempt to stop or restart the directory server. .RE .sp .ne 2 .mk .na \fB\fB-V, --version\fR\fR .ad .RS 18n .rt Display the version information for the directory server and exit rather than attempting to run this command. .RE .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityUncommitted .TE
