Synchronization Server Documentation Index
Command-Line Tool Reference Home

dsconfig

↓Description
↓Examples
↓Subcommands
↓Arguments

Description

View and edit the Synchronization Server configuration.

This utility offers three primary modes of operation, the interactive mode, the non-interactive mode and batch mode. The interactive mode supports viewing and editing the configuration via an intuitive, menu driven environment. Running dsconfig in interactive command-line mode provides a user-friendly, menu-driven interface for accessing and configuring the server. To start dsconfig in interactive command-line mode, simply invoke the dsconfig shell script or batch file without any arguments.

The dsconfig non-interactive command-line mode provides a simple way to make arbitrary changes to the UnboundID Synchronization Server by invoking it on the command line. If you want to use administrative scripts to automate the configuration process, then run the dsconfig command in non-interactive mode.

The dsconfig tool provides a batching mechanism that reads multiple dsconfig invocations from a file and executes them sequentially. The batch file provides advantages over standard scripting in that it minimizes LDAP connections and JVM invocations that normally occur with each dsconfig call. You can view the logs/config-audit.log file to review the configuration changes made to the UnboundID Synchronization Server and use them in the batch file.

Examples

Start dsconfig in interactive mode: 
dsconfig


Use non-interactive mode to change the amount memory used for caching database contents and to specify common parent DNs that should be compacted in the underlying database: 
dsconfig --no-prompt --bindDN uid=admin,dc=example,dc=com \
     --bindPassword password set-backend-prop --backend-name userRoot \
     --set db-cache-percent:40 \
     --add compact-common-parent-dn:ou=accts,dc=example,dc=com \
     --add compact-common-parent-dn:ou=subs,dc=example,dc=com


Use batch mode to read and execute a series of commands in a batch file: 
dsconfig --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --no-prompt --batch-file /path/to/config-batch.txt


List information about all available configuration properties for all objects with a complexity level less than or equal to 'advanced', including inherited properties: 
dsconfig list-properties --offline --advanced --inherited

For examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help

Subcommands

↓create-alert-handler
↓create-attribute-map
↓create-attribute-mapping
↓create-backend
↓create-certificate-mapper
↓create-connection-criteria
↓create-connection-handler
↓create-custom-logged-stats
↓create-debug-target
↓create-dn-map
↓create-extended-operation-handler
↓create-external-server
↓create-http-servlet-extension
↓create-identity-mapper
↓create-key-manager-provider
↓create-location
↓create-log-field-mapping
↓create-log-publisher
↓create-log-retention-policy
↓create-log-rotation-policy
↓create-monitor-provider
↓create-password-generator
↓create-password-policy
↓create-password-storage-scheme
↓create-password-validator
↓create-plugin
↓create-prefetched-metric-query
↓create-request-criteria
↓create-result-criteria
↓create-sasl-mechanism-handler
↓create-search-entry-criteria
↓create-search-reference-criteria
↓create-sync-class
↓create-sync-destination
↓create-sync-destination-plugin
↓create-sync-pipe
↓create-sync-pipe-plugin
↓create-sync-source
↓create-sync-source-plugin
↓create-trust-manager-provider
↓create-web-application-extension
↓delete-alert-handler
↓delete-attribute-map
↓delete-attribute-mapping
↓delete-backend
↓delete-certificate-mapper
↓delete-connection-criteria
↓delete-connection-handler
↓delete-custom-logged-stats
↓delete-debug-target
↓delete-dn-map
↓delete-extended-operation-handler
↓delete-external-server
↓delete-http-servlet-extension
↓delete-identity-mapper
↓delete-key-manager-provider
↓delete-location
↓delete-log-field-mapping
↓delete-log-publisher
↓delete-log-retention-policy
↓delete-log-rotation-policy
↓delete-monitor-provider
↓delete-password-generator
↓delete-password-policy
↓delete-password-storage-scheme
↓delete-password-validator
↓delete-plugin
↓delete-prefetched-metric-query
↓delete-request-criteria
↓delete-result-criteria
↓delete-sasl-mechanism-handler
↓delete-search-entry-criteria
↓delete-search-reference-criteria
↓delete-sync-class
↓delete-sync-destination
↓delete-sync-destination-plugin
↓delete-sync-pipe
↓delete-sync-pipe-plugin
↓delete-sync-source
↓delete-sync-source-plugin
↓delete-trust-manager-provider
↓delete-web-application-extension
↓get-access-control-handler-prop
↓get-alert-handler-prop
↓get-attribute-map-prop
↓get-attribute-mapping-prop
↓get-backend-prop
↓get-certificate-mapper-prop
↓get-connection-criteria-prop
↓get-connection-handler-prop
↓get-crypto-manager-prop
↓get-custom-logged-stats-prop
↓get-debug-target-prop
↓get-dn-map-prop
↓get-extended-operation-handler-prop
↓get-external-server-prop
↓get-global-configuration-prop
↓get-global-sync-configuration-prop
↓get-http-servlet-extension-prop
↓get-identity-mapper-prop
↓get-key-manager-provider-prop
↓get-ldap-sdk-debug-logger-prop
↓get-location-prop
↓get-log-field-mapping-prop
↓get-log-publisher-prop
↓get-log-retention-policy-prop
↓get-log-rotation-policy-prop
↓get-monitor-provider-prop
↓get-password-generator-prop
↓get-password-policy-prop
↓get-password-storage-scheme-prop
↓get-password-validator-prop
↓get-plugin-prop
↓get-plugin-root-prop
↓get-prefetched-metric-query-prop
↓get-request-criteria-prop
↓get-result-criteria-prop
↓get-root-dn-prop
↓get-root-dn-user-prop
↓get-root-dse-backend-prop
↓get-sasl-mechanism-handler-prop
↓get-search-entry-criteria-prop
↓get-search-reference-criteria-prop
↓get-sync-class-prop
↓get-sync-destination-plugin-prop
↓get-sync-destination-prop
↓get-sync-pipe-plugin-prop
↓get-sync-pipe-prop
↓get-sync-source-plugin-prop
↓get-sync-source-prop
↓get-trust-manager-provider-prop
↓get-web-application-extension-prop
↓get-work-queue-prop
↓list-alert-handlers
↓list-attribute-mappings
↓list-attribute-maps
↓list-backends
↓list-certificate-mappers
↓list-connection-criteria
↓list-connection-handlers
↓list-custom-logged-stats
↓list-debug-targets
↓list-dn-maps
↓list-extended-operation-handlers
↓list-external-servers
↓list-http-servlet-extensions
↓list-identity-mappers
↓list-key-manager-providers
↓list-locations
↓list-log-field-mappings
↓list-log-publishers
↓list-log-retention-policies
↓list-log-rotation-policies
↓list-monitor-providers
↓list-password-generators
↓list-password-policies
↓list-password-storage-schemes
↓list-password-validators
↓list-plugins
↓list-prefetched-metric-queries
↓list-properties
↓list-request-criteria
↓list-result-criteria
↓list-root-dn-users
↓list-sasl-mechanism-handlers
↓list-search-entry-criteria
↓list-search-reference-criteria
↓list-sync-classes
↓list-sync-destination-plugins
↓list-sync-destinations
↓list-sync-pipe-plugins
↓list-sync-pipes
↓list-sync-source-plugins
↓list-sync-sources
↓list-trust-manager-providers
↓list-web-application-extensions
↓set-access-control-handler-prop
↓set-alert-handler-prop
↓set-attribute-map-prop
↓set-attribute-mapping-prop
↓set-backend-prop
↓set-certificate-mapper-prop
↓set-connection-criteria-prop
↓set-connection-handler-prop
↓set-crypto-manager-prop
↓set-custom-logged-stats-prop
↓set-debug-target-prop
↓set-dn-map-prop
↓set-extended-operation-handler-prop
↓set-external-server-prop
↓set-global-configuration-prop
↓set-global-sync-configuration-prop
↓set-http-servlet-extension-prop
↓set-identity-mapper-prop
↓set-key-manager-provider-prop
↓set-ldap-sdk-debug-logger-prop
↓set-location-prop
↓set-log-field-mapping-prop
↓set-log-publisher-prop
↓set-log-retention-policy-prop
↓set-log-rotation-policy-prop
↓set-monitor-provider-prop
↓set-password-generator-prop
↓set-password-policy-prop
↓set-password-storage-scheme-prop
↓set-password-validator-prop
↓set-plugin-prop
↓set-plugin-root-prop
↓set-prefetched-metric-query-prop
↓set-request-criteria-prop
↓set-result-criteria-prop
↓set-root-dn-prop
↓set-root-dn-user-prop
↓set-root-dse-backend-prop
↓set-sasl-mechanism-handler-prop
↓set-search-entry-criteria-prop
↓set-search-reference-criteria-prop
↓set-sync-class-prop
↓set-sync-destination-plugin-prop
↓set-sync-destination-prop
↓set-sync-pipe-plugin-prop
↓set-sync-pipe-prop
↓set-sync-source-plugin-prop
↓set-sync-source-prop
↓set-trust-manager-provider-prop
↓set-web-application-extension-prop
↓set-work-queue-prop

