Name

dsframework — manage OpenDJ administration framework

Synopsis

dsframework
subcommand {options}

Description

This utility can be used to perform operations in the directory server administration framework.

This utility has no interactive mode. Consider using -X if you authenticate over a secure connection protected with a self-signed certificate.

Subcommands

The dsconfig command provides many subcommands. Use the following options to view help for subcommands.

--help-all

Display all subcommands

--help-admin-user

Display subcommands relating to admin-user

--help-server

Display subcommands relating to server

--help-server-group

Display subcommands relating to server-group

For help with individual subcommands, use dsframework subcommand --help.

Options

The following options are supported.

LDAP Connection Options

--connectTimeout {timeout}

Maximum length of time (in milliseconds) that can be taken to establish a connection. Use '0' to specify no time out.

Default value: 30000

-h, --hostname {host}

Directory server hostname or IP address

Default value: localhost.localdomain

-I, --adminUID {adminUID}

User 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: admin

-j, --adminPasswordFile {bindPasswordFile}

Global administrator password file

-K, --keyStorePath {keyStorePath}

Certificate key store path

-N, --certNickname {nickname}

Nickname of certificate for SSL client authentication

-o, --saslOption {name=value}

SASL bind options

-p, --port {port}

Directory server administration port number

Default value: 4444

-P, --trustStorePath {trustStorePath}

Certificate trust store path

Default value: /path/to/opendj/config/admin-truststore

-T, --trustStorePassword {trustStorePassword}

Certificate trust store PIN

-u, --keyStorePasswordFile {keyStorePasswordFile}

Certificate key store PIN file

-U, --trustStorePasswordFile {path}

Certificate trust store PIN file

-w, --adminPassword {bindPassword}

Password for the global administrator

-W, --keyStorePassword {keyStorePassword}

Certificate key store PIN

-X, --trustAll

Trust all server SSL certificates

Utility Input/Output Options

--noPropertiesFile

No properties file will be used to get default command line argument values

--propertiesFilePath {propertiesFilePath}

Path to the file containing default property values used for command line arguments

-v, --verbose

Use verbose mode

General Options

-V, --version

Display version information

-?, -H, --help

Display usage information

Exit Codes

0

The command completed successfully.

> 0

An error occurred.

Examples

This 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