t
Title: dsconfig
Author:
Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
Date: 08/19/2014
Manual: Tools Reference
Source: OpenDJ 3.0.0-SNAPSHOT
Language: English

"DSCONFIG" "1" "08/19/2014" "OpenDJ 3.0.0-SNAPSHOT" "Tools Reference"
-----------------------------------------------------------------
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
"NAME"
dsconfig - manage OpenDJ directory server configuration
"SYNOPSIS"

\w'dsconfig [subcommand] 'u dsconfig [subcommand] [options]

"DESCRIPTION"

This utility serves to configure a running directory server.

The dsconfig command is the primary command-line tool for viewing and editing OpenDJ configuration. When started without arguments, dsconfig prompts you for administration connection information, including the host name, administration port number, administrator bind DN and administrator password. The dsconfig command then connects securely to the directory server over the administration port. Once connected it presents you with a menu-driven interface to the server configuration.

When you pass connection information, subcommands, and additional options to dsconfig, the command runs in script mode and so is not interactive, though it can prompt you to ask whether to apply changes and whether to trust certificates (unless you use the --no-prompt and --trustAll options, respectively).

You can prepare dsconfig batch scripts by running the tool with the --commandFilePath option in interactive mode, then reading from the batch file with the --batchFile option in script mode. Batch files can be useful when you have many dsconfig commands to run and want to avoid starting the JVM and setting up a new connection for each command.

The dsconfig command categorizes directory server configuration into components, also called managed objects. Actual components often inherit from a parent component type. For example, one component is a Connection Handler. An LDAP Connection Handler is a type of Connection Handler. You configure the LDAP Connection Handler component to specify how OpenDJ directory server handles LDAP connections coming from client applications.

Configuration components have properties. For example, the LDAP Connection Handler component has properties such as listen-port and allow-start-tls. You can set the component\*(Aqs listen-port property to 389 to use the default LDAP port number. You can set the component\*(Aqs allow-start-tls property to true to permit LDAP client applications to use StartTLS. Much of the configuration you do with dsconfig involves setting component properties. The \m[blue]OpenDJ Configuration Reference\m[] covers all dsconfig component properties in detail, drawing on the documentation you also view when getting help through the dsconfig command.

"GETTING HELP"

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

See dsconfig Subcommands for details of individual subcommands.

dsconfig --help-all

Display all subcommands

dsconfig --help-core-server

Display subcommands relating to core server

dsconfig --help-database

Display subcommands relating to caching and back-ends

dsconfig --help-logging

Display subcommands relating to logging

dsconfig --help-replication

Display subcommands relating to replication

dsconfig --help-security

Display subcommands relating to authentication and authorization

dsconfig --help-user-management

Display subcommands relating to user management

For help with individual subcommands, either use dsconfig subcommand --help, or start dsconfig in interactive mode, without specifying a subcommand.

To view component properties, use the dsconfig list-properties command.

"GENERALLY APPLICABLE OPTIONS"

The following options are supported for all dsconfig subcommands.

--advanced

Allows the configuration of advanced components and properties

"LDAP Connection Options"

--connectTimeout {timeout}

Maximum length of time (in milliseconds) that can be taken to establish a connection. Use \*(Aq0\*(Aq 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"

--commandFilePath {path}

The full path to the file where the equivalent non-interactive commands will be written when this command is run in interactive mode.

--displayCommand

Display the equivalent non-interactive option on standard output when this command is run in interactive mode.

-F, --batchFilePath {batchFilePath}

Path to a batch file containing a set of dsconfig commands to be executed

-n, --no-prompt

Use non-interactive mode. If data in the command is missing, the user is not prompted and the command exits with an error.

--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

-Q, --quiet

Do not write progress information to standard output

-s, --script-friendly

Use script-friendly mode

-v, --verbose

Use verbose mode

"General Options"

--version

Display version information

-?, -H, --help

Display usage information

"DSCONFIG SUBCOMMANDS"

This section covers individual dsconfig subcommands.

Subcommands let you create, list, and delete entire configuration components, and also let you get and set component properties. Subcommands therefore have names that reflect these five actions.

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} create-component

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} list-components

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} delete-component

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} get-component-prop

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} set-component-prop

Here, component names correspond to the names of managed object types referred to as \m[blue]Components\m[] in the OpenDJ Configuration Reference, and that have no parent components. (In other words, only the names of components with no parents correspond to subcommands.) Subcommand component names are lower-case, hyphenated versions of the friendly names used in the OpenDJ Configuration Reference. When you act on an actual configuration component, you provide the name of the component as an option argument.

For example, the Log Publisher component has these corresponding subcommands.

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} create-log-publisher

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} list-log-publishers

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} delete-log-publisher

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} get-log-publisher-prop

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} set-log-publisher-prop

