View and edit the Metrics Engine 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 Metrics Engine 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 Metrics Engine and use them in the batch file.
dsconfig
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
dsconfig --bindDN uid=admin,dc=example,dc=com --bindPassword password \ --no-prompt --batch-file /path/to/config-batch.txt
dsconfig list-properties --offline --complexity advanced --inherited
Create Alert Handlers
--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, Twilio 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 | twilio |
Required | No |
Multi-Valued | No |
Create Backends
--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 Mappers
--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 | subject-attribute-to-user-attribute | subject-dn-to-user-attribute | subject-equals-dn |
Required | No |
Multi-Valued | No |
Create Connection Criteria
--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 Third Party Connection Criteria, 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 | third-party |
Required | No |
Multi-Valued | No |
Create Connection Handlers
--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 | http | jmx | ldap | ldif |
Required | No |
Multi-Valued | No |
Create Custom Logged Stats
--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 Targets
--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 Extended Operation Handlers
--handler-name {name}
Description | The name of the new Extended Operation Handler |
Required | No |
Multi-Valued | No |
--set {PROP:VALUE}
-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-configuration | get-connection-id | get-symmetric-key | password-modify | password-policy-state | start-tls | who-am-i |
Required | No |
Multi-Valued | No |
Create External Servers
--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 | alcatel-lucent-ds | alcatel-lucent-proxy-server | identity-broker | metrics-engine | smtp | sync-server |
Required | No |
Multi-Valued | No |
Create HTTP Authentication Schemes
--scheme-name {name}
Description | The name of the new HTTP Authentication 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 HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication Scheme in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
-t {type}
--type {type}
Description | The type of HTTP Authentication Scheme to be created (Default: generic). The value for TYPE can be one of: basic | form-login | generic |
Default Value | generic |
Required | No |
Multi-Valued | No |
Create HTTP Servlet Extensions
--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 Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security 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 be created (Default: generic). The value for TYPE can be one of: file-server | generic | groovy-scripted | spring-security | third-party | velocity |
Default Value | generic |
Required | No |
Multi-Valued | No |
Create Identity Mappers
--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 | regular-expression |
Required | No |
Multi-Valued | No |
Create Key Manager Providers
--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 |
Required | No |
Multi-Valued | No |
Create LDAP Slas
--sla-name {STRING}
Description | The name of the new LDAP SLA which will also be used as the value of the 'sla-name' property. Specifies the name of the LDAP SLA. |
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 LDAP SLA in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Create Locations
--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 Mappings
--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 Publishers
--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, Authorization 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 | common-log-file-http-operation | custom-access | custom-debug | custom-error | debug-access | detailed-http-operation | file-based-access | file-based-audit | file-based-debug | file-based-error | groovy-scripted-access | groovy-scripted-error | groovy-scripted-file-based-access | groovy-scripted-file-based-error | groovy-scripted-http-operation | syslog-based-access | syslog-based-error | third-party-access | third-party-error | third-party-file-based-access | third-party-file-based-error | third-party-http-operation |
Required | No |
Multi-Valued | No |
Create Log Retention Policies
--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 Policies
--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 Providers
--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 Monitoring Thresholds
--threshold-name {STRING}
Description | The name of the new Monitoring Threshold which will also be used as the value of the 'threshold-name' property. Specifies the name of the Monitoring Threshold. |
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 Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
-t {type}
--type {type}
Description | The type of Monitoring Threshold to create. The type value can be one of the following: spike | static-level |
Required | No |
Multi-Valued | No |
Create Password Generators
--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 | random |
Required | No |
Multi-Valued | No |
Create Password Policies
--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 Schemes
--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 Third Party Enhanced Password Storage Scheme, 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, PBKDF2 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 | pbkdf2 | rc4 | salted-md5 | salted-sha1 | salted-sha256 | salted-sha384 | salted-sha512 | sha1 | third-party-enhanced | triple-des |
Required | No |
Multi-Valued | No |
Create Password Validators
--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 | length-based | regular-expression | repeated-characters | similarity-based | unique-characters |
Required | No |
Multi-Valued | No |
Create Plugins
--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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication 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 | ldap-attribute-description-list | password-policy-import | periodic-stats-logger | profiler | search-shutdown | seven-bit-clean | snmp-subagent | stats-collector |
Required | No |
Multi-Valued | No |
Create Prefetched Metric Queries
--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 |
Create Request Criteria
--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, Third Party Request Criteria, Aggregate Request Criteria, Root DSE 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 | root-dse | simple | third-party |
Required | No |
Multi-Valued | No |
Create Result Criteria
--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 Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party 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 | third-party |
Required | No |
Multi-Valued | No |
Create SASL Mechanism Handlers
--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, UnboundID Delivered OTP 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 |
Required | No |
Multi-Valued | No |
Create Search Entry Criteria
--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 Third Party Search Entry Criteria, 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 | third-party |
Required | No |
Multi-Valued | No |
Create Search Reference Criteria
--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 Third Party Search Reference Criteria, 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 | third-party |
Required | No |
Multi-Valued | No |
Create Server Queries
--query-name {STRING}
Description | The name of the new Server Query which will also be used as the value of the 'query-name' property. Specifies the name of the Server 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 Server Query in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Create Trust Manager Providers
--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 |
Required | No |
Multi-Valued | No |
Create Velocity Context Providers
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--provider-name {name}
Description | The name of the new Velocity Context 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 Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context Provider in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
-t {type}
--type {type}
Description | The type of Velocity Context Provider to create. The type value can be one of the following: custom | third-party | velocity-tools |
Required | No |
Multi-Valued | No |
Create Velocity Template Loaders
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--loader-name {name}
Description | The name of the new Velocity Template Loader |
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 Velocity Template Loader in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Create Web Application Extensions
--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 or one of its subcomponents Broker Web Application Extension in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Delete Alert Handlers
--handler-name {name}
Description | The name of the Alert Handler |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Alert Handlers |
Delete Backends
--backend-name {name}
Description | The name of the Backend |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Backends |
Delete Certificate Mappers
--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
--criteria-name {name}
Description | The name of the Connection Criteria |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Connection Criteria |
Delete Connection Handlers
--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
--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 Targets
--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 Extended Operation Handlers
--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 Servers
--server-name {name}
Description | The name of the External Server |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent External Servers |
Delete HTTP Authentication Schemes
--scheme-name {name}
Description | The name of the HTTP Authentication Scheme |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent HTTP Authentication Schemes |
Delete HTTP Servlet Extensions
--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 Mappers
--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 Providers
--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 LDAP Slas
--sla-name {name}
Description | The name of the LDAP SLA |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent LDAP Slas |
Delete Locations
--location-name {name}
Description | The name of the Location |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Locations |
Delete Log Field Mappings
--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 Publishers
--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 Policies
--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 Policies
--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 Providers
--provider-name {name}
Description | The name of the Monitor Provider |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Monitor Providers |
Delete Monitoring Thresholds
--threshold-name {name}
Description | The name of the Monitoring Threshold |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Monitoring Thresholds |
Delete Password Generators
--generator-name {name}
Description | The name of the Password Generator |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Password Generators |
Delete Password Policies
--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 Schemes
--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 Validators
--validator-name {name}
Description | The name of the Password Validator |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Password Validators |
Delete Plugins
--plugin-name {name}
Description | The name of the Plugin |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Plugins |
Delete Prefetched Metric Queries
--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
--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
--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 Handlers
--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
--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
--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 Server Queries
--query-name {name}
Description | The name of the Server Query |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Server Queries |
Delete Trust Manager Providers
--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 Velocity Context Providers
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--provider-name {name}
Description | The name of the Velocity Context Provider |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Velocity Context Providers |
Delete Velocity Template Loaders
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--loader-name {name}
Description | The name of the Velocity Template Loader |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Velocity Template Loaders |
Delete Web Application Extensions
--extension-name {name}
Description | The name of the Web Application Extension |
Required | No |
Multi-Valued | No |
-f
--force
Description | Ignore nonexistent Web Application Extensions |
Show Access Control Handler properties
--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 |
Show Alert Handler properties
--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, Twilio 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 |
Show Backend properties
--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 |
Show Certificate Mapper properties
--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 |
Show Connection Criteria properties
--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 Third Party Connection Criteria, 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 |
Show Connection Handler properties
--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 |
Show Crypto Manager properties
--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 |
Show Custom Logged Stats properties
--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 |
Show Debug Target properties
--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 |
Show Extended Operation Handler properties
--handler-name {name}
Description | The name of the Extended Operation Handler |
Required | No |
Multi-Valued | No |
--property {property}
--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 |
Show External Server properties
--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 |
Show Global Configuration properties
--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 |
Show HTTP Authentication Scheme properties
--scheme-name {name}
Description | The name of the HTTP Authentication Scheme |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication 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 |
Show HTTP Servlet Extension properties
--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 Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security 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 |
Show Identity Mapper properties
--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 |
Show Key Manager Provider properties
--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 |
Show LDAP SDK Debug Logger properties
--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 |
Show LDAP SLA properties
--sla-name {name}
Description | The name of the LDAP SLA |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for LDAP SLA 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 |
Show Location properties
--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 |
Show Log Field Mapping properties
--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 |
Show Log Publisher properties
--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, Authorization 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 |
Show Log Retention Policy properties
--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 |
Show Log Rotation Policy properties
--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 |
Show Metric Histogram Boundary properties
--boundary-name {name}
Description | The name of the Metric Histogram Boundary |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Metric Histogram Boundary 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 |
Show Monitor Provider properties
--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 |
Show Monitoring Configuration properties
--property {property}
Description | The name of a property to be displayed. See properties for Monitoring 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 |
Show Monitoring Database properties
--property {property}
Description | The name of a property to be displayed. See properties for Monitoring Database or one of its subcomponents Derby Monitoring Database, Postgres Monitoring Database 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 |
Show Monitoring Threshold properties
--threshold-name {name}
Description | The name of the Monitoring Threshold |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold 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 |
Show Password Generator properties
--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 |
Show Password Policy properties
--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 |
Show Password Storage Scheme properties
--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 Third Party Enhanced Password Storage Scheme, 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, PBKDF2 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 |
Show Password Validator properties
--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 |
Show Plugin properties
--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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication 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 |
Show Plugin Root properties
--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 |
Show Prefetched Metric Query properties
--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 |
Show Request Criteria properties
--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, Third Party Request Criteria, Aggregate Request Criteria, Root DSE 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 |
Show Result Criteria properties
--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 Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party 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 |
Show Root DN properties
--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 |
Show Root DN User properties
--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 |
Show Root DSE Backend properties
--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 |
Show SASL Mechanism Handler properties
--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, UnboundID Delivered OTP 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 |
Show Search Entry Criteria properties
--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 Third Party Search Entry Criteria, 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 |
Show Search Reference Criteria properties
--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 Third Party Search Reference Criteria, 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 |
Show Server Query properties
--query-name {name}
Description | The name of the Server Query |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Server 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 |
Show Trust Manager Provider properties
--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 |
Show Velocity Context Provider properties
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--provider-name {name}
Description | The name of the Velocity Context Provider |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context 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 |
Show Velocity Template Loader properties
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--loader-name {name}
Description | The name of the Velocity Template Loader |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Velocity Template Loader 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 |
Show Web Application Extension properties
--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 or one of its subcomponents Broker 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 |
Show Work Queue properties
--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 existing Alert Handlers
--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, Twilio 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 existing Backends
--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 existing Certificate Mappers
--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 existing Connection Criteria
--property {property}
Description | The name of a property to be displayed. See properties for Connection Criteria or one of its subcomponents Third Party Connection Criteria, 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 existing Connection Handlers
--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 existing Custom Logged Stats
--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 existing Debug Targets
--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 existing Extended Operation Handlers
--property {property}
-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 existing External Servers
--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 existing HTTP Authentication Schemes
--property {property}
Description | The name of a property to be displayed. See properties for HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication 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 existing HTTP Servlet Extensions
--property {property}
Description | The name of a property to be displayed. See properties for HTTP Servlet Extension or one of its subcomponents Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security 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 existing Identity Mappers
--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 existing Key Manager Providers
--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 existing LDAP Slas
--property {property}
Description | The name of a property to be displayed. See properties for LDAP SLA 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 existing Locations
--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 existing Log Field Mappings
--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 existing Log Publishers
--property {property}
Description | The name of a property to be displayed. See properties for Log Publisher or one of its subcomponents Log Publisher, Authorization 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 existing Log Retention Policies
--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 existing Log Rotation Policies
--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 existing Metric Histogram Boundaries
--property {property}
Description | The name of a property to be displayed. See properties for Metric Histogram Boundary 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 existing Monitor Providers
--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 existing Monitoring Thresholds
--property {property}
Description | The name of a property to be displayed. See properties for Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold 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 existing Password Generators
--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 existing Password Policies
--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 existing Password Storage Schemes
--property {property}
Description | The name of a property to be displayed. See properties for Password Storage Scheme or one of its subcomponents Third Party Enhanced Password Storage Scheme, 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, PBKDF2 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 existing Password Validators
--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 existing Plugins
--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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication 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 existing Prefetched Metric Queries
--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 |
Describes managed objects and their properties
-c {category}
--category {category}
Description | The category of components whose properties should be described. The list of categories is available in the 'Component' column in the output of 'dsconfig list-properties' |
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. The list of categories is available in the 'Type' column in the output of 'dsconfig list-properties' |
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'. Advanced properties will be shown when a value of 'advanced' or 'expert' is provided |
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 existing Request Criteria
--property {property}
Description | The name of a property to be displayed. See properties for Request Criteria or one of its subcomponents Simple Request Criteria, Third Party Request Criteria, Aggregate Request Criteria, Root DSE 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 existing Result Criteria
--property {property}
Description | The name of a property to be displayed. See properties for Result Criteria or one of its subcomponents Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party 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 existing Root DN Users
--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 existing SASL Mechanism Handlers
--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, UnboundID Delivered OTP 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 existing Search Entry Criteria
--property {property}
Description | The name of a property to be displayed. See properties for Search Entry Criteria or one of its subcomponents Third Party Search Entry Criteria, 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 existing Search Reference Criteria
--property {property}
Description | The name of a property to be displayed. See properties for Search Reference Criteria or one of its subcomponents Third Party Search Reference Criteria, 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 existing Server Queries
--property {property}
Description | The name of a property to be displayed. See properties for Server 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 existing Trust Manager Providers
--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 existing Velocity Context Providers
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context 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 existing Velocity Template Loaders
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--property {property}
Description | The name of a property to be displayed. See properties for Velocity Template Loader 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 existing Web Application Extensions
--property {property}
Description | The name of a property to be displayed. See properties for Web Application Extension or one of its subcomponents Broker 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 |
Modify Access Control Handler properties
--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 |
Modify Alert Handler properties
--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, Twilio 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, Twilio 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, Twilio 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, Twilio Alert Handler in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Backend properties
--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 |
Modify Certificate Mapper properties
--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 |
Modify Connection Criteria properties
--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 Third Party Connection Criteria, 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 Third Party Connection Criteria, 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 Third Party Connection Criteria, 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 Third Party Connection Criteria, Aggregate Connection Criteria, Simple Connection Criteria in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Connection Handler properties
--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 |
Modify Crypto Manager properties
--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 |
Modify Custom Logged Stats properties
--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 |
Modify Debug Target properties
--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 |
Modify Extended Operation Handler properties
--handler-name {name}
Description | The name of the Extended Operation Handler |
Required | No |
Multi-Valued | No |
--set {PROP:VALUE}
--reset {property}
--add {PROP:VALUE}
--remove {PROP:VALUE}
Modify External Server properties
--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 |
Modify Global Configuration properties
--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 |
Modify HTTP Authentication Scheme properties
--scheme-name {name}
Description | The name of the HTTP Authentication 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 HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication 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 HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication 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 HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication 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 HTTP Authentication Scheme or one of its subcomponents Basic HTTP Authentication Scheme, Form Login HTTP Authentication Scheme in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify HTTP Servlet Extension properties
--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 Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security 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 Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security 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 Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security 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 Velocity HTTP Servlet Extension, Third Party HTTP Servlet Extension, File Server HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Spring Security HTTP Servlet Extension in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Identity Mapper properties
--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 |
Modify Key Manager Provider properties
--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 |
Modify LDAP SDK Debug Logger properties
--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 |
Modify LDAP SLA properties
--sla-name {name}
Description | The name of the LDAP SLA |
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 LDAP SLA 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 SLA 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 SLA 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 SLA in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Location properties
--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 |
Modify Log Field Mapping properties
--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 |
Modify Log Publisher properties
--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, Authorization 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, Authorization 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, Authorization 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, Authorization 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 |
Modify Log Retention Policy properties
--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 |
Modify Log Rotation Policy properties
--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 |
Modify Metric Histogram Boundary properties
--boundary-name {name}
Description | The name of the Metric Histogram Boundary |
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 Metric Histogram Boundary 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 Metric Histogram Boundary 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 Metric Histogram Boundary 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 Metric Histogram Boundary in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Monitor Provider properties
--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 |
Modify Monitoring Configuration properties
--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 Monitoring 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 Monitoring 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 Monitoring 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 Monitoring Configuration in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Monitoring Database properties
--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 Monitoring Database or one of its subcomponents Derby Monitoring Database, Postgres Monitoring Database 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 Monitoring Database or one of its subcomponents Derby Monitoring Database, Postgres Monitoring Database 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 Monitoring Database or one of its subcomponents Derby Monitoring Database, Postgres Monitoring Database 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 Monitoring Database or one of its subcomponents Derby Monitoring Database, Postgres Monitoring Database in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Monitoring Threshold properties
--threshold-name {name}
Description | The name of the Monitoring Threshold |
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 Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold 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 Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold 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 Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold 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 Monitoring Threshold or one of its subcomponents Spike Monitoring Threshold, Static Level Monitoring Threshold in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Password Generator properties
--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 |
Modify Password Policy properties
--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 |
Modify Password Storage Scheme properties
--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 Third Party Enhanced Password Storage Scheme, 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, PBKDF2 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 Third Party Enhanced Password Storage Scheme, 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, PBKDF2 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 Third Party Enhanced Password Storage Scheme, 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, PBKDF2 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 Third Party Enhanced Password Storage Scheme, 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, PBKDF2 Password Storage Scheme, Blowfish Password Storage Scheme, Base64 Password Storage Scheme in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Password Validator properties
--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 |
Modify Plugin properties
--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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication 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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication 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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication 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, Unique Attribute Plugin, Global Referential Integrity Plugin, Change Subscription Notification Plugin, Third Party Plugin, Changelog Password Encryption Plugin, Last Access Time Plugin, Internal Search Rate Plugin, Simple To External Bind Plugin, Stats Plugin, Processing Time Histogram Plugin, Globally Unique Attribute Plugin, SNMP Master Agent Plugin, Search Shutdown Plugin, Password Policy Import Plugin, Profiler Plugin, Last Mod Plugin, Pass Through Authentication Plugin in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Plugin Root properties
--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 |
Modify Prefetched Metric Query properties
--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 |
Modify Request Criteria properties
--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, Third Party Request Criteria, Aggregate Request Criteria, Root DSE 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, Third Party Request Criteria, Aggregate Request Criteria, Root DSE 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, Third Party Request Criteria, Aggregate Request Criteria, Root DSE 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, Third Party Request Criteria, Aggregate Request Criteria, Root DSE Request Criteria in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Result Criteria properties
--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 Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party 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 Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party 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 Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party 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 Replication Assurance Result Criteria, Aggregate Result Criteria, Third Party Result Criteria, Simple Result Criteria in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Root DN properties
--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 |
Modify Root DN User properties
--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 |
Modify Root DSE Backend properties
--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 |
Modify SASL Mechanism Handler properties
--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, UnboundID Delivered OTP 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, UnboundID Delivered OTP 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, UnboundID Delivered OTP 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, UnboundID Delivered OTP SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Search Entry Criteria properties
--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 Third Party Search Entry Criteria, 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 Third Party Search Entry Criteria, 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 Third Party Search Entry Criteria, 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 Third Party Search Entry Criteria, Aggregate Search Entry Criteria, Simple Search Entry Criteria in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Search Reference Criteria properties
--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 Third Party Search Reference Criteria, 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 Third Party Search Reference Criteria, 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 Third Party Search Reference Criteria, 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 Third Party Search Reference Criteria, Simple Search Reference Criteria, Aggregate Search Reference Criteria in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Server Query properties
--query-name {name}
Description | The name of the Server 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 Server 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 Server 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 Server 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 Server Query in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Trust Manager Provider properties
--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 |
Modify Velocity Context Provider properties
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--provider-name {name}
Description | The name of the Velocity Context 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 Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context 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 Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context 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 Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context 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 Velocity Context Provider or one of its subcomponents Velocity Tools Velocity Context Provider, Third Party Velocity Context Provider in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Velocity Template Loader properties
--extension-name {name}
Description | The name of the Velocity HTTP Servlet Extension |
Required | No |
Multi-Valued | No |
--loader-name {name}
Description | The name of the Velocity Template Loader |
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 Velocity Template Loader 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 Velocity Template Loader 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 Velocity Template Loader 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 Velocity Template Loader in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Web Application Extension properties
--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 or one of its subcomponents Broker 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 or one of its subcomponents Broker 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 or one of its subcomponents Broker 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 or one of its subcomponents Broker Web Application Extension in the Server Configuration Reference. |
Required | No |
Multi-Valued | Yes |
Modify Work Queue properties
--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 |
-V
--version
Description | Display Metrics Engine 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 |
--batch-continue-on-error
Description | Force the execution of all commands in the batch file on the server even if prevalidation fails. Execution will also continue even if one of the commands fails. Please note that commands affecting multiple servers can still fail to execute unless the --server-group-force argument is specified. Only applies if the batch file argument is also supplied |
--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 | Metrics Engine hostname or IP address |
Default Value | localhost |
Required | No |
Multi-Valued | No |
-p {port}
--port {port}
Description | Metrics Engine 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 |
-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-metrics-engine
Description | Display subcommands relating to metrics engine |
--help-security
Description | Display subcommands relating to security and authorization |
--help-user-management
Description | Display subcommands relating to authentication and password management |
--help-subcommands
Description | Display all subcommands |