create-alert-handler

Create Alert Handlers


create-alert-handler Arguments

--handler-name {name}

Description The name of the new Alert Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Alert Handler to create. The type value can be one of the following: custom | error-log | exec | groovy-scripted | jmx | smtp | snmp | snmp-sub-agent | third-party
Required No
Multi-Valued No

create-attribute-map

Create Attribute Maps


create-attribute-map Arguments

--map-name {name}

Description The name of the new Attribute Map
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-attribute-mapping

Create Attribute Mappings


create-attribute-mapping Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--mapping-name {destinationAttribute}

Description The name of the new Attribute Mapping which will also be used as the value of the 'to-attribute' property. Specifies the name of the attribute whose values are constructed by this attribute mapping.
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Attribute Mapping to create. The type value can be one of the following: constructed | direct | dn
Required No
Multi-Valued No

create-backend

Create Backends


create-backend Arguments

--backend-name {STRING}

Description 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.
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Backend to create. The type value can be one of the following: alert | backup | config-file-handler | custom | ldif | metrics | monitor | task | trust-store
Required No
Multi-Valued No

create-certificate-mapper

Create Certificate Mappers


create-certificate-mapper Arguments

--mapper-name {name}

Description The name of the new Certificate Mapper
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Certificate Mapper to create. The type value can be one of the following: custom | fingerprint | groovy-scripted | subject-attribute-to-user-attribute | subject-dn-to-user-attribute | subject-equals-dn | third-party
Required No
Multi-Valued No

create-connection-criteria

Create Connection Criteria


create-connection-criteria Arguments

--criteria-name {name}

Description The name of the new Connection Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Connection Criteria to create. The type value can be one of the following: aggregate | custom | simple
Required No
Multi-Valued No

create-connection-handler

Create Connection Handlers


create-connection-handler Arguments

--handler-name {name}

Description The name of the new Connection Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Connection Handler to create. The type value can be one of the following: custom | jmx | ldap | ldif
Required No
Multi-Valued No

create-custom-logged-stats

Create Custom Logged Stats


create-custom-logged-stats Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin
Required No
Multi-Valued No

--stats-name {name}

Description The name of the new Custom Logged Stats
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Custom Logged Stats to create. The type value can be one of the following: custom
Required No
Multi-Valued No

create-debug-target

Create Debug Targets


create-debug-target Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher
Required No
Multi-Valued No

--target-name {STRING_NAME}

Description The name of the new Debug Target which will also be used as the value of the 'debug-scope' property. Specifies the fully-qualified 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, com.unboundid.directory.server.core.DirectoryServer#startUp).
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-dn-map

Create DN Maps


create-dn-map Arguments

--map-name {name}

Description The name of the new DN Map
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-extended-operation-handler

Create Extended Operation Handlers


create-extended-operation-handler Arguments

--handler-name {name}

Description The name of the new Extended Operation Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Extended Operation Handler to create. The type value can be one of the following: administrative-session | cancel | custom | get-connection-id | get-symmetric-key | password-modify | password-policy-state | start-tls | third-party | who-am-i
Required No
Multi-Valued No

create-external-server

Create External Servers


create-external-server Arguments

--server-name {name}

Description The name of the new External Server
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of External Server to create. The type value can be one of the following: unboundid-ds | unboundid-proxy-server | active-directory | alcatel-lucent-ds | alcatel-lucent-proxy-server | jdbc | ldap | red-hat-ds | scim | smtp | sun-ds | sync-server
Required No
Multi-Valued No

create-http-servlet-extension

Create HTTP Servlet Extensions


create-http-servlet-extension Arguments

--extension-name {name}

Description The name of the new HTTP Servlet Extension
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of HTTP Servlet Extension to create. The type value can be one of the following:
Required No
Multi-Valued No

create-identity-mapper

Create Identity Mappers


create-identity-mapper Arguments

--mapper-name {name}

Description The name of the new Identity Mapper
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Identity Mapper to create. The type value can be one of the following: custom | exact-match | groovy-scripted | regular-expression | third-party
Required No
Multi-Valued No

create-key-manager-provider

Create Key Manager Providers


create-key-manager-provider Arguments

--provider-name {name}

Description The name of the new Key Manager Provider
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Key Manager Provider to create. The type value can be one of the following: custom | file-based | pkcs11 | third-party
Required No
Multi-Valued No

create-location

Create Locations


create-location Arguments

--location-name {name}

Description The name of the new Location
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-log-field-mapping

Create Log Field Mappings


create-log-field-mapping Arguments

--mapping-name {name}

Description The name of the new Log Field Mapping
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Log Field Mapping to create. The type value can be one of the following: access | error
Required No
Multi-Valued No

create-log-publisher

Create Log Publishers


create-log-publisher Arguments

--publisher-name {name}