When you create or delete Log Publisher components and when you get and set their configuration properties, you provide the name of the actual log publisher, which you can find by using the list-log-publishers subcommand.

.\} 

$ dsconfig \e
 list-log-publishers \e
 --hostname opendj.example.com \e
 --port 4444 \e
 --bindDN "cn=Directory Manager" \e
 --bindPassword password \e
 --trustAll

Log Publisher : Type : enabled
------------------------------:------------------------:--------
File-Based Access Logger : file-based-access : true
File-Based Audit Logger : file-based-audit : false
File-Based Debug Logger : file-based-debug : false
File-Based Error Logger : file-based-error : true
File-Based HTTP Access Logger : file-based-http-access : false
Replication Repair Logger : file-based-error : true

$ dsconfig \e
 get-log-publisher-prop \e
 --publisher-name "File-Based Access Logger" \e
 --property rotation-policy \e
 --hostname opendj.example.com \e
 --port 4444 \e
 --bindDN "cn=Directory Manager" \e
 --bindPassword password \e
 --trustAll
Property : Value(s)
----------------:--------------------------------------------------------------
rotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation
 : Policy
.\}

To find documentation for specific component properties, also see the \m[blue]OpenDJ Configuration Reference\m[].

Many subcommands let you set property values. Notice in the reference for the subcommands below that specific options are available for handling multi-valued properties. Whereas you can assign a single property value using the --set option, you assign multiple values to a multi-valued property using the --add option. You can reset the values of the multi-valued property using the --reset option.

Some property values take a time duration. Durations are expressed as numbers followed by units. For example 1 s means one second, and 2 w means two weeks. Some durations have minimum granularity or maximum units, so you cannot necessary specify every duration in milliseconds or weeks for example. Some durations allow you to use a special value to mean unlimited. Units are specified as follows.

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} ms: milliseconds

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} s: seconds

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} m: minutes

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} h: hours

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} d: days

\h'-04'\(bu\h'+03'\c .\}

\(bu 2.3
.\} w: weeks
"dsconfig create-access-log-filtering-criteria"

Creates Access Log Filtering Criteria

--publisher-name {name}

The name of the Access Log Publisher

--criteria-name {name}

The name of the new Access Log Filtering Criteria

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Access Log Filtering Criteria which should be created (Default: generic). The value for TYPE can be one of: generic

"dsconfig create-account-status-notification-handler"

Creates Account Status Notification Handlers

--handler-name {name}

The name of the new Account Status Notification Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Account Status Notification Handler which should be created. The value for TYPE can be one of: custom | error-log | smtp

"dsconfig create-alert-handler"

Creates Alert Handlers

--handler-name {name}

The name of the new Alert Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Alert Handler which should be created. The value for TYPE can be one of: custom | jmx | smtp

"dsconfig create-attribute-syntax"

Creates Attribute Syntaxes

--syntax-name {name}

The name of the new Attribute Syntax

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Attribute Syntax which should be created (Default: generic). The value for TYPE can be one of: attribute-type-description | certificate | country-string | directory-string | generic | jpeg | telephone-number

"dsconfig create-backend"

Creates Backends

--backend-name {STRING}

The name of the new Backend which will also be used as the value of the "backend-id" property: Specifies a name to identify the associated backend.

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Backend which should be created. The value for TYPE can be one of: backup | config-file-handler | custom | ldif | local-db | memory | monitor | null | schema | task | trust-store

"dsconfig create-certificate-mapper"

Creates Certificate Mappers

--mapper-name {name}

The name of the new Certificate Mapper

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Certificate Mapper which should be created. The value for TYPE can be one of: custom | fingerprint | subject-attribute-to-user-attribute | subject-dn-to-user-attribute | subject-equals-dn

"dsconfig create-connection-handler"

Creates Connection Handlers

--handler-name {name}

The name of the new Connection Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Connection Handler which should be created. The value for TYPE can be one of: custom | http | jmx | ldap | ldif | snmp

"dsconfig create-debug-target"

Creates Debug Targets

--publisher-name {name}

The name of the Debug Log Publisher

--target-name {STRING}

The name of the new Debug Target which will also be used as the value of the "debug-scope" property: Specifies the fully-qualified OpenDJ Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp).

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Debug Target which should be created (Default: generic). The value for TYPE can be one of: generic

"dsconfig create-entry-cache"

Creates Entry Caches

--cache-name {name}

The name of the new Entry Cache

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Entry Cache which should be created. The value for TYPE can be one of: custom | fifo | file-system | soft-reference

"dsconfig create-extended-operation-handler"

