2011-2013ForgeRock ASdsframework1OpenDJdsframeworkmanage OpenDJ administration frameworkdsframeworksubcommandoptionsDescriptionThis utility can be used to perform operations in the directory server
administration framework.This utility has no interactive mode. Consider using
if you authenticate over a secure connection protected with a self-signed
certificate.SubcommandsThe dsconfig command provides many subcommands.
Use the following options to view help for subcommands.Display all subcommandsDisplay subcommands relating to admin-userDisplay subcommands relating to serverDisplay subcommands relating to server-groupFor help with individual subcommands, use dsframework
subcommand --help.OptionsThe following options are supported.LDAP Connection OptionsMaximum length of time (in milliseconds) that can be taken to
establish a connection. Use '0' to specify no time out.Default value: 30000Directory server hostname or IP addressDefault value: localhost.localdomainUser ID of the global administrator to use to bind to the server.
For the enable subcommand, if no global administrator
was defined previously for any servers, the global administrator will be
created using the UID provided.Default value: adminGlobal administrator password file Certificate key store pathNickname of certificate for SSL client authenticationSASL bind optionsDirectory server administration port numberDefault value: 4444Certificate trust store pathDefault value: /path/to/opendj/config/admin-truststoreCertificate trust store PINCertificate key store PIN fileCertificate trust store PIN filePassword for the global administratorCertificate key store PINTrust all server SSL certificatesUtility Input/Output OptionsNo properties file will be used to get default command line
argument valuesPath to the file containing default property values used for
command line argumentsUse verbose modeGeneral OptionsDisplay version informationDisplay usage informationExit Codes0The command completed successfully.> 0An error occurred.ExamplesThis example lists server properties.
$ dsframework -p 4444 -h opendj.example.com -D "cn=Directory Manager"
-w password -X list-server-properties
Option Types:
r -- Property value(s) are readable
w -- Property value(s) are writable
m -- The property is mandatory
s -- The property is single-valued
Property Options Syntax Default value
-------------------------------------------------------------------------
ldapsport rw-- INTEGER -
certificate rw-s STRING -
hostname r-ms STRING localhost
ldapport rwm- INTEGER 389
jmxsEnabled rw-s BOOLEAN false
instancepath rw-s STRING -
ldapsEnabled rw-s BOOLEAN false
jmxsport rw-- INTEGER -
os rw-s STRING -
ds-cfg-key-id rw-s STRING -
jmxport rw-- INTEGER -
description rw-s STRING -
id rw-s STRING -
startTLSEnabled rw-s BOOLEAN false
jmxEnabled rw-s BOOLEAN false
ds-cfg-public-key-certificate rw-s CERTIFICATE_BINARY -
location rw-s STRING -
ldapEnabled rw-s BOOLEAN false