Description The name of the new Log Publisher
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Log Publisher to create. The type value can be one of the following: admin-alert-access | custom-access | custom-debug | custom-error | custom-sync | debug-access | file-based-access | file-based-audit | file-based-debug | file-based-error | file-based-sync | groovy-scripted-access | groovy-scripted-error | groovy-scripted-file-based-access | groovy-scripted-file-based-error | sync-failed-ops | syslog-based-access | syslog-based-error | third-party-access | third-party-error | third-party-file-based-access | third-party-file-based-error
Required No
Multi-Valued No

create-log-retention-policy

Create Log Retention Policies


create-log-retention-policy Arguments

--policy-name {name}

Description The name of the new Log Retention Policy
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Log Retention Policy to create. The type value can be one of the following: custom | file-count | free-disk-space | never-delete | size-limit
Required No
Multi-Valued No

create-log-rotation-policy

Create Log Rotation Policies


create-log-rotation-policy Arguments

--policy-name {name}

Description The name of the new Log Rotation Policy
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Log Rotation Policy to create. The type value can be one of the following: custom | fixed-time | never-rotate | size-limit | time-limit
Required No
Multi-Valued No

create-monitor-provider

Create Monitor Providers


create-monitor-provider Arguments

--provider-name {name}

Description The name of the new Monitor Provider
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Monitor Provider to create. The type value can be one of the following: active-operations | client-connection | custom | disk-space-usage | host-system | memory-usage | stack-trace | system-info | third-party | version
Required No
Multi-Valued No

create-password-generator

Create Password Generators


create-password-generator Arguments

--generator-name {name}

Description The name of the new Password Generator
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Password Generator to create. The type value can be one of the following: custom | groovy-scripted | random | third-party
Required No
Multi-Valued No

create-password-policy

Create Password Policies


create-password-policy Arguments

--policy-name {name}

Description The name of the new Password Policy
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-password-storage-scheme

Create Password Storage Schemes


create-password-storage-scheme Arguments

--scheme-name {name}

Description The name of the new Password Storage Scheme
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Password Storage Scheme to create. The type value can be one of the following: aes | base64 | blowfish | clear | crypt | custom | md5 | rc4 | salted-md5 | salted-sha1 | salted-sha256 | salted-sha384 | salted-sha512 | sha1 | third-party | triple-des
Required No
Multi-Valued No

create-password-validator

Create Password Validators


create-password-validator Arguments

--validator-name {name}

Description The name of the new Password Validator
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Password Validator to create. The type value can be one of the following: attribute-value | character-set | custom | dictionary | groovy-scripted | length-based | regular-expression | repeated-characters | similarity-based | third-party | unique-characters
Required No
Multi-Valued No

create-plugin

Create Plugins


create-plugin Arguments

--plugin-name {name}

Description The name of the new Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Plugin to create. The type value can be one of the following: custom | entry-uuid | groovy-scripted | ldap-attribute-description-list | password-policy-import | periodic-stats-logger | profiler | search-shutdown | seven-bit-clean | snmp-subagent | stats-collector | third-party
Required No
Multi-Valued No

create-prefetched-metric-query

Create Prefetched Metric Queries


create-prefetched-metric-query Arguments

--query-name {name}

Description The name of the new Prefetched Metric Query
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Prefetched Metric Query to create. The type value can be one of the following:
Required No
Multi-Valued No

create-request-criteria

Create Request Criteria


create-request-criteria Arguments

--criteria-name {name}

Description The name of the new Request Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Request Criteria to create. The type value can be one of the following: aggregate | custom | simple
Required No
Multi-Valued No

create-result-criteria

Create Result Criteria


create-result-criteria Arguments

--criteria-name {name}

Description The name of the new Result Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Result Criteria to create. The type value can be one of the following: aggregate | custom | simple
Required No
Multi-Valued No

create-sasl-mechanism-handler

Create SASL Mechanism Handlers


create-sasl-mechanism-handler Arguments

--handler-name {name}

Description The name of the new SASL Mechanism Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of SASL Mechanism Handler to create. The type value can be one of the following: unboundid-certificate-plus-password | unboundid-totp | anonymous | cram-md5 | custom | digest-md5 | external | gssapi | plain | third-party
Required No
Multi-Valued No

create-search-entry-criteria

Create Search Entry Criteria


create-search-entry-criteria Arguments

--criteria-name {name}

Description The name of the new Search Entry Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Search Entry Criteria to create. The type value can be one of the following: aggregate | custom | simple
Required No
Multi-Valued No

create-search-reference-criteria

Create Search Reference Criteria


create-search-reference-criteria Arguments

--criteria-name {name}

Description The name of the new Search Reference Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Search Reference Criteria to create. The type value can be one of the following: aggregate | custom | simple
Required No
Multi-Valued No

create-sync-class

Create Sync Classes


create-sync-class Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--class-name {name}

Description The name of the new Sync Class
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-sync-destination

Create Sync Destinations


create-sync-destination Arguments

--destination-name {name}

Description The name of the new Sync Destination
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Sync Destination to create. The type value can be one of the following: unboundid | active-directory | alcatel-lucent | groovy-scripted | groovy-scripted-jdbc | scim | sun-ds | third-party | third-party-jdbc
Required No
Multi-Valued No

create-sync-destination-plugin

Create Sync Destination Plugins


create-sync-destination-plugin Arguments

--plugin-name {name}

Description The name of the new Sync Destination Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Sync Destination Plugin to create. The type value can be one of the following: groovy-scripted-ldap | third-party-ldap
Required No
Multi-Valued No

create-sync-pipe

Create Sync Pipes


create-sync-pipe Arguments

--pipe-name {name}

Description The name of the new Sync Pipe
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

create-sync-pipe-plugin

Create Sync Pipe Plugins


create-sync-pipe-plugin Arguments

--plugin-name {name}

Description The name of the new Sync Pipe Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Sync Pipe Plugin to create. The type value can be one of the following: groovy-scripted | third-party
Required No
Multi-Valued No

create-sync-source

Create Sync Sources


create-sync-source Arguments

--source-name {name}

Description The name of the new Sync Source
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Sync Source to create. The type value can be one of the following: unboundid | active-directory | alcatel-lucent | groovy-scripted | groovy-scripted-jdbc | sun-ds | third-party | third-party-jdbc
Required No
Multi-Valued No

create-sync-source-plugin

Create Sync Source Plugins


create-sync-source-plugin Arguments

--plugin-name {name}

Description The name of the new Sync Source Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Sync Source Plugin to create. The type value can be one of the following: groovy-scripted-ldap | third-party-ldap
Required No
Multi-Valued No

create-trust-manager-provider

Create Trust Manager Providers


create-trust-manager-provider Arguments

--provider-name {name}

Description The name of the new Trust Manager Provider
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Trust Manager Provider to create. The type value can be one of the following: blind | custom | file-based | third-party
Required No
Multi-Valued No

create-web-application-extension

Create Web Application Extensions


create-web-application-extension Arguments

--extension-name {name}

Description The name of the new Web Application Extension
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Web Application Extension to create. The type value can be one of the following:
Required No
Multi-Valued No

delete-alert-handler

Delete Alert Handlers


delete-alert-handler Arguments

--handler-name {name}

Description The name of the Alert Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Alert Handlers

delete-attribute-map

Delete Attribute Maps