Creates Extended Operation Handlers

--handler-name {name}

The name of the new Extended Operation Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Extended Operation Handler which should be created. The value for TYPE can be one of: cancel | custom | get-connection-id | get-symmetric-key | password-modify | password-policy-state | start-tls | who-am-i

"dsconfig create-group-implementation"

Creates Group Implementations

--implementation-name {name}

The name of the new Group Implementation

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Group Implementation which should be created. The value for TYPE can be one of: custom | dynamic | static | virtual-static

"dsconfig create-identity-mapper"

Creates Identity Mappers

--mapper-name {name}

The name of the new Identity Mapper

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Identity Mapper which should be created. The value for TYPE can be one of: custom | exact-match | regular-expression

"dsconfig create-key-manager-provider"

Creates Key Manager Providers

--provider-name {name}

The name of the new Key Manager Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Key Manager Provider which should be created. The value for TYPE can be one of: custom | file-based | pkcs11

"dsconfig create-local-db-index"

Creates Local DB Indexes

--backend-name {name}

The name of the Local DB Backend

--index-name {OID}

The name of the new Local DB Index which will also be used as the value of the "attribute" property: Specifies the name of the attribute for which the index is to be maintained.

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Local DB Index which should be created (Default: generic). The value for TYPE can be one of: generic

"dsconfig create-local-db-vlv-index"

Creates Local DB VLV Indexes

--backend-name {name}

The name of the Local DB Backend

--index-name {STRING}

The name of the new Local DB VLV Index which will also be used as the value of the "name" property: Specifies a unique name for this VLV index.

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Local DB VLV Index which should be created (Default: generic). The value for TYPE can be one of: generic

"dsconfig create-log-publisher"

Creates Log Publishers

--publisher-name {name}

The name of the new Log Publisher

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Log Publisher which should be created. The value for TYPE can be one of: custom-access | custom-debug | custom-error | custom-http-access | file-based-access | file-based-audit | file-based-debug | file-based-error | file-based-http-access

"dsconfig create-log-retention-policy"

Creates Log Retention Policies

--policy-name {name}

The name of the new Log Retention Policy

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Log Retention Policy which should be created. The value for TYPE can be one of: custom | file-count | free-disk-space | size-limit

"dsconfig create-log-rotation-policy"

Creates Log Rotation Policies

--policy-name {name}

The name of the new Log Rotation Policy

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Log Rotation Policy which should be created. The value for TYPE can be one of: custom | fixed-time | size-limit | time-limit

"dsconfig create-matching-rule"

Creates Matching Rules

--rule-name {name}

The name of the new Matching Rule

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Matching Rule which should be created (Default: generic). The value for TYPE can be one of: collation | generic

"dsconfig create-monitor-provider"

Creates Monitor Providers

--provider-name {name}

The name of the new Monitor Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Monitor Provider which should be created. The value for TYPE can be one of: client-connection | custom | entry-cache | memory-usage | stack-trace | system-info | version

"dsconfig create-password-generator"

Creates Password Generators

--generator-name {name}

The name of the new Password Generator

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Password Generator which should be created. The value for TYPE can be one of: custom | random

"dsconfig create-password-policy"

Creates Authentication Policies

--policy-name {name}

The name of the new Authentication Policy

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Authentication Policy which should be created. The value for TYPE can be one of: ldap-pass-through | password-policy

"dsconfig create-password-storage-scheme"

Creates Password Storage Schemes

--scheme-name {name}

The name of the new Password Storage Scheme

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Password Storage Scheme which should be created. The value for TYPE can be one of: aes | base64 | blowfish | clear | crypt | custom | md5 | pbkdf2 | pkcs5s2 | rc4 | salted-md5 | salted-sha1 | salted-sha256 | salted-sha384 | salted-sha512 | sha1 | triple-des

"dsconfig create-password-validator"

Creates Password Validators

--validator-name {name}

The name of the new Password Validator

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Password Validator which should be created. The value for TYPE can be one of: attribute-value | character-set | custom | dictionary | length-based | repeated-characters | similarity-based | unique-characters

"dsconfig create-plugin"

Creates Plugins

--plugin-name {name}

The name of the new Plugin

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Plugin which should be created. The value for TYPE can be one of: attribute-cleanup | change-number-control | custom | entry-uuid | fractional-ldif-import | last-mod | ldap-attribute-description-list | password-policy-import | profiler | referential-integrity | samba-password | seven-bit-clean | unique-attribute

"dsconfig create-replication-domain"

Creates Replication Domains

--provider-name {name}

The name of the Replication Synchronization Provider

--domain-name {name}

The name of the new Replication Domain

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Replication Domain which should be created (Default: generic). The value for TYPE can be one of: generic

"dsconfig create-replication-server"

Creates Replication Servers

--provider-name {name}

The name of the Replication Synchronization Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Replication Server which should be created (Default: generic). The value for TYPE can be one of: generic

"dsconfig create-sasl-mechanism-handler"

Creates SASL Mechanism Handlers

--handler-name {name}

The name of the new SASL Mechanism Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of SASL Mechanism Handler which should be created. The value for TYPE can be one of: anonymous | cram-md5 | custom | digest-md5 | external | gssapi | plain

"dsconfig create-synchronization-provider"

Creates Synchronization Providers

--provider-name {name}

The name of the new Synchronization Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Synchronization Provider which should be created. The value for TYPE can be one of: custom | replication

"dsconfig create-trust-manager-provider"

Creates Trust Manager Providers

--provider-name {name}

The name of the new Trust Manager Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Trust Manager Provider which should be created. The value for TYPE can be one of: blind | custom | file-based

"dsconfig create-virtual-attribute"

Creates Virtual Attributes

--name {name}

The name of the new Virtual Attribute

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

-t | --type {type}

The type of Virtual Attribute which should be created. The value for TYPE can be one of: collective-attribute-subentries | custom | entity-tag | entry-dn | entry-uuid | governing-structure-rule | has-subordinates | is-member-of | member | num-subordinates | password-expiration-time | password-policy-subentry | structural-object-class | subschema-subentry | user-defined

"dsconfig delete-access-log-filtering-criteria"

Deletes Access Log Filtering Criteria

--publisher-name {name}

The name of the Access Log Publisher

--criteria-name {name}

The name of the Access Log Filtering Criteria

-f | --force

Ignore non-existent Access Log Filtering Criteria

"dsconfig delete-account-status-notification-handler"

Deletes Account Status Notification Handlers

--handler-name {name}

The name of the Account Status Notification Handler

-f | --force

Ignore non-existent Account Status Notification Handlers

"dsconfig delete-alert-handler"

Deletes Alert Handlers

--handler-name {name}

The name of the Alert Handler

-f | --force

Ignore non-existent Alert Handlers

"dsconfig delete-attribute-syntax"

Deletes Attribute Syntaxes

--syntax-name {name}

The name of the Attribute Syntax

-f | --force

Ignore non-existent Attribute Syntaxes

"dsconfig delete-backend"

Deletes Backends

--backend-name {name}

The name of the Backend

-f | --force

Ignore non-existent Backends

"dsconfig delete-certificate-mapper"

Deletes Certificate Mappers

--mapper-name {name}

The name of the Certificate Mapper

-f | --force

Ignore non-existent Certificate Mappers

"dsconfig delete-connection-handler"

Deletes Connection Handlers

--handler-name {name}

The name of the Connection Handler

-f | --force

Ignore non-existent Connection Handlers

"dsconfig delete-debug-target"

Deletes Debug Targets

--publisher-name {name}

The name of the Debug Log Publisher

--target-name {name}

The name of the Debug Target

-f | --force

Ignore non-existent Debug Targets

"dsconfig delete-entry-cache"

Deletes Entry Caches

--cache-name {name}

The name of the Entry Cache

-f | --force

Ignore non-existent Entry Caches

"dsconfig delete-extended-operation-handler"

Deletes Extended Operation Handlers

--handler-name {name}

The name of the Extended Operation Handler

-f | --force

Ignore non-existent Extended Operation Handlers

"dsconfig delete-group-implementation"

Deletes Group Implementations

--implementation-name {name}

The name of the Group Implementation

-f | --force

Ignore non-existent Group Implementations

"dsconfig delete-identity-mapper"

Deletes Identity Mappers

--mapper-name {name}

The name of the Identity Mapper

-f | --force

Ignore non-existent Identity Mappers

"dsconfig delete-key-manager-provider"

Deletes Key Manager Providers

--provider-name {name}

The name of the Key Manager Provider

-f | --force

Ignore non-existent Key Manager Providers

"dsconfig delete-local-db-index"

Deletes Local DB Indexes

--backend-name {name}

The name of the Local DB Backend

--index-name {name}

The name of the Local DB Index

-f | --force

Ignore non-existent Local DB Indexes

"dsconfig delete-local-db-vlv-index"

Deletes Local DB VLV Indexes

--backend-name {name}

The name of the Local DB Backend

--index-name {name}

The name of the Local DB VLV Index

-f | --force

Ignore non-existent Local DB VLV Indexes

"dsconfig delete-log-publisher"

Deletes Log Publishers

--publisher-name {name}

The name of the Log Publisher

-f | --force

Ignore non-existent Log Publishers

"dsconfig delete-log-retention-policy"