delete-attribute-map Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Attribute Maps

delete-attribute-mapping

Delete Attribute Mappings


delete-attribute-mapping Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--mapping-name {name}

Description The name of the Attribute Mapping
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Attribute Mappings

delete-backend

Delete Backends


delete-backend Arguments

--backend-name {name}

Description The name of the Backend
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Backends

delete-certificate-mapper

Delete Certificate Mappers


delete-certificate-mapper Arguments

--mapper-name {name}

Description The name of the Certificate Mapper
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Certificate Mappers

delete-connection-criteria

Delete Connection Criteria


delete-connection-criteria Arguments

--criteria-name {name}

Description The name of the Connection Criteria
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Connection Criteria

delete-connection-handler

Delete Connection Handlers


delete-connection-handler Arguments

--handler-name {name}

Description The name of the Connection Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Connection Handlers

delete-custom-logged-stats

Delete Custom Logged Stats


delete-custom-logged-stats Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin
Required No
Multi-Valued No

--stats-name {name}

Description The name of the Custom Logged Stats
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Custom Logged Stats

delete-debug-target

Delete Debug Targets


delete-debug-target Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher
Required No
Multi-Valued No

--target-name {name}

Description The name of the Debug Target
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Debug Targets

delete-dn-map

Delete DN Maps


delete-dn-map Arguments

--map-name {name}

Description The name of the DN Map
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent DN Maps

delete-extended-operation-handler

Delete Extended Operation Handlers


delete-extended-operation-handler Arguments

--handler-name {name}

Description The name of the Extended Operation Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Extended Operation Handlers

delete-external-server

Delete External Servers


delete-external-server Arguments

--server-name {name}

Description The name of the External Server
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent External Servers

delete-http-servlet-extension

Delete HTTP Servlet Extensions


delete-http-servlet-extension Arguments

--extension-name {name}

Description The name of the HTTP Servlet Extension
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent HTTP Servlet Extensions

delete-identity-mapper

Delete Identity Mappers


delete-identity-mapper Arguments

--mapper-name {name}

Description The name of the Identity Mapper
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Identity Mappers

delete-key-manager-provider

Delete Key Manager Providers


delete-key-manager-provider Arguments

--provider-name {name}

Description The name of the Key Manager Provider
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Key Manager Providers

delete-location

Delete Locations


delete-location Arguments

--location-name {name}

Description The name of the Location
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Locations

delete-log-field-mapping

Delete Log Field Mappings


delete-log-field-mapping Arguments

--mapping-name {name}

Description The name of the Log Field Mapping
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Log Field Mappings

delete-log-publisher

Delete Log Publishers


delete-log-publisher Arguments

--publisher-name {name}

Description The name of the Log Publisher
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Log Publishers

delete-log-retention-policy

Delete Log Retention Policies


delete-log-retention-policy Arguments

--policy-name {name}

Description The name of the Log Retention Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Log Retention Policies

delete-log-rotation-policy

Delete Log Rotation Policies


delete-log-rotation-policy Arguments

--policy-name {name}

Description The name of the Log Rotation Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Log Rotation Policies

delete-monitor-provider

Delete Monitor Providers


delete-monitor-provider Arguments

--provider-name {name}

Description The name of the Monitor Provider
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Monitor Providers

delete-password-generator

Delete Password Generators


delete-password-generator Arguments

--generator-name {name}

Description The name of the Password Generator
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Password Generators

delete-password-policy

Delete Password Policies


delete-password-policy Arguments

--policy-name {name}

Description The name of the Password Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Password Policies

delete-password-storage-scheme

Delete Password Storage Schemes


delete-password-storage-scheme Arguments

--scheme-name {name}

Description The name of the Password Storage Scheme
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Password Storage Schemes

delete-password-validator

Delete Password Validators


delete-password-validator Arguments

--validator-name {name}

Description The name of the Password Validator
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Password Validators

delete-plugin

Delete Plugins


delete-plugin Arguments

--plugin-name {name}

Description The name of the Plugin
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Plugins

delete-prefetched-metric-query

Delete Prefetched Metric Queries


delete-prefetched-metric-query Arguments

--query-name {name}

Description The name of the Prefetched Metric Query
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Prefetched Metric Queries

delete-request-criteria

Delete Request Criteria


delete-request-criteria Arguments

--criteria-name {name}

Description The name of the Request Criteria
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Request Criteria

delete-result-criteria

Delete Result Criteria


delete-result-criteria Arguments

--criteria-name {name}

Description The name of the Result Criteria
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Result Criteria

delete-sasl-mechanism-handler

Delete SASL Mechanism Handlers


delete-sasl-mechanism-handler Arguments

--handler-name {name}

Description The name of the SASL Mechanism Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent SASL Mechanism Handlers

delete-search-entry-criteria

Delete Search Entry Criteria


delete-search-entry-criteria Arguments

--criteria-name {name}

Description The name of the Search Entry Criteria
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Search Entry Criteria

delete-search-reference-criteria

Delete Search Reference Criteria


delete-search-reference-criteria Arguments

--criteria-name {name}

Description The name of the Search Reference Criteria
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Search Reference Criteria

delete-sync-class

Delete Sync Classes


delete-sync-class Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--class-name {name}

Description The name of the Sync Class
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Classes

delete-sync-destination

Delete Sync Destinations


delete-sync-destination Arguments

--destination-name {name}

Description The name of the Sync Destination
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Destinations

delete-sync-destination-plugin

Delete Sync Destination Plugins


delete-sync-destination-plugin Arguments

--plugin-name {name}

Description The name of the Sync Destination Plugin
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Destination Plugins

delete-sync-pipe

Delete Sync Pipes


delete-sync-pipe Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Pipes

delete-sync-pipe-plugin

Delete Sync Pipe Plugins


delete-sync-pipe-plugin Arguments

--plugin-name {name}

Description The name of the Sync Pipe Plugin
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Pipe Plugins

delete-sync-source

Delete Sync Sources


delete-sync-source Arguments

--source-name {name}

Description The name of the Sync Source
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Sources

delete-sync-source-plugin

Delete Sync Source Plugins


delete-sync-source-plugin Arguments

--plugin-name {name}

Description The name of the Sync Source Plugin
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Sync Source Plugins

delete-trust-manager-provider

Delete Trust Manager Providers


delete-trust-manager-provider Arguments

--provider-name {name}

Description The name of the Trust Manager Provider
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Trust Manager Providers

delete-web-application-extension

Delete Web Application Extensions


delete-web-application-extension Arguments

--extension-name {name}

Description The name of the Web Application Extension
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Web Application Extensions

get-access-control-handler-prop

Show Access Control Handler properties


get-access-control-handler-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-alert-handler-prop

Show Alert Handler properties


get-alert-handler-prop Arguments

--handler-name {name}

Description The name of the Alert Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-attribute-map-prop

Show Attribute Map properties


get-attribute-map-prop Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-attribute-mapping-prop

Show Attribute Mapping properties


get-attribute-mapping-prop Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--mapping-name {name}

Description The name of the Attribute Mapping
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-backend-prop

Show Backend properties


get-backend-prop Arguments