Deletes Log Retention Policies

--policy-name {name}

The name of the Log Retention Policy

-f | --force

Ignore non-existent Log Retention Policies

"dsconfig delete-log-rotation-policy"

Deletes Log Rotation Policies

--policy-name {name}

The name of the Log Rotation Policy

-f | --force

Ignore non-existent Log Rotation Policies

"dsconfig delete-matching-rule"

Deletes Matching Rules

--rule-name {name}

The name of the Matching Rule

-f | --force

Ignore non-existent Matching Rules

"dsconfig delete-monitor-provider"

Deletes Monitor Providers

--provider-name {name}

The name of the Monitor Provider

-f | --force

Ignore non-existent Monitor Providers

"dsconfig delete-password-generator"

Deletes Password Generators

--generator-name {name}

The name of the Password Generator

-f | --force

Ignore non-existent Password Generators

"dsconfig delete-password-policy"

Deletes Authentication Policies

--policy-name {name}

The name of the Authentication Policy

-f | --force

Ignore non-existent Authentication Policies

"dsconfig delete-password-storage-scheme"

Deletes Password Storage Schemes

--scheme-name {name}

The name of the Password Storage Scheme

-f | --force

Ignore non-existent Password Storage Schemes

"dsconfig delete-password-validator"

Deletes Password Validators

--validator-name {name}

The name of the Password Validator

-f | --force

Ignore non-existent Password Validators

"dsconfig delete-plugin"

Deletes Plugins

--plugin-name {name}

The name of the Plugin

-f | --force

Ignore non-existent Plugins

"dsconfig delete-replication-domain"

Deletes Replication Domains

--provider-name {name}

The name of the Replication Synchronization Provider

--domain-name {name}

The name of the Replication Domain

-f | --force

Ignore non-existent Replication Domains

"dsconfig delete-replication-server"

Deletes Replication Servers

--provider-name {name}

The name of the Replication Synchronization Provider

-f | --force

Ignore non-existent Replication Servers

"dsconfig delete-sasl-mechanism-handler"

Deletes SASL Mechanism Handlers

--handler-name {name}

The name of the SASL Mechanism Handler

-f | --force

Ignore non-existent SASL Mechanism Handlers

"dsconfig delete-synchronization-provider"

Deletes Synchronization Providers

--provider-name {name}

The name of the Synchronization Provider

-f | --force

Ignore non-existent Synchronization Providers

"dsconfig delete-trust-manager-provider"

Deletes Trust Manager Providers

--provider-name {name}

The name of the Trust Manager Provider

-f | --force

Ignore non-existent Trust Manager Providers

"dsconfig delete-virtual-attribute"

Deletes Virtual Attributes

--name {name}

The name of the Virtual Attribute

-f | --force

Ignore non-existent Virtual Attributes

"dsconfig get-access-control-handler-prop"

Shows Access Control Handler properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-access-log-filtering-criteria-prop"

Shows Access Log Filtering Criteria properties

--publisher-name {name}

The name of the Access Log Publisher

--criteria-name {name}

The name of the Access Log Filtering Criteria

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-account-status-notification-handler-prop"

Shows Account Status Notification Handler properties

--handler-name {name}

The name of the Account Status Notification Handler

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-administration-connector-prop"

Shows Administration Connector properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-alert-handler-prop"

Shows Alert Handler properties

--handler-name {name}

The name of the Alert Handler

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-attribute-syntax-prop"

Shows Attribute Syntax properties

--syntax-name {name}

The name of the Attribute Syntax

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-backend-prop"

Shows Backend properties

--backend-name {name}

The name of the Backend

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-certificate-mapper-prop"

Shows Certificate Mapper properties

--mapper-name {name}

The name of the Certificate Mapper

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-connection-handler-prop"

Shows Connection Handler properties

--handler-name {name}

The name of the Connection Handler

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-crypto-manager-prop"

Shows Crypto Manager properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-debug-target-prop"

Shows Debug Target properties

--publisher-name {name}

The name of the Debug Log Publisher

--target-name {name}

The name of the Debug Target

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-entry-cache-prop"

Shows Entry Cache properties

--cache-name {name}

The name of the Entry Cache

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-extended-operation-handler-prop"

Shows Extended Operation Handler properties

--handler-name {name}

The name of the Extended Operation Handler

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-external-changelog-domain-prop"

Shows External Changelog Domain properties

--provider-name {name}

The name of the Replication Synchronization Provider

--domain-name {name}

The name of the Replication Domain

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-global-configuration-prop"

Shows Global Configuration properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-group-implementation-prop"

Shows Group Implementation properties

--implementation-name {name}

The name of the Group Implementation

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-identity-mapper-prop"

Shows Identity Mapper properties

--mapper-name {name}

The name of the Identity Mapper

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-key-manager-provider-prop"

Shows Key Manager Provider properties

--provider-name {name}

The name of the Key Manager Provider

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-local-db-index-prop"

Shows Local DB Index properties

--backend-name {name}

The name of the Local DB Backend

--index-name {name}

The name of the Local DB Index

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-local-db-vlv-index-prop"

Shows Local DB VLV Index properties

--backend-name {name}

The name of the Local DB Backend

--index-name {name}

The name of the Local DB VLV Index

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-log-publisher-prop"

Shows Log Publisher properties

--publisher-name {name}

The name of the Log Publisher

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-log-retention-policy-prop"

Shows Log Retention Policy properties

--policy-name {name}

The name of the Log Retention Policy

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-log-rotation-policy-prop"

Shows Log Rotation Policy properties

--policy-name {name}

The name of the Log Rotation Policy

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-matching-rule-prop"

Shows Matching Rule properties

--rule-name {name}

The name of the Matching Rule

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-monitor-provider-prop"

Shows Monitor Provider properties

--provider-name {name}

The name of the Monitor Provider

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-password-generator-prop"

Shows Password Generator properties

--generator-name {name}

The name of the Password Generator

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-password-policy-prop"

Shows Authentication Policy properties

--policy-name {name}

The name of the Authentication Policy

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-password-storage-scheme-prop"

Shows Password Storage Scheme properties

--scheme-name {name}

The name of the Password Storage Scheme

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-password-validator-prop"

Shows Password Validator properties

--validator-name {name}

The name of the Password Validator

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-plugin-prop"

Shows Plugin properties

--plugin-name {name}

The name of the Plugin

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-plugin-root-prop"

Shows Plugin Root properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-replication-domain-prop"

Shows Replication Domain properties

--provider-name {name}

The name of the Replication Synchronization Provider

--domain-name {name}

The name of the Replication Domain

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-replication-server-prop"

Shows Replication Server properties

--provider-name {name}

The name of the Replication Synchronization Provider

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-root-dn-prop"

Shows Root DN properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-root-dse-backend-prop"

Shows Root DSE Backend properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-sasl-mechanism-handler-prop"

Shows SASL Mechanism Handler properties

--handler-name {name}

The name of the SASL Mechanism Handler

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-synchronization-provider-prop"

Shows Synchronization Provider properties

--provider-name {name}

The name of the Synchronization Provider

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-trust-manager-provider-prop"

Shows Trust Manager Provider properties

--provider-name {name}

The name of the Trust Manager Provider

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-virtual-attribute-prop"

Shows Virtual Attribute properties

--name {name}

The name of the Virtual Attribute

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig get-work-queue-prop"

Shows Work Queue properties

--property {property}

The name of a property to be displayed

-E | --record

Modifies the display output to show one property value per line

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-access-log-filtering-criteria"

Lists existing Access Log Filtering Criteria

--publisher-name {name}

The name of the Access Log Publisher

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-account-status-notification-handlers"

Lists existing Account Status Notification Handlers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-alert-handlers"

Lists existing Alert Handlers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-attribute-syntaxes"

Lists existing Attribute Syntaxes

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-backends"

Lists existing Backends

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-certificate-mappers"

Lists existing Certificate Mappers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-connection-handlers"

Lists existing Connection Handlers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-debug-targets"

Lists existing Debug Targets

--publisher-name {name}

The name of the Debug Log Publisher

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-entry-caches"

Lists existing Entry Caches

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-extended-operation-handlers"

Lists existing Extended Operation Handlers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-group-implementations"

Lists existing Group Implementations

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-identity-mappers"

Lists existing Identity Mappers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-key-manager-providers"

Lists existing Key Manager Providers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-local-db-indexes"

Lists existing Local DB Indexes

--backend-name {name}

The name of the Local DB Backend

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-local-db-vlv-indexes"

Lists existing Local DB VLV Indexes

--backend-name {name}

The name of the Local DB Backend

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-log-publishers"

Lists existing Log Publishers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-log-retention-policies"

Lists existing Log Retention Policies

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-log-rotation-policies"

Lists existing Log Rotation Policies

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-matching-rules"

Lists existing Matching Rules

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-monitor-providers"

Lists existing Monitor Providers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-password-generators"

Lists existing Password Generators

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-password-policies"

Lists existing Password Policies

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-password-storage-schemes"

Lists existing Password Storage Schemes

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-password-validators"

Lists existing Password Validators

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-plugins"

Lists existing Plugins

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-properties"

Describes managed objects and their properties

-c | --category {category}

The category of components whose properties should be described