--backend-name {name}

Description The name of the Backend
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-certificate-mapper-prop

Show Certificate Mapper properties


get-certificate-mapper-prop Arguments

--mapper-name {name}

Description The name of the Certificate Mapper
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-connection-criteria-prop

Show Connection Criteria properties


get-connection-criteria-prop Arguments

--criteria-name {name}

Description The name of the Connection Criteria
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-connection-handler-prop

Show Connection Handler properties


get-connection-handler-prop Arguments

--handler-name {name}

Description The name of the Connection Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-crypto-manager-prop

Show Crypto Manager properties


get-crypto-manager-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Crypto Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-custom-logged-stats-prop

Show Custom Logged Stats properties


get-custom-logged-stats-prop Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin
Required No
Multi-Valued No

--stats-name {name}

Description The name of the Custom Logged Stats
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-debug-target-prop

Show Debug Target properties


get-debug-target-prop Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher
Required No
Multi-Valued No

--target-name {name}

Description The name of the Debug Target
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-dn-map-prop

Show DN Map properties


get-dn-map-prop Arguments

--map-name {name}

Description The name of the DN Map
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-extended-operation-handler-prop

Show Extended Operation Handler properties


get-extended-operation-handler-prop Arguments

--handler-name {name}

Description The name of the Extended Operation Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-external-server-prop

Show External Server properties


get-external-server-prop Arguments

--server-name {name}

Description The name of the External Server
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-global-configuration-prop

Show Global Configuration properties


get-global-configuration-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Global Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-global-sync-configuration-prop

Show Global Sync Configuration properties


get-global-sync-configuration-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Global Sync Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-http-servlet-extension-prop

Show HTTP Servlet Extension properties


get-http-servlet-extension-prop Arguments

--extension-name {name}

Description The name of the HTTP Servlet Extension
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-identity-mapper-prop

Show Identity Mapper properties


get-identity-mapper-prop Arguments

--mapper-name {name}

Description The name of the Identity Mapper
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-key-manager-provider-prop

Show Key Manager Provider properties


get-key-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Key Manager Provider
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-ldap-sdk-debug-logger-prop

Show LDAP SDK Debug Logger properties


get-ldap-sdk-debug-logger-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-location-prop

Show Location properties


get-location-prop Arguments

--location-name {name}

Description The name of the Location
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-log-field-mapping-prop

Show Log Field Mapping properties


get-log-field-mapping-prop Arguments

--mapping-name {name}

Description The name of the Log Field Mapping
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-log-publisher-prop

Show Log Publisher properties


get-log-publisher-prop Arguments

--publisher-name {name}

Description The name of the Log Publisher
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-log-retention-policy-prop

Show Log Retention Policy properties


get-log-retention-policy-prop Arguments

--policy-name {name}

Description The name of the Log Retention Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-log-rotation-policy-prop

Show Log Rotation Policy properties


get-log-rotation-policy-prop Arguments

--policy-name {name}

Description The name of the Log Rotation Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-monitor-provider-prop

Show Monitor Provider properties


get-monitor-provider-prop Arguments

--provider-name {name}

Description The name of the Monitor Provider
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-password-generator-prop

Show Password Generator properties


get-password-generator-prop Arguments

--generator-name {name}

Description The name of the Password Generator
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-password-policy-prop

Show Password Policy properties


get-password-policy-prop Arguments

--policy-name {name}

Description The name of the Password Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-password-storage-scheme-prop

Show Password Storage Scheme properties


get-password-storage-scheme-prop Arguments

--scheme-name {name}

Description The name of the Password Storage Scheme
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-password-validator-prop

Show Password Validator properties


get-password-validator-prop Arguments

--validator-name {name}

Description The name of the Password Validator
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-plugin-prop

Show Plugin properties


get-plugin-prop Arguments

--plugin-name {name}

Description The name of the Plugin
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-plugin-root-prop

Show Plugin Root properties


get-plugin-root-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Plugin Root in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-prefetched-metric-query-prop

Show Prefetched Metric Query properties


get-prefetched-metric-query-prop Arguments

--query-name {name}

Description The name of the Prefetched Metric Query
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-request-criteria-prop

Show Request Criteria properties


get-request-criteria-prop Arguments

--criteria-name {name}

Description The name of the Request Criteria
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-result-criteria-prop

Show Result Criteria properties


get-result-criteria-prop Arguments

--criteria-name {name}

Description The name of the Result Criteria
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-root-dn-prop

Show Root DN properties


get-root-dn-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Root DN in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-root-dn-user-prop

Show Root DN User properties


get-root-dn-user-prop Arguments

--user-name {name}

Description The name of the Root DN User
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Root DN User in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-root-dse-backend-prop

Show Root DSE Backend properties


get-root-dse-backend-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Root DSE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sasl-mechanism-handler-prop

Show SASL Mechanism Handler properties


get-sasl-mechanism-handler-prop Arguments

--handler-name {name}

Description The name of the SASL Mechanism Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-search-entry-criteria-prop

Show Search Entry Criteria properties


get-search-entry-criteria-prop Arguments

--criteria-name {name}

Description The name of the Search Entry Criteria
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-search-reference-criteria-prop

Show Search Reference Criteria properties


get-search-reference-criteria-prop Arguments

--criteria-name {name}

Description The name of the Search Reference Criteria
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-class-prop

Show Sync Class properties


get-sync-class-prop Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--class-name {name}

Description The name of the Sync Class
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-destination-plugin-prop

Show Sync Destination Plugin properties


get-sync-destination-plugin-prop Arguments

--plugin-name {name}

Description The name of the Sync Destination Plugin
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-destination-prop

Show Sync Destination properties


get-sync-destination-prop Arguments

--destination-name {name}

Description The name of the Sync Destination
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-pipe-plugin-prop

Show Sync Pipe Plugin properties


get-sync-pipe-plugin-prop Arguments

--plugin-name {name}

Description The name of the Sync Pipe Plugin
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-pipe-prop

Show Sync Pipe properties


get-sync-pipe-prop Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-source-plugin-prop

Show Sync Source Plugin properties


get-sync-source-plugin-prop Arguments

--plugin-name {name}

Description The name of the Sync Source Plugin
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-sync-source-prop

Show Sync Source properties


get-sync-source-prop Arguments

--source-name {name}

Description The name of the Sync Source
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-trust-manager-provider-prop

Show Trust Manager Provider properties


get-trust-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Trust Manager Provider
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-web-application-extension-prop

Show Web Application Extension properties


get-web-application-extension-prop Arguments

--extension-name {name}

Description The name of the Web Application Extension
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

get-work-queue-prop

Show Work Queue properties


get-work-queue-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Work Queue or one of its subcomponents UnboundID Work Queue, Caller Invoked Work Queue, Wait Notify Work Queue, Canned Response Work Queue, Traditional Work Queue in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

Description Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-alert-handlers

List existing Alert Handlers


list-alert-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-attribute-mappings

List existing Attribute Mappings


list-attribute-mappings Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-attribute-maps

List existing Attribute Maps


list-attribute-maps Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-backends

List existing Backends


list-backends Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-certificate-mappers

List existing Certificate Mappers


list-certificate-mappers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-connection-criteria

List existing Connection Criteria


list-connection-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-connection-handlers

List existing Connection Handlers


list-connection-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-custom-logged-stats

List existing Custom Logged Stats


list-custom-logged-stats Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-debug-targets

List existing Debug Targets


list-debug-targets Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-dn-maps

List existing DN Maps


list-dn-maps Arguments

--property {property}

Description The name of a property to be displayed.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-extended-operation-handlers

List existing Extended Operation Handlers


list-extended-operation-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-external-servers

List existing External Servers


list-external-servers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-http-servlet-extensions

List existing HTTP Servlet Extensions


list-http-servlet-extensions Arguments

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-identity-mappers

List existing Identity Mappers


list-identity-mappers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-key-manager-providers

List existing Key Manager Providers


list-key-manager-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-locations

List existing Locations


list-locations Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-log-field-mappings

List existing Log Field Mappings


list-log-field-mappings Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-log-publishers

List existing Log Publishers


list-log-publishers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-log-retention-policies

List existing Log Retention Policies


list-log-retention-policies Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-log-rotation-policies

List existing Log Rotation Policies


list-log-rotation-policies Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-monitor-providers

List existing Monitor Providers


list-monitor-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-password-generators

List existing Password Generators


list-password-generators Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-password-policies

List existing Password Policies


list-password-policies Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-password-storage-schemes

List existing Password Storage Schemes


list-password-storage-schemes Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-password-validators

List existing Password Validators


list-password-validators Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-plugins

List existing Plugins


list-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-prefetched-metric-queries

List existing Prefetched Metric Queries


list-prefetched-metric-queries Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-properties

Describes managed objects and their properties


list-properties Arguments

-c {category}
--category {category}

Description The category of components whose properties should be described
Required No
Multi-Valued No

-t {type}
--type {type}

Description 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
Required No
Multi-Valued No

--inherited

Description Modifies the display output to show the inherited properties of components

--complexity {level}

Description Specifies the maximum complexity level for items to display. Allowed values (in order of increasing complexity) are 'basic', 'standard', 'advanced', and 'expert'
Allowed Values basic
standard
advanced
expert
Default Value standard
Required No
Multi-Valued No

--includeDescription

Description Indicates that the description for each property should be included in the output. This may create very long lines

--property {property}

Description The name of a property to be displayed
Required No
Multi-Valued Yes

list-request-criteria

List existing Request Criteria


list-request-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-result-criteria

List existing Result Criteria


list-result-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-root-dn-users

List existing Root DN Users


list-root-dn-users Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Root DN User in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sasl-mechanism-handlers

List existing SASL Mechanism Handlers


list-sasl-mechanism-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-search-entry-criteria

List existing Search Entry Criteria


list-search-entry-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-search-reference-criteria

List existing Search Reference Criteria


list-search-reference-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-classes

List existing Sync Classes


list-sync-classes Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-destination-plugins

List existing Sync Destination Plugins


list-sync-destination-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-destinations

List existing Sync Destinations


list-sync-destinations Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-pipe-plugins

List existing Sync Pipe Plugins


list-sync-pipe-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-pipes

List existing Sync Pipes


list-sync-pipes Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-source-plugins

List existing Sync Source Plugins


list-sync-source-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-sync-sources

List existing Sync Sources


list-sync-sources Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-trust-manager-providers

List existing Trust Manager Providers


list-trust-manager-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

list-web-application-extensions

List existing Web Application Extensions


list-web-application-extensions Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

-z {unit}
--unit-size {unit}

Description Display size data using the specified unit. The value for UNIT can be one of the following: b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)
Required No
Multi-Valued No

-m {unit}
--unit-time {unit}

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

set-access-control-handler-prop

Modify Access Control Handler properties


set-access-control-handler-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Access Control Handler or one of its subcomponents DSEE Compat Access Control Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-alert-handler-prop

Modify Alert Handler properties


set-alert-handler-prop Arguments

--handler-name {name}

Description The name of the Alert Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Alert Handler or one of its subcomponents JMX Alert Handler, SNMP Alert Handler, Scripted Alert Handler, Exec Alert Handler, Third Party Alert Handler, SMTP Alert Handler, SNMP Sub Agent Alert Handler, Error Log Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-attribute-map-prop

Modify Attribute Map properties


set-attribute-map-prop Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Attribute Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-attribute-mapping-prop

Modify Attribute Mapping properties


set-attribute-mapping-prop Arguments

--map-name {name}

Description The name of the Attribute Map
Required No
Multi-Valued No

--mapping-name {name}

Description The name of the Attribute Mapping
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Attribute Mapping or one of its subcomponents Constructed Attribute Mapping, Direct Attribute Mapping, DN Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-backend-prop

Modify Backend properties


set-backend-prop Arguments

--backend-name {name}

Description The name of the Backend
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Backend or one of its subcomponents Changelog Backend, Backup Backend, Task Backend, Encryption Settings Backend, Monitor Backend, LDIF Backend, Trust Store Backend, Schema Backend, Metrics Backend, Memory Backend, Alert Backend, Canned Response Backend, Config File Handler Backend, JE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-certificate-mapper-prop

Modify Certificate Mapper properties


set-certificate-mapper-prop Arguments

--mapper-name {name}

Description The name of the Certificate Mapper
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Certificate Mapper or one of its subcomponents Subject Attribute To User Attribute Certificate Mapper, Fingerprint Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Scripted Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-connection-criteria-prop

Modify Connection Criteria properties


set-connection-criteria-prop Arguments

--criteria-name {name}

Description The name of the Connection Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-connection-handler-prop

Modify Connection Handler properties


set-connection-handler-prop Arguments

--handler-name {name}

Description The name of the Connection Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Connection Handler or one of its subcomponents JMX Connection Handler, LDIF Connection Handler, LDAP Connection Handler, HTTP Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-crypto-manager-prop

Modify Crypto Manager properties


set-crypto-manager-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Crypto Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Crypto Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Crypto Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Crypto Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-custom-logged-stats-prop

Modify Custom Logged Stats properties


set-custom-logged-stats-prop Arguments

--plugin-name {name}

Description The name of the Periodic Stats Logger Plugin
Required No
Multi-Valued No

--stats-name {name}

Description The name of the Custom Logged Stats
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Custom Logged Stats in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-debug-target-prop

Modify Debug Target properties


set-debug-target-prop Arguments

--publisher-name {name}

Description The name of the Debug Log Publisher
Required No
Multi-Valued No

--target-name {name}

Description The name of the Debug Target
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Debug Target in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-dn-map-prop

Modify DN Map properties


set-dn-map-prop Arguments

--map-name {name}

Description The name of the DN Map
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for DN Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-extended-operation-handler-prop

Modify Extended Operation Handler properties


set-extended-operation-handler-prop Arguments

--handler-name {name}

Description The name of the Extended Operation Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Extended Operation Handler or one of its subcomponents Who Am I Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Third Party Extended Operation Handler, Administrative Session Extended Operation Handler, Get Connection Id Extended Operation Handler, Password Modify Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Start TLS Extended Operation Handler, Batched Transactions Extended Operation Handler, Stream Directory Values Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Password Policy State Extended Operation Handler, Interactive Transactions Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Multi Update Extended Operation Handler, Cancel Extended Operation Handler, Stream Proxy Values Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-external-server-prop

Modify External Server properties


set-external-server-prop Arguments

--server-name {name}

Description The name of the External Server
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for External Server or one of its subcomponents SMTP External Server, JDBC External Server, LDAP External Server, Mock External Server, SCIM External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-global-configuration-prop

Modify Global Configuration properties


set-global-configuration-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Global Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Global Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Global Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Global Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-global-sync-configuration-prop

Modify Global Sync Configuration properties


set-global-sync-configuration-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Global Sync Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Global Sync Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Global Sync Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Global Sync Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-http-servlet-extension-prop

Modify HTTP Servlet Extension properties


set-http-servlet-extension-prop Arguments

--extension-name {name}

Description The name of the HTTP Servlet Extension
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for HTTP Servlet Extension or one of its subcomponents Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, SCIM HTTP Servlet Extension, Scripted HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-identity-mapper-prop

Modify Identity Mapper properties


set-identity-mapper-prop Arguments

--mapper-name {name}

Description The name of the Identity Mapper
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Identity Mapper or one of its subcomponents Scripted Identity Mapper, Regular Expression Identity Mapper, Exact Match Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-key-manager-provider-prop

Modify Key Manager Provider properties


set-key-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Key Manager Provider
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, Third Party Key Manager Provider, PKCS11 Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-ldap-sdk-debug-logger-prop

Modify LDAP SDK Debug Logger properties


set-ldap-sdk-debug-logger-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for LDAP SDK Debug Logger in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-location-prop

Modify Location properties


set-location-prop Arguments

--location-name {name}

Description The name of the Location
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Location in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-log-field-mapping-prop

Modify Log Field Mapping properties


set-log-field-mapping-prop Arguments

--mapping-name {name}

Description The name of the Log Field Mapping
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Log Field Mapping or one of its subcomponents Error Log Field Mapping, Access Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-log-publisher-prop

Modify Log Publisher properties


set-log-publisher-prop Arguments

--publisher-name {name}

Description The name of the Log Publisher
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Log Publisher or one of its subcomponents Log Publisher, Error Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Sync Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-log-retention-policy-prop

Modify Log Retention Policy properties


set-log-retention-policy-prop Arguments

--policy-name {name}

Description The name of the Log Retention Policy
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Log Retention Policy or one of its subcomponents Never Delete Log Retention Policy, Size Limit Log Retention Policy, File Count Log Retention Policy, Free Disk Space Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-log-rotation-policy-prop

Modify Log Rotation Policy properties


set-log-rotation-policy-prop Arguments

--policy-name {name}

Description The name of the Log Rotation Policy
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Time Limit Log Rotation Policy, Size Limit Log Rotation Policy, Never Rotate Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-monitor-provider-prop

Modify Monitor Provider properties


set-monitor-provider-prop Arguments

--provider-name {name}

Description The name of the Monitor Provider
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, System Info Monitor Provider, Entry Cache Monitor Provider, Third Party Monitor Provider, Stack Trace Monitor Provider, Memory Usage Monitor Provider, Version Monitor Provider, Host System Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-password-generator-prop

Modify Password Generator properties


set-password-generator-prop Arguments

--generator-name {name}

Description The name of the Password Generator
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Password Generator or one of its subcomponents Third Party Password Generator, Random Password Generator, Scripted Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-password-policy-prop

Modify Password Policy properties


set-password-policy-prop Arguments

--policy-name {name}

Description The name of the Password Policy
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Password Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-password-storage-scheme-prop

Modify Password Storage Scheme properties


set-password-storage-scheme-prop Arguments

--scheme-name {name}

Description The name of the Password Storage Scheme
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Password Storage Scheme or one of its subcomponents Clear Password Storage Scheme, Crypt Password Storage Scheme, Triple DES Password Storage Scheme, SHA1 Password Storage Scheme, RC4 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA256 Password Storage Scheme, AES Password Storage Scheme, MD5 Password Storage Scheme, Third Party Password Storage Scheme, Salted SHA512 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-password-validator-prop

Modify Password Validator properties


set-password-validator-prop Arguments

--validator-name {name}

Description The name of the Password Validator
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Password Validator or one of its subcomponents Character Set Password Validator, Length Based Password Validator, Attribute Value Password Validator, Similarity Based Password Validator, Third Party Password Validator, Repeated Characters Password Validator, Scripted Password Validator, Regular Expression Password Validator, Unique Characters Password Validator, Dictionary Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-plugin-prop

Modify Plugin properties


set-plugin-prop Arguments

--plugin-name {name}

Description The name of the Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Plugin or one of its subcomponents Seven Bit Clean Plugin, Entry UUID Plugin, Referral On Update Plugin, Delay Plugin, Periodic GC Plugin, Scripted Plugin, DN Mapper Plugin, LDAP Attribute Description List Plugin, Attribute Mapper Plugin, SNMP Subagent Plugin, Referential Integrity Plugin, Change Subscription Notification Plugin, Unique Attribute Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Internal Search Rate Plugin, Stats Plugin, Processing Time Histogram Plugin, Simple To External Bind Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Pass Through Authentication Plugin, Last Mod Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-plugin-root-prop

Modify Plugin Root properties


set-plugin-root-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Plugin Root in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Plugin Root in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Plugin Root in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Plugin Root in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-prefetched-metric-query-prop

Modify Prefetched Metric Query properties


set-prefetched-metric-query-prop Arguments

--query-name {name}

Description The name of the Prefetched Metric Query
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Prefetched Metric Query in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-request-criteria-prop

Modify Request Criteria properties


set-request-criteria-prop Arguments

--criteria-name {name}

Description The name of the Request Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Aggregate Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-result-criteria-prop

Modify Result Criteria properties


set-result-criteria-prop Arguments

--criteria-name {name}

Description The name of the Result Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Simple Result Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-root-dn-prop

Modify Root DN properties


set-root-dn-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Root DN in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Root DN in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Root DN in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Root DN in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-root-dn-user-prop

Modify Root DN User properties


set-root-dn-user-prop Arguments

--user-name {name}

Description The name of the Root DN User
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Root DN User in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Root DN User in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Root DN User in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Root DN User in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-root-dse-backend-prop

Modify Root DSE Backend properties


set-root-dse-backend-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Root DSE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Root DSE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Root DSE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Root DSE Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sasl-mechanism-handler-prop

Modify SASL Mechanism Handler properties


set-sasl-mechanism-handler-prop Arguments

--handler-name {name}

Description The name of the SASL Mechanism Handler
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for SASL Mechanism Handler or one of its subcomponents Plain SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, External SASL Mechanism Handler, Anonymous SASL Mechanism Handler, Third Party SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-search-entry-criteria-prop

Modify Search Entry Criteria properties


set-search-entry-criteria-prop Arguments

--criteria-name {name}

Description The name of the Search Entry Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-search-reference-criteria-prop

Modify Search Reference Criteria properties


set-search-reference-criteria-prop Arguments

--criteria-name {name}