-t | --type {type}

The type of components whose properties should be described. The value for TYPE must be one of the component types associated with the CATEGORY specified using the "--category" option

--inherited

Modifies the display output to show the inherited properties of components

--property {property}

The name of a property to be displayed

"dsconfig list-replication-domains"

Lists existing Replication Domains

--provider-name {name}

The name of the Replication Synchronization Provider

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-replication-server"

Lists existing Replication Server

--provider-name {name}

The name of the Replication Synchronization Provider

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-sasl-mechanism-handlers"

Lists existing SASL Mechanism Handlers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-synchronization-providers"

Lists existing Synchronization Providers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-trust-manager-providers"

Lists existing Trust Manager Providers

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig list-virtual-attributes"

Lists existing Virtual Attributes

--property {property}

The name of a property to be displayed

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)

"dsconfig set-access-control-handler-prop"

Modifies Access Control Handler properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-access-log-filtering-criteria-prop"

Modifies Access Log Filtering Criteria properties

--publisher-name {name}

The name of the Access Log Publisher

--criteria-name {name}

The name of the Access Log Filtering Criteria

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-account-status-notification-handler-prop"

Modifies Account Status Notification Handler properties

--handler-name {name}

The name of the Account Status Notification Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-administration-connector-prop"

Modifies Administration Connector properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-alert-handler-prop"

Modifies Alert Handler properties

--handler-name {name}

The name of the Alert Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-attribute-syntax-prop"

Modifies Attribute Syntax properties

--syntax-name {name}

The name of the Attribute Syntax

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-backend-prop"

Modifies Backend properties

--backend-name {name}

The name of the Backend

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-certificate-mapper-prop"

Modifies Certificate Mapper properties

--mapper-name {name}

The name of the Certificate Mapper

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-connection-handler-prop"

Modifies Connection Handler properties

--handler-name {name}

The name of the Connection Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-crypto-manager-prop"

Modifies Crypto Manager properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-debug-target-prop"

Modifies Debug Target properties

--publisher-name {name}

The name of the Debug Log Publisher

--target-name {name}

The name of the Debug Target

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-entry-cache-prop"

Modifies Entry Cache properties

--cache-name {name}

The name of the Entry Cache

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-extended-operation-handler-prop"

Modifies Extended Operation Handler properties

--handler-name {name}

The name of the Extended Operation Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-external-changelog-domain-prop"

Modifies External Changelog Domain properties

--provider-name {name}

The name of the Replication Synchronization Provider

--domain-name {name}

The name of the Replication Domain

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-global-configuration-prop"

Modifies Global Configuration properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-group-implementation-prop"

Modifies Group Implementation properties

--implementation-name {name}

The name of the Group Implementation

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-identity-mapper-prop"

Modifies Identity Mapper properties

--mapper-name {name}

The name of the Identity Mapper

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-key-manager-provider-prop"

Modifies Key Manager Provider properties

--provider-name {name}

The name of the Key Manager Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-local-db-index-prop"

Modifies Local DB Index properties

--backend-name {name}

The name of the Local DB Backend

--index-name {name}

The name of the Local DB Index

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-local-db-vlv-index-prop"

Modifies Local DB VLV Index properties

--backend-name {name}

The name of the Local DB Backend

--index-name {name}

The name of the Local DB VLV Index

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-log-publisher-prop"

Modifies Log Publisher properties

--publisher-name {name}

The name of the Log Publisher

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-log-retention-policy-prop"

Modifies Log Retention Policy properties

--policy-name {name}

The name of the Log Retention Policy

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-log-rotation-policy-prop"

Modifies Log Rotation Policy properties

--policy-name {name}

The name of the Log Rotation Policy

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-matching-rule-prop"

Modifies Matching Rule properties

--rule-name {name}

The name of the Matching Rule

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-monitor-provider-prop"

Modifies Monitor Provider properties

--provider-name {name}

The name of the Monitor Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-password-generator-prop"

Modifies Password Generator properties

--generator-name {name}

The name of the Password Generator

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-password-policy-prop"

Modifies Authentication Policy properties

--policy-name {name}

The name of the Authentication Policy

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-password-storage-scheme-prop"

Modifies Password Storage Scheme properties

--scheme-name {name}

The name of the Password Storage Scheme

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-password-validator-prop"

Modifies Password Validator properties

--validator-name {name}

The name of the Password Validator

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-plugin-prop"

Modifies Plugin properties

--plugin-name {name}

The name of the Plugin

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-plugin-root-prop"

Modifies Plugin Root properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-replication-domain-prop"

Modifies Replication Domain properties

--provider-name {name}

The name of the Replication Synchronization Provider

--domain-name {name}

The name of the Replication Domain

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-replication-server-prop"

Modifies Replication Server properties

--provider-name {name}

The name of the Replication Synchronization Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-root-dn-prop"

Modifies Root DN properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-root-dse-backend-prop"

Modifies Root DSE Backend properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-sasl-mechanism-handler-prop"

Modifies SASL Mechanism Handler properties

--handler-name {name}

The name of the SASL Mechanism Handler

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-synchronization-provider-prop"

Modifies Synchronization Provider properties

--provider-name {name}

The name of the Synchronization Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-trust-manager-provider-prop"

Modifies Trust Manager Provider properties

--provider-name {name}

The name of the Trust Manager Provider

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-virtual-attribute-prop"

Modifies Virtual Attribute properties

--name {name}

The name of the Virtual Attribute

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"dsconfig set-work-queue-prop"

Modifies Work Queue properties

--set {PROP:VALUE}

Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed

"EXIT CODES"

0

The command completed successfully.

> 0

An error occurred.

"EXAMPLES"

Much of the OpenDJ Administration Guide consists of dsconfig examples with text in between. This section therefore remains short.

The following example starts dsconfig in interactive, menu-driven mode on the default port of the current host.

.\} 

$ dsconfig -h opendj.example.com -p 4444 -D "cn=Directory Manager" -w password

>>>> OpenDJ configuration console main menu

What do you want to configure?

 1) Access Control Handler 21) Log Publisher
 2) Access Log Filtering Criteria 22) Log Retention Policy
 3) Account Status Notification Handler 23) Log Rotation Policy
 4) Administration Connector 24) Matching Rule
 5) Alert Handler 25) Monitor Provider
 6) Attribute Syntax 26) Password Generator
 7) Backend 27) Password Policy
 8) Certificate Mapper 28) Password Storage Scheme
 9) Connection Handler 29) Password Validator
 10) Crypto Manager 30) Plugin
 11) Debug Target 31) Plugin Root
 12) Entry Cache 32) Replication Domain
 13) Extended Operation Handler 33) Replication Server
 14) External Changelog Domain 34) Root DN
 15) Global Configuration 35) Root DSE Backend
 16) Group Implementation 36) SASL Mechanism Handler
 17) Identity Mapper 37) Synchronization Provider
 18) Key Manager Provider 38) Trust Manager Provider
 19) Local DB Index 39) Virtual Attribute
 20) Local DB VLV Index 40) Work Queue

 q) quit

Enter choice:
.\}

The following examples demonstrates generating a batch file that corresponds to an interactive session enabling the debug log. The example then demonstrates using a modified batch file to disable the debug log.

.\} 

$ dsconfig \e
 --hostname opendj.example.com \e
 --port 4444 \e
 --bindDN "cn=Directory Manager" \e
 --bindPassword password \e
 --commandFilePath ~/enable-debug-log.batch
 ...
$ cat ~/enable-debug-log.batch
# dsconfig session start date: 19/Oct/2011:08:52:22 +0000

# Session operation number: 1
# Operation date: 19/Oct/2011:08:55:06 +0000
dsconfig set-log-publisher-prop \e
 --publisher-name File-Based\e Debug\e Logger \e
 --set enabled:true \e
 --hostname opendj.example.com \e
 --port 4444 \e
 --trustStorePath /path/to/opendj/config/admin-truststore \e
 --bindDN cn=Directory\e Manager \e
 --bindPassword ****** \e
 --no-prompt

$ cp ~/enable-debug-log.batch ~/disable-debug-log.batch
$ vi ~/disable-debug-log.batch
$ cat ~/disable-debug-log.batch
set-log-publisher-prop \e
 --publisher-name File-Based\e Debug\e Logger \e
 --set enabled:false \e
 --hostname opendj.example.com \e
 --port 4444 \e
 --trustStorePath /path/to/opendj/config/admin-truststore \e
 --bindDN cn=Directory\e Manager \e
 --bindPassword password \e
 --no-prompt

$ dsconfig --batchFilePath ~/disable-debug-log.batch --no-prompt
set-log-publisher-prop
--publisher-name
File-Based Debug Logger
--set
enabled:false
--hostname
opendj.example.com
--port
4444
--trustStorePath
/path/to/opendj/config/admin-truststore
--bindDN
cn=Directory Manager
--bindPassword
password
--no-prompt

$
.\}

Notice that the original command file looks like a shell script with the bind password value replaced by asterisks. To pass the content as a batch file to dsconfig, strip dsconfig itself, and include the bind password for the administrative user (or replace that option with an alternative, such as reading the password from a file).

"COPYRIGHT"

Copyright \(co 2011-2014 ForgeRock AS