Description The name of the Search Reference Criteria
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Search Reference Criteria or one of its subcomponents Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-class-prop

Modify Sync Class properties


set-sync-class-prop Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--class-name {name}

Description The name of the Sync Class
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Class in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-destination-plugin-prop

Modify Sync Destination Plugin properties


set-sync-destination-plugin-prop Arguments

--plugin-name {name}

Description The name of the Sync Destination Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Destination Plugin or one of its subcomponents LDAP Sync Destination Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-destination-prop

Modify Sync Destination properties


set-sync-destination-prop Arguments

--destination-name {name}

Description The name of the Sync Destination
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Destination or one of its subcomponents LDAP Sync Destination, JDBC Sync Destination, SCIM Sync Destination, Third Party Sync Destination, Mock Sync Destination, Scripted Sync Destination in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-pipe-plugin-prop

Modify Sync Pipe Plugin properties


set-sync-pipe-plugin-prop Arguments

--plugin-name {name}

Description The name of the Sync Pipe Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Pipe Plugin or one of its subcomponents Third Party Sync Pipe Plugin, Scripted Sync Pipe Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-pipe-prop

Modify Sync Pipe properties


set-sync-pipe-prop Arguments

--pipe-name {name}

Description The name of the Sync Pipe
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Pipe in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-source-plugin-prop

Modify Sync Source Plugin properties


set-sync-source-plugin-prop Arguments

--plugin-name {name}

Description The name of the Sync Source Plugin
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Source Plugin or one of its subcomponents LDAP Sync Source Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-sync-source-prop

Modify Sync Source properties


set-sync-source-prop Arguments

--source-name {name}

Description The name of the Sync Source
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Sync Source or one of its subcomponents Third Party Sync Source, LDAP Sync Source, Scripted Sync Source, JDBC Sync Source, Mock Sync Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-trust-manager-provider-prop

Modify Trust Manager Provider properties


set-trust-manager-provider-prop Arguments

--provider-name {name}

Description The name of the Trust Manager Provider
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Trust Manager Provider or one of its subcomponents Third Party Trust Manager Provider, Blind Trust Manager Provider, File Based Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-web-application-extension-prop

Modify Web Application Extension properties


set-web-application-extension-prop Arguments

--extension-name {name}

Description The name of the Web Application Extension
Required No
Multi-Valued No

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-work-queue-prop

Modify Work Queue properties


set-work-queue-prop Arguments

--set {PROP:VALUE}

Description Assign a value to a property, where PROP is the name of the property and VAL is the single value to be assigned.

See properties for Work Queue or one of its subcomponents UnboundID Work Queue, Caller Invoked Work Queue, Wait Notify Work Queue, Canned Response Work Queue, Traditional Work Queue in the Server Configuration Reference.
Required No
Multi-Valued Yes

--reset {property}

Description Reset a property back to its default values, where PROP is the name of the property to be reset.

See properties for Work Queue or one of its subcomponents UnboundID Work Queue, Caller Invoked Work Queue, Wait Notify Work Queue, Canned Response Work Queue, Traditional Work Queue in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE}

Description Add a single value to a property, where PROP is the name of the property and VAL is the single value to be added.

See properties for Work Queue or one of its subcomponents UnboundID Work Queue, Caller Invoked Work Queue, Wait Notify Work Queue, Canned Response Work Queue, Traditional Work Queue in the Server Configuration Reference.
Required No
Multi-Valued Yes

--remove {PROP:VALUE}

Description Remove a single value from a property, where PROP is the name of the property and VAL is the single value to be removed.

See properties for Work Queue or one of its subcomponents UnboundID Work Queue, Caller Invoked Work Queue, Wait Notify Work Queue, Canned Response Work Queue, Traditional Work Queue in the Server Configuration Reference.
Required No
Multi-Valued Yes

Arguments

-V
--version

Description Display Synchronization Server version information

-H
--help

Description Display general usage information

--help-ldap

Description Display help for using LDAP options

--help-sasl

Description Display help for using SASL options

--help-debug

Description Display help for using debug options
Advanced Yes

--advanced

Description Allow the configuration of advanced components and properties

-v
--verbose

Description Use verbose mode

-Q
--quiet

Description Use quiet mode

-n
--no-prompt

Description Use non-interactive mode. If data in the command is missing, you will not be prompted and the tool will fail

-F {batchFilePath}
--batch-file {batchFilePath}

Description Path to a file containing a sequence of dsconfig commands to run
Required No
Multi-Valued No

--applyChangeTo [server-group|server-group-force|single-server]

Description Controls whether changes apply to a single server or all servers in the configuration server group
Allowed Values server-group
single-server
server-group-force
Required No
Multi-Valued No

--offline

Description Interact with with the local configuration while the server is offline. Not for use while the server is running

-Z
--useSSL

Description Use SSL for secure communication with the server

-q
--useStartTLS

Description Use StartTLS to secure communication with the server

--useNoSecurity

Description Use no security when communicating with the server

-h {host}
--hostname {host}

Description Synchronization Server hostname or IP address
Default Value localhost
Required No
Multi-Valued No

-p {port}
--port {port}

Description Synchronization Server port number
Default Value 389
Required No
Multi-Valued No

-D {bindDN}
--bindDN {bindDN}

Description DN used to bind to the server
Default Value cn=Directory Manager
Required No
Multi-Valued No

-w {bindPassword}
--bindPassword {bindPassword}

Description Password used to bind to the server
Required No
Multi-Valued No

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

Description Bind password file
Required No
Multi-Valued No

-o {name=value}
--saslOption {name=value}

Description SASL bind options
Required No
Multi-Valued Yes

-X
--trustAll

Description Trust all server SSL certificates

-P {trustStorePath}
--trustStorePath {trustStorePath}

Description Certificate trust store path
Required No
Multi-Valued No

-T {trustStorePassword}
--trustStorePassword {trustStorePassword}

Description Certificate trust store PIN
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description Certificate trust store PIN file
Required No
Multi-Valued No

-K {keyStorePath}
--keyStorePath {keyStorePath}

Description Certificate key store path
Required No
Multi-Valued No

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

Description Certificate key store PIN
Required No
Multi-Valued No

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

Description Certificate key store PIN file
Required No
Multi-Valued No

-N {nickname}
--certNickname {nickname}

Description Nickname of the certificate for SSL client authentication
Required No
Multi-Valued No

--propertiesFilePath {propertiesFilePath}

Description Path to the file that contains default property values used for command-line arguments
Required No
Multi-Valued No

--noPropertiesFile

Description Specify that no properties file will be used to get default command-line argument values

--script-friendly

Description Use script-friendly mode

--help-classifications

Description Display subcommands relating to connection and operation classification

--help-core-server

Description Display subcommands relating to the core server

--help-database

Description Display subcommands relating to backends and caching

--help-logging

Description Display subcommands relating to logging, monitoring, and notifications

--help-security

Description Display subcommands relating to security and authorization

--help-sync

Description Display subcommands relating to external synchronization

--help-user-management

Description Display subcommands relating to authentication and password management

--help-subcommands

Description Display all subcommands