Directory Server Documentation Index
Command-Line Tool Reference Home

dsconfig

↓Description
↓Examples
↓Subcommands
↓Arguments

Description

View and edit the Directory Server configuration.

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

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

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

Examples

Start dsconfig in interactive mode: 
dsconfig


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


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


List information about all available configuration properties for all objects, including inherited properties: 
dsconfig list-properties --offline --inherited

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

Subcommands

↓create-access-token-validator
↓create-account-status-notification-handler
↓create-alert-handler
↓create-backend
↓create-certificate-mapper
↓create-change-subscription
↓create-change-subscription-handler
↓create-cipher-stream-provider
↓create-client-connection-policy
↓create-connection-criteria
↓create-connection-handler
↓create-consent-definition
↓create-consent-definition-localization
↓create-constructed-attribute
↓create-custom-logged-stats
↓create-data-security-auditor
↓create-debug-target
↓create-delegated-admin-attribute
↓create-delegated-admin-attribute-category
↓create-delegated-admin-resource-rights
↓create-delegated-admin-rights
↓create-dn-map
↓create-entry-cache
↓create-extended-operation-handler
↓create-external-server
↓create-gauge
↓create-gauge-data-source
↓create-http-servlet-cross-origin-policy
↓create-http-servlet-extension
↓create-identity-mapper
↓create-json-attribute-constraints
↓create-json-field-constraints
↓create-key-manager-provider
↓create-key-pair
↓create-local-db-composite-index
↓create-local-db-index
↓create-local-db-vlv-index
↓create-location
↓create-log-field-mapping
↓create-log-file-rotation-listener
↓create-log-publisher
↓create-log-retention-policy
↓create-log-rotation-policy
↓create-monitor-provider
↓create-monitoring-endpoint
↓create-notification-manager
↓create-oauth-token-handler
↓create-obscured-value
↓create-otp-delivery-mechanism
↓create-password-generator
↓create-password-policy
↓create-password-storage-scheme
↓create-password-validator
↓create-plugin
↓create-policy-configuration-key
↓create-recurring-task
↓create-recurring-task-chain
↓create-replication-assurance-policy
↓create-request-criteria
↓create-rest-resource-type
↓create-result-code-map
↓create-result-criteria
↓create-root-dn-user
↓create-sasl-mechanism-handler
↓create-scim-attribute
↓create-scim-attribute-mapping
↓create-scim-resource-type
↓create-scim-schema
↓create-scim-subattribute
↓create-search-entry-criteria
↓create-search-reference-criteria
↓create-sensitive-attribute
↓create-server-group
↓create-soft-delete-policy
↓create-topology-admin-user
↓create-trust-manager-provider
↓create-trusted-certificate
↓create-uncached-attribute-criteria
↓create-uncached-entry-criteria
↓create-vault-authentication-method
↓create-velocity-context-provider
↓create-velocity-template-loader
↓create-virtual-attribute
↓create-web-application-extension
↓delete-access-token-validator
↓delete-account-status-notification-handler
↓delete-alert-handler
↓delete-backend
↓delete-certificate-mapper
↓delete-change-subscription
↓delete-change-subscription-handler
↓delete-cipher-stream-provider
↓delete-client-connection-policy
↓delete-connection-criteria
↓delete-connection-handler
↓delete-consent-definition
↓delete-consent-definition-localization
↓delete-constructed-attribute
↓delete-custom-logged-stats
↓delete-data-security-auditor
↓delete-debug-target
↓delete-delegated-admin-attribute
↓delete-delegated-admin-attribute-category
↓delete-delegated-admin-resource-rights
↓delete-delegated-admin-rights
↓delete-dn-map
↓delete-entry-cache
↓delete-extended-operation-handler
↓delete-external-server
↓delete-gauge
↓delete-gauge-data-source
↓delete-http-servlet-cross-origin-policy
↓delete-http-servlet-extension
↓delete-identity-mapper
↓delete-json-attribute-constraints
↓delete-json-field-constraints
↓delete-key-manager-provider
↓delete-key-pair
↓delete-local-db-composite-index
↓delete-local-db-index
↓delete-local-db-vlv-index
↓delete-location
↓delete-log-field-mapping
↓delete-log-file-rotation-listener
↓delete-log-publisher
↓delete-log-retention-policy
↓delete-log-rotation-policy
↓delete-monitor-provider
↓delete-monitoring-endpoint
↓delete-notification-manager
↓delete-oauth-token-handler
↓delete-obscured-value
↓delete-otp-delivery-mechanism
↓delete-password-generator
↓delete-password-policy
↓delete-password-storage-scheme
↓delete-password-validator
↓delete-plugin
↓delete-policy-configuration-key
↓delete-recurring-task
↓delete-recurring-task-chain
↓delete-replication-assurance-policy
↓delete-request-criteria
↓delete-rest-resource-type
↓delete-result-code-map
↓delete-result-criteria
↓delete-root-dn-user
↓delete-sasl-mechanism-handler
↓delete-scim-attribute
↓delete-scim-attribute-mapping
↓delete-scim-resource-type
↓delete-scim-schema
↓delete-scim-subattribute
↓delete-search-entry-criteria
↓delete-search-reference-criteria
↓delete-sensitive-attribute
↓delete-server-group
↓delete-soft-delete-policy
↓delete-topology-admin-user
↓delete-trust-manager-provider
↓delete-trusted-certificate
↓delete-uncached-attribute-criteria
↓delete-uncached-entry-criteria
↓delete-vault-authentication-method
↓delete-velocity-context-provider
↓delete-velocity-template-loader
↓delete-virtual-attribute
↓delete-web-application-extension
↓get-access-control-handler-prop
↓get-access-token-validator-prop
↓get-account-status-notification-handler-prop
↓get-alarm-manager-prop
↓get-alert-handler-prop
↓get-attribute-syntax-prop
↓get-backend-prop
↓get-certificate-mapper-prop
↓get-change-subscription-handler-prop
↓get-change-subscription-prop
↓get-cipher-secret-key-prop
↓get-cipher-stream-provider-prop
↓get-client-connection-policy-prop
↓get-connection-criteria-prop
↓get-connection-handler-prop
↓get-consent-definition-localization-prop
↓get-consent-definition-prop
↓get-consent-service-prop
↓get-constructed-attribute-prop
↓get-crypto-manager-prop
↓get-custom-logged-stats-prop
↓get-data-security-auditor-prop
↓get-debug-target-prop
↓get-delegated-admin-attribute-category-prop
↓get-delegated-admin-attribute-prop
↓get-delegated-admin-resource-rights-prop
↓get-delegated-admin-rights-prop
↓get-dn-map-prop
↓get-entry-cache-prop
↓get-extended-operation-handler-prop
↓get-external-server-prop
↓get-gauge-data-source-prop
↓get-gauge-prop
↓get-global-configuration-prop
↓get-group-implementation-prop
↓get-http-configuration-prop
↓get-http-servlet-cross-origin-policy-prop
↓get-http-servlet-extension-prop
↓get-identity-mapper-prop
↓get-inter-server-authentication-info-prop
↓get-json-attribute-constraints-prop
↓get-json-field-constraints-prop
↓get-key-manager-provider-prop
↓get-key-pair-prop
↓get-ldap-sdk-debug-logger-prop
↓get-license-prop
↓get-local-db-composite-index-prop
↓get-local-db-index-prop
↓get-local-db-vlv-index-prop
↓get-location-prop
↓get-log-field-mapping-prop
↓get-log-file-rotation-listener-prop
↓get-log-publisher-prop
↓get-log-retention-policy-prop
↓get-log-rotation-policy-prop
↓get-mac-secret-key-prop
↓get-matching-rule-prop
↓get-monitor-provider-prop
↓get-monitoring-endpoint-prop
↓get-notification-manager-prop
↓get-oauth-token-handler-prop
↓get-obscured-value-prop
↓get-otp-delivery-mechanism-prop
↓get-password-generator-prop
↓get-password-policy-prop
↓get-password-storage-scheme-prop
↓get-password-validator-prop
↓get-plugin-prop
↓get-plugin-root-prop
↓get-policy-configuration-key-prop
↓get-recurring-task-chain-prop
↓get-recurring-task-prop
↓get-replication-assurance-policy-prop
↓get-replication-domain-prop
↓get-replication-server-prop
↓get-request-criteria-prop
↓get-rest-resource-type-prop
↓get-result-code-map-prop
↓get-result-criteria-prop
↓get-root-dn-prop
↓get-root-dn-user-prop
↓get-root-dse-backend-prop
↓get-sasl-mechanism-handler-prop
↓get-scim-attribute-mapping-prop
↓get-scim-attribute-prop
↓get-scim-resource-type-prop
↓get-scim-schema-prop
↓get-scim-subattribute-prop
↓get-search-entry-criteria-prop
↓get-search-reference-criteria-prop
↓get-sensitive-attribute-prop
↓get-server-group-prop
↓get-server-instance-listener-prop
↓get-server-instance-prop
↓get-soft-delete-policy-prop
↓get-synchronization-provider-prop
↓get-topology-admin-user-prop
↓get-trust-manager-provider-prop
↓get-trusted-certificate-prop
↓get-uncached-attribute-criteria-prop
↓get-uncached-entry-criteria-prop
↓get-vault-authentication-method-prop
↓get-velocity-context-provider-prop
↓get-velocity-template-loader-prop
↓get-virtual-attribute-prop
↓get-web-application-extension-prop
↓get-work-queue-prop
↓list-access-token-validators
↓list-account-status-notification-handlers
↓list-alert-handlers
↓list-attribute-syntaxes
↓list-backends
↓list-certificate-mappers
↓list-change-subscription-handlers
↓list-change-subscriptions
↓list-cipher-secret-keys
↓list-cipher-stream-providers
↓list-client-connection-policies
↓list-connection-criteria
↓list-connection-handlers
↓list-consent-definition-localizations
↓list-consent-definitions
↓list-constructed-attributes
↓list-custom-logged-stats
↓list-data-security-auditors
↓list-debug-targets
↓list-delegated-admin-attribute-categories
↓list-delegated-admin-attributes
↓list-delegated-admin-resource-rights
↓list-delegated-admin-rights
↓list-dn-maps
↓list-entry-caches
↓list-extended-operation-handlers
↓list-external-servers
↓list-gauge-data-sources
↓list-gauges
↓list-group-implementations
↓list-http-servlet-cross-origin-policies
↓list-http-servlet-extensions
↓list-identity-mappers
↓list-inter-server-authentication-info
↓list-json-attribute-constraints
↓list-json-field-constraints
↓list-key-manager-providers
↓list-key-pairs
↓list-local-db-composite-indexes
↓list-local-db-indexes
↓list-local-db-vlv-indexes
↓list-locations
↓list-log-field-mappings
↓list-log-file-rotation-listeners
↓list-log-publishers
↓list-log-retention-policies
↓list-log-rotation-policies
↓list-mac-secret-keys
↓list-matching-rules
↓list-monitor-providers
↓list-monitoring-endpoints
↓list-notification-managers
↓list-oauth-token-handlers
↓list-obscured-values
↓list-otp-delivery-mechanisms
↓list-password-generators
↓list-password-policies
↓list-password-storage-schemes
↓list-password-validators
↓list-plugins
↓list-policy-configuration-keys
↓list-properties
↓list-recurring-task-chains
↓list-recurring-tasks
↓list-replication-assurance-policies
↓list-replication-domains
↓list-request-criteria
↓list-rest-resource-types
↓list-result-code-maps
↓list-result-criteria
↓list-root-dn-users
↓list-sasl-mechanism-handlers
↓list-scim-attribute-mappings
↓list-scim-attributes
↓list-scim-resource-types
↓list-scim-schemas
↓list-scim-subattributes
↓list-search-entry-criteria
↓list-search-reference-criteria
↓list-sensitive-attributes
↓list-server-groups
↓list-server-instance-listeners
↓list-server-instances
↓list-soft-delete-policies
↓list-synchronization-providers
↓list-topology-admin-users
↓list-trust-manager-providers
↓list-trusted-certificates
↓list-uncached-attribute-criteria
↓list-uncached-entry-criteria
↓list-vault-authentication-methods
↓list-velocity-context-providers
↓list-velocity-template-loaders
↓list-virtual-attributes
↓list-web-application-extensions
↓set-access-control-handler-prop
↓set-access-token-validator-prop
↓set-account-status-notification-handler-prop
↓set-alarm-manager-prop
↓set-alert-handler-prop
↓set-attribute-syntax-prop
↓set-backend-prop
↓set-certificate-mapper-prop
↓set-change-subscription-handler-prop
↓set-change-subscription-prop
↓set-cipher-secret-key-prop
↓set-cipher-stream-provider-prop
↓set-client-connection-policy-prop
↓set-connection-criteria-prop
↓set-connection-handler-prop
↓set-consent-definition-localization-prop
↓set-consent-definition-prop
↓set-consent-service-prop
↓set-constructed-attribute-prop
↓set-crypto-manager-prop
↓set-custom-logged-stats-prop
↓set-data-security-auditor-prop
↓set-debug-target-prop
↓set-delegated-admin-attribute-category-prop
↓set-delegated-admin-attribute-prop
↓set-delegated-admin-resource-rights-prop
↓set-delegated-admin-rights-prop
↓set-dn-map-prop
↓set-entry-cache-prop
↓set-extended-operation-handler-prop
↓set-external-server-prop
↓set-gauge-data-source-prop
↓set-gauge-prop
↓set-global-configuration-prop
↓set-group-implementation-prop
↓set-http-configuration-prop
↓set-http-servlet-cross-origin-policy-prop
↓set-http-servlet-extension-prop
↓set-identity-mapper-prop
↓set-inter-server-authentication-info-prop
↓set-json-attribute-constraints-prop
↓set-json-field-constraints-prop
↓set-key-manager-provider-prop
↓set-key-pair-prop
↓set-ldap-sdk-debug-logger-prop
↓set-license-prop
↓set-local-db-composite-index-prop
↓set-local-db-index-prop
↓set-local-db-vlv-index-prop
↓set-location-prop
↓set-log-field-mapping-prop
↓set-log-file-rotation-listener-prop
↓set-log-publisher-prop
↓set-log-retention-policy-prop
↓set-log-rotation-policy-prop
↓set-mac-secret-key-prop
↓set-matching-rule-prop
↓set-monitor-provider-prop
↓set-monitoring-endpoint-prop
↓set-notification-manager-prop
↓set-oauth-token-handler-prop
↓set-obscured-value-prop
↓set-otp-delivery-mechanism-prop
↓set-password-generator-prop
↓set-password-policy-prop
↓set-password-storage-scheme-prop
↓set-password-validator-prop
↓set-plugin-prop
↓set-plugin-root-prop
↓set-policy-configuration-key-prop
↓set-recurring-task-chain-prop
↓set-recurring-task-prop
↓set-replication-assurance-policy-prop
↓set-replication-domain-prop
↓set-replication-server-prop
↓set-request-criteria-prop
↓set-rest-resource-type-prop
↓set-result-code-map-prop
↓set-result-criteria-prop
↓set-root-dn-prop
↓set-root-dn-user-prop
↓set-root-dse-backend-prop
↓set-sasl-mechanism-handler-prop
↓set-scim-attribute-mapping-prop
↓set-scim-attribute-prop
↓set-scim-resource-type-prop
↓set-scim-schema-prop
↓set-scim-subattribute-prop
↓set-search-entry-criteria-prop
↓set-search-reference-criteria-prop
↓set-sensitive-attribute-prop
↓set-server-group-prop
↓set-server-instance-listener-prop
↓set-server-instance-prop
↓set-soft-delete-policy-prop
↓set-synchronization-provider-prop
↓set-topology-admin-user-prop
↓set-trust-manager-provider-prop
↓set-trusted-certificate-prop
↓set-uncached-attribute-criteria-prop
↓set-uncached-entry-criteria-prop
↓set-vault-authentication-method-prop
↓set-velocity-context-provider-prop
↓set-velocity-template-loader-prop
↓set-virtual-attribute-prop
↓set-web-application-extension-prop
↓set-work-queue-prop

create-access-token-validator

Create Access Token Validators

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-access-token-validator Arguments

--validator-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Access Token Validator to create. The type value can be one of the following: jwt | mock | ping-federate | third-party
Required No
Multi-Valued No

create-account-status-notification-handler

Create Account Status Notification Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-account-status-notification-handler Arguments

--handler-name {name}

Description The name of the new Account Status Notification Handler
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Account Status Notification Handler to create. The type value can be one of the following: error-log | groovy-scripted | multi-part-email | smtp | third-party
Required No
Multi-Valued No

create-alert-handler

Create Alert Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-alert-handler Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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-backend

Create Backends

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-backend Arguments

--backend-name {STRING}

Description The name of the new Backend which will also be used as the value of the 'backend-id' property. Specifies a name to identify the associated backend.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: custom | local-db
Required No
Multi-Valued No

create-certificate-mapper

Create Certificate Mappers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-certificate-mapper Arguments

--mapper-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: fingerprint | groovy-scripted | subject-attribute-to-user-attribute | subject-dn-to-user-attribute | subject-equals-dn | third-party
Required No
Multi-Valued No

create-change-subscription

Create Change Subscriptions

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-change-subscription Arguments

--subscription-name {name}

Description The name of the new Change Subscription
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-change-subscription-handler

Create Change Subscription Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-change-subscription-handler Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Change Subscription Handler to create. The type value can be one of the following: groovy-scripted | logging | third-party
Required No
Multi-Valued No

create-cipher-stream-provider

Create Cipher Stream Providers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-cipher-stream-provider Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Cipher Stream Provider to create. The type value can be one of the following: amazon-key-management-service | default | file-based | third-party | vault | wait-for-passphrase
Required No
Multi-Valued No

create-client-connection-policy

Create Client Connection Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-client-connection-policy Arguments

--policy-name {STRING}

Description The name of the new Client Connection Policy which will also be used as the value of the 'policy-id' property. Specifies a name which uniquely identifies this Client Connection Policy in the server.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-connection-criteria

Create Connection Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-connection-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | simple | third-party
Required No
Multi-Valued No

create-connection-handler

Create Connection Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-connection-handler Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: http | jmx | ldap | ldif
Required No
Multi-Valued No

create-consent-definition

Create Consent Definitions

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-consent-definition Arguments

--definition-name {id}

Description The name of the new Consent Definition which will also be used as the value of the 'unique-id' property. A version-independent unique identifier for this Consent Definition.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-consent-definition-localization

Create Consent Definition Localizations

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-consent-definition-localization Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--localization-name {locale}

Description The name of the new Consent Definition Localization which will also be used as the value of the 'locale' property. The locale of this Consent Definition Localization.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-constructed-attribute

Create Constructed Attributes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-constructed-attribute Arguments

--attribute-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-custom-logged-stats

Create Custom Logged Stats

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-custom-logged-stats Arguments

--plugin-name {name}

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

--stats-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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-data-security-auditor

Create Data Security Auditors

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-data-security-auditor Arguments

--auditor-name {name}

Description The name of the new Data Security Auditor
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Data Security Auditor to create. The type value can be one of the following: access-control | disabled-account | expired-password | locked-account | multiple-password | privilege | weakly-encoded-password
Required No
Multi-Valued No

create-debug-target

Create Debug Targets

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-debug-target Arguments

--publisher-name {name}

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

--target-name {STRING_NAME}

Description The name of the new Debug Target which will also be used as the value of the 'debug-scope' property. Specifies the fully-qualified Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, com.unboundid.directory.server.core.DirectoryServer#startUp).
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-delegated-admin-attribute

Create Delegated Admin Attributes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-delegated-admin-attribute Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--attribute-type {OID}

Description The name of the new Delegated Admin Attribute which will also be used as the value of the 'attribute-type' property. Specifies the name or OID of the LDAP attribute type.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-delegated-admin-attribute-category

Create Delegated Admin Attribute Categories

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-delegated-admin-attribute-category Arguments

--display-name {STRING}

Description The name of the new Delegated Admin Attribute Category which will also be used as the value of the 'display-name' property. A human readable display name for this Delegated Admin Attribute Category.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-delegated-admin-resource-rights

Create Delegated Admin Resource Rights

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-delegated-admin-resource-rights Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--rest-resource-type {NAME}

Description The name of the new Delegated Admin Resource Rights which will also be used as the value of the 'rest-resource-type' property. Specifies the resource type applicable to these Delegated Admin Resource Rights.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-delegated-admin-rights

Create Delegated Admin Rights

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-delegated-admin-rights Arguments

--rights-name {name}

Description The name of the new Delegated Admin Rights
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-dn-map

Create DN Maps

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-dn-map Arguments

--map-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-entry-cache

Create Entry Caches

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-entry-cache Arguments

--cache-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Entry Cache to create. The type value can be one of the following: fifo
Required No
Multi-Valued No

create-extended-operation-handler

Create Extended Operation Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-extended-operation-handler Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Extended Operation Handler to create. The type value can be one of the following: custom | deliver-otp | deliver-password-reset-token | single-use-tokens | third-party | validate-totp-password
Required No
Multi-Valued No

create-external-server

Create External Servers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-external-server Arguments

--server-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: active-directory | http | jdbc | ldap | nokia-ds | nokia-proxy-server | opendj | oracle-unified-directory | ping-identity-ds | ping-identity-proxy-server | smtp
Required No
Multi-Valued No

create-gauge

Create Gauges

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-gauge Arguments

--gauge-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Gauge to create. The type value can be one of the following: indicator | numeric
Required No
Multi-Valued No

create-gauge-data-source

Create Gauge Data Sources

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-gauge-data-source Arguments

--source-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Gauge Data Source to create. The type value can be one of the following: indicator | numeric
Required No
Multi-Valued No

create-http-servlet-cross-origin-policy

Create HTTP Servlet Cross Origin Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-http-servlet-cross-origin-policy Arguments

--policy-name {name}

Description The name of the new HTTP Servlet Cross Origin Policy
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-http-servlet-extension

Create HTTP Servlet Extensions

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-http-servlet-extension Arguments

--extension-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of HTTP Servlet Extension to create. The type value can be one of the following: availability-state | file-server | groovy-scripted | ldap-mapped-scim | quickstart | third-party
Required No
Multi-Valued No

create-identity-mapper

Create Identity Mappers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-identity-mapper Arguments

--mapper-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: exact-match | groovy-scripted | regular-expression | third-party
Required No
Multi-Valued No

create-json-attribute-constraints

Create JSON Attribute Constraints

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-json-attribute-constraints Arguments

--attribute-type {OID}

Description The name of the new JSON Attribute Constraints which will also be used as the value of the 'attribute-type' property. The name or OID of the LDAP attribute type whose values will be subject to the associated field constraints. This attribute type must be defined in the server schema, and it must have a "JSON object" syntax.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-json-field-constraints

Create JSON Field Constraints

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-json-field-constraints Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--json-field {STRING}

Description The name of the new JSON Field Constraints which will also be used as the value of the 'json-field' property. The full name of the JSON field to which these constraints apply.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-key-manager-provider

Create Key Manager Providers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-key-manager-provider Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

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

create-key-pair

Create Key Pairs

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-key-pair Arguments

--pair-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-local-db-composite-index

Create Local DB Composite Indexes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-local-db-composite-index Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the new Local DB Composite Index
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-local-db-index

Create Local DB Indexes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-local-db-index Arguments

--backend-name {name}

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

--index-name {OID}

Description The name of the new Local DB Index which will also be used as the value of the 'attribute' property. Specifies the name of the attribute for which the index is to be maintained.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-local-db-vlv-index

Create Local DB VLV Indexes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-local-db-vlv-index Arguments

--backend-name {name}

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

--index-name {STRING}

Description The name of the new Local DB VLV Index which will also be used as the value of the 'name' property. Specifies a unique name for this VLV index.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-location

Create Locations

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-location Arguments

--location-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-log-field-mapping

Create Log Field Mappings

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-log-field-mapping Arguments

--mapping-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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-file-rotation-listener

Create Log File Rotation Listeners

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-log-file-rotation-listener Arguments

--listener-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Log File Rotation Listener to create. The type value can be one of the following: copy | summarize | third-party
Required No
Multi-Valued No

create-log-publisher

Create Log Publishers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-log-publisher Arguments

--publisher-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | debug-access | detailed-http-operation | file-based-access | file-based-audit | file-based-debug | file-based-error | file-based-trace | groovy-scripted-access | groovy-scripted-error | groovy-scripted-file-based-access | groovy-scripted-file-based-error | groovy-scripted-http-operation | jdbc-based-access | jdbc-based-error | json-access | json-error | operation-timing-access | 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-policy

Create Log Retention Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-log-retention-policy Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: file-count | free-disk-space | never-delete | size-limit | time-limit
Required No
Multi-Valued No

create-log-rotation-policy

Create Log Rotation Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-log-rotation-policy Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: fixed-time | never-rotate | size-limit | time-limit
Required No
Multi-Valued No

create-monitor-provider

Create Monitor Providers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-monitor-provider Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: custom | third-party
Required No
Multi-Valued No

create-monitoring-endpoint

Create Monitoring Endpoints

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-monitoring-endpoint Arguments

--endpoint-name {name}

Description The name of the new Monitoring Endpoint
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Monitoring Endpoint to create. The type value can be one of the following: statsd
Required No
Multi-Valued No

create-notification-manager

Create Notification Managers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-notification-manager Arguments

--manager-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Notification Manager to create. The type value can be one of the following: third-party
Required No
Multi-Valued No

create-oauth-token-handler

Create OAuth Token Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-oauth-token-handler Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

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

create-obscured-value

Create Obscured Values

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-obscured-value Arguments

--value-name {name}

Description The name of the new Obscured Value
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-otp-delivery-mechanism

Create OTP Delivery Mechanisms

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-otp-delivery-mechanism Arguments

--mechanism-name {name}

Description The name of the new OTP Delivery Mechanism
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of OTP Delivery Mechanism to create. The type value can be one of the following: email | third-party | twilio
Required No
Multi-Valued No

create-password-generator

Create Password Generators

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-password-generator Arguments

--generator-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: groovy-scripted | passphrase | random | third-party
Required No
Multi-Valued No

create-password-policy

Create Password Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-password-policy Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-password-storage-scheme

Create Password Storage Schemes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-password-storage-scheme Arguments

--scheme-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: argon2 | bcrypt | crypt | pbkdf2 | scrypt | third-party | third-party-enhanced
Required No
Multi-Valued No

create-password-validator

Create Password Validators

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-password-validator Arguments

--validator-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

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

create-plugin

Create Plugins

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-plugin Arguments

--plugin-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: attribute-mapper | clean-up-expired-pingfederate-persistent-access-grants | clean-up-expired-pingfederate-persistent-sessions | clean-up-inactive-pingfederate-persistent-sessions | custom | delay | dn-mapper | groovy-scripted | internal-search-rate | pass-through-authentication | periodic-gc | periodic-stats-logger | ping-one-for-customers-pass-through-authentication | purge-expired-data | referential-integrity | referral-on-update | search-shutdown | seven-bit-clean | simple-to-external-bind | snmp-subagent | sub-operation-timing | third-party | unique-attribute
Required No
Multi-Valued No

create-policy-configuration-key

Create Policy Configuration Keys

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-policy-configuration-key Arguments

--key-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-recurring-task

Create Recurring Tasks

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-recurring-task Arguments

--task-name {name}

Description The name of the new Recurring Task
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Recurring Task to create. The type value can be one of the following: backup | delay | enter-lockdown-mode | exec | file-retention | ldif-export | leave-lockdown-mode | statically-defined | third-party
Required No
Multi-Valued No

create-recurring-task-chain

Create Recurring Task Chains

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-recurring-task-chain Arguments

--chain-name {name}

Description The name of the new Recurring Task Chain
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-replication-assurance-policy

Create Replication Assurance Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-replication-assurance-policy Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-request-criteria

Create Request Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-request-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | root-dse | simple | third-party
Required No
Multi-Valued No

create-rest-resource-type

Create REST Resource Types

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-rest-resource-type Arguments

--type-name {name}

Description The name of the new REST Resource Type
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of REST Resource Type to be created (Default: generic). The value for TYPE can be one of: generic | group | user
Default Value generic
Required No
Multi-Valued No

create-result-code-map

Create Result Code Maps

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-result-code-map Arguments

--map-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-result-criteria

Create Result Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-result-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | replication-assurance | simple | third-party
Required No
Multi-Valued No

create-root-dn-user

Create Root DN Users

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-root-dn-user Arguments

--user-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-sasl-mechanism-handler

Create SASL Mechanism Handlers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-sasl-mechanism-handler Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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: third-party | unboundid-delivered-otp | unboundid-ms-chap-v2
Required No
Multi-Valued No

create-scim-attribute

Create SCIM Attributes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-scim-attribute Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {attribute-name}

Description The name of the new SCIM Attribute which will also be used as the value of the 'name' property. The name of the attribute.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-scim-attribute-mapping

Create SCIM Attribute Mappings

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-scim-attribute-mapping Arguments

--type-name {name}

Description The name of the LDAP Mapping SCIM Resource Type
Required No
Multi-Valued No

--mapping-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-scim-resource-type

Create SCIM Resource Types

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-scim-resource-type Arguments

--type-name {name}

Description The name of the new SCIM Resource Type
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of SCIM Resource Type to create. The type value can be one of the following: ldap-mapping | ldap-pass-through
Required No
Multi-Valued No

create-scim-schema

Create SCIM Schemas

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-scim-schema Arguments

--schema-name {urn}

Description The name of the new SCIM Schema which will also be used as the value of the 'schema-urn' property. The URN which identifies this SCIM Schema.
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-scim-subattribute

Create SCIM Subattributes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-scim-subattribute Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--subattribute-name {name}

Description The name of the new SCIM Subattribute
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-search-entry-criteria

Create Search Entry Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-search-entry-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | simple | third-party
Required No
Multi-Valued No

create-search-reference-criteria

Create Search Reference Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-search-reference-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | simple | third-party
Required No
Multi-Valued No

create-sensitive-attribute

Create Sensitive Attributes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-sensitive-attribute Arguments

--attribute-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-server-group

Create Server Groups

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-server-group Arguments

--group-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-soft-delete-policy

Create Soft Delete Policies

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-soft-delete-policy Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-topology-admin-user

Create Topology Admin Users

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-topology-admin-user Arguments

--user-name {name}

Description The name of the new Topology Admin User
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-trust-manager-provider

Create Trust Manager Providers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-trust-manager-provider Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 | file-based | jvm-default | third-party
Required No
Multi-Valued No

create-trusted-certificate

Create Trusted Certificates

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-trusted-certificate Arguments

--certificate-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-uncached-attribute-criteria

Create Uncached Attribute Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-uncached-attribute-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Uncached Attribute Criteria to create. The type value can be one of the following: default | groovy-scripted | simple | third-party
Required No
Multi-Valued No

create-uncached-entry-criteria

Create Uncached Entry Criteria

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-uncached-entry-criteria Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Uncached Entry Criteria to create. The type value can be one of the following: default | filter-based | groovy-scripted | last-access-time | third-party
Required No
Multi-Valued No

create-vault-authentication-method

Create Vault Authentication Methods

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-vault-authentication-method Arguments

--method-name {name}

Description The name of the new Vault Authentication Method
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Vault Authentication Method to create. The type value can be one of the following: app-role | static-token | user-pass
Required No
Multi-Valued No

create-velocity-context-provider

Create Velocity Context Providers

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-velocity-context-provider Arguments

--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} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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-loader

Create Velocity Template Loaders

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-velocity-template-loader Arguments

--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} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

create-virtual-attribute

Create Virtual Attributes

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-virtual-attribute Arguments

--name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

-t {type}
--type {type}

Description The type of Virtual Attribute to create. The type value can be one of the following: constructed | custom | entry-dn | groovy-scripted | identify-references | is-member-of | member | mirror | third-party | user-defined
Required No
Multi-Valued No

create-web-application-extension

Create Web Application Extensions

When using dsconfig in non-interactive mode, the --set option value can be specified in two ways:First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

create-web-application-extension Arguments

--extension-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

delete-access-token-validator

Delete Access Token Validators


delete-access-token-validator Arguments

--validator-name {name}

Description The name of the Access Token Validator
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Access Token Validators

delete-account-status-notification-handler

Delete Account Status Notification Handlers


delete-account-status-notification-handler Arguments

--handler-name {name}

Description The name of the Account Status Notification Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Account Status Notification Handlers

delete-alert-handler

Delete Alert Handlers


delete-alert-handler Arguments

--handler-name {name}

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

-f
--force

Description Ignore nonexistent Alert Handlers

delete-backend

Delete Backends


delete-backend Arguments

--backend-name {name}

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

-f
--force

Description Ignore nonexistent Backends

delete-certificate-mapper

Delete Certificate Mappers


delete-certificate-mapper Arguments

--mapper-name {name}

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

-f
--force

Description Ignore nonexistent Certificate Mappers

delete-change-subscription

Delete Change Subscriptions


delete-change-subscription Arguments

--subscription-name {name}

Description The name of the Change Subscription
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Change Subscriptions

delete-change-subscription-handler

Delete Change Subscription Handlers


delete-change-subscription-handler Arguments

--handler-name {name}

Description The name of the Change Subscription Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Change Subscription Handlers

delete-cipher-stream-provider

Delete Cipher Stream Providers


delete-cipher-stream-provider Arguments

--provider-name {name}

Description The name of the Cipher Stream Provider
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Cipher Stream Providers

delete-client-connection-policy

Delete Client Connection Policies


delete-client-connection-policy Arguments

--policy-name {name}

Description The name of the Client Connection Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Client Connection Policies

delete-connection-criteria

Delete Connection Criteria


delete-connection-criteria Arguments

--criteria-name {name}

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

-f
--force

Description Ignore nonexistent Connection Criteria

delete-connection-handler

Delete Connection Handlers


delete-connection-handler Arguments

--handler-name {name}

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

-f
--force

Description Ignore nonexistent Connection Handlers

delete-consent-definition

Delete Consent Definitions


delete-consent-definition Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Consent Definitions

delete-consent-definition-localization

Delete Consent Definition Localizations


delete-consent-definition-localization Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--localization-name {name}

Description The name of the Consent Definition Localization
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Consent Definition Localizations

delete-constructed-attribute

Delete Constructed Attributes


delete-constructed-attribute Arguments

--attribute-name {name}

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

-f
--force

Description Ignore nonexistent Constructed Attributes

delete-custom-logged-stats

Delete Custom Logged Stats


delete-custom-logged-stats Arguments

--plugin-name {name}

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

--stats-name {name}

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

-f
--force

Description Ignore nonexistent Custom Logged Stats

delete-data-security-auditor

Delete Data Security Auditors


delete-data-security-auditor Arguments

--auditor-name {name}

Description The name of the Data Security Auditor
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Data Security Auditors

delete-debug-target

Delete Debug Targets


delete-debug-target Arguments

--publisher-name {name}

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

--target-name {name}

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

-f
--force

Description Ignore nonexistent Debug Targets

delete-delegated-admin-attribute

Delete Delegated Admin Attributes


delete-delegated-admin-attribute Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--attribute-type {name}

Description The name of the Delegated Admin Attribute
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Delegated Admin Attributes

delete-delegated-admin-attribute-category

Delete Delegated Admin Attribute Categories


delete-delegated-admin-attribute-category Arguments

--display-name {name}

Description The name of the Delegated Admin Attribute Category
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Delegated Admin Attribute Categories

delete-delegated-admin-resource-rights

Delete Delegated Admin Resource Rights


delete-delegated-admin-resource-rights Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--rest-resource-type {name}

Description The name of the Delegated Admin Resource Rights
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Delegated Admin Resource Rights

delete-delegated-admin-rights

Delete Delegated Admin Rights


delete-delegated-admin-rights Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Delegated Admin Rights

delete-dn-map

Delete DN Maps


delete-dn-map Arguments

--map-name {name}

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

-f
--force

Description Ignore nonexistent DN Maps

delete-entry-cache

Delete Entry Caches


delete-entry-cache Arguments

--cache-name {name}

Description The name of the Entry Cache
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Entry Caches

delete-extended-operation-handler

Delete Extended Operation Handlers


delete-extended-operation-handler Arguments

--handler-name {name}

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

-f
--force

Description Ignore nonexistent Extended Operation Handlers

delete-external-server

Delete External Servers


delete-external-server Arguments

--server-name {name}

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

-f
--force

Description Ignore nonexistent External Servers

delete-gauge

Delete Gauges


delete-gauge Arguments

--gauge-name {name}

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

-f
--force

Description Ignore nonexistent Gauges

delete-gauge-data-source

Delete Gauge Data Sources


delete-gauge-data-source Arguments

--source-name {name}

Description The name of the Gauge Data Source
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Gauge Data Sources

delete-http-servlet-cross-origin-policy

Delete HTTP Servlet Cross Origin Policies


delete-http-servlet-cross-origin-policy Arguments

--policy-name {name}

Description The name of the HTTP Servlet Cross Origin Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent HTTP Servlet Cross Origin Policies

delete-http-servlet-extension

Delete HTTP Servlet Extensions


delete-http-servlet-extension Arguments

--extension-name {name}

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

-f
--force

Description Ignore nonexistent HTTP Servlet Extensions

delete-identity-mapper

Delete Identity Mappers


delete-identity-mapper Arguments

--mapper-name {name}

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

-f
--force

Description Ignore nonexistent Identity Mappers

delete-json-attribute-constraints

Delete JSON Attribute Constraints


delete-json-attribute-constraints Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent JSON Attribute Constraints

delete-json-field-constraints

Delete JSON Field Constraints


delete-json-field-constraints Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--json-field {name}

Description The name of the JSON Field Constraints
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent JSON Field Constraints

delete-key-manager-provider

Delete Key Manager Providers


delete-key-manager-provider Arguments

--provider-name {name}

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

-f
--force

Description Ignore nonexistent Key Manager Providers

delete-key-pair

Delete Key Pairs


delete-key-pair Arguments

--pair-name {name}

Description The name of the Key Pair
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Key Pairs

delete-local-db-composite-index

Delete Local DB Composite Indexes


delete-local-db-composite-index Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB Composite Index
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Local DB Composite Indexes

delete-local-db-index

Delete Local DB Indexes


delete-local-db-index Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB Index
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Local DB Indexes

delete-local-db-vlv-index

Delete Local DB VLV Indexes


delete-local-db-vlv-index Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB VLV Index
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Local DB VLV Indexes

delete-location

Delete Locations


delete-location Arguments

--location-name {name}

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

-f
--force

Description Ignore nonexistent Locations

delete-log-field-mapping

Delete Log Field Mappings


delete-log-field-mapping Arguments

--mapping-name {name}

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

-f
--force

Description Ignore nonexistent Log Field Mappings

delete-log-file-rotation-listener

Delete Log File Rotation Listeners


delete-log-file-rotation-listener Arguments

--listener-name {name}

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

-f
--force

Description Ignore nonexistent Log File Rotation Listeners

delete-log-publisher

Delete Log Publishers


delete-log-publisher Arguments

--publisher-name {name}

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

-f
--force

Description Ignore nonexistent Log Publishers

delete-log-retention-policy

Delete Log Retention Policies


delete-log-retention-policy Arguments

--policy-name {name}

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

-f
--force

Description Ignore nonexistent Log Retention Policies

delete-log-rotation-policy

Delete Log Rotation Policies


delete-log-rotation-policy Arguments

--policy-name {name}

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

-f
--force

Description Ignore nonexistent Log Rotation Policies

delete-monitor-provider

Delete Monitor Providers


delete-monitor-provider Arguments

--provider-name {name}

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

-f
--force

Description Ignore nonexistent Monitor Providers

delete-monitoring-endpoint

Delete Monitoring Endpoints


delete-monitoring-endpoint Arguments

--endpoint-name {name}

Description The name of the Monitoring Endpoint
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Monitoring Endpoints

delete-notification-manager

Delete Notification Managers


delete-notification-manager Arguments

--manager-name {name}

Description The name of the Notification Manager
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Notification Managers

delete-oauth-token-handler

Delete OAuth Token Handlers


delete-oauth-token-handler Arguments

--handler-name {name}

Description The name of the OAuth Token Handler
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent OAuth Token Handlers

delete-obscured-value

Delete Obscured Values


delete-obscured-value Arguments

--value-name {name}

Description The name of the Obscured Value
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Obscured Values

delete-otp-delivery-mechanism

Delete OTP Delivery Mechanisms


delete-otp-delivery-mechanism Arguments

--mechanism-name {name}

Description The name of the OTP Delivery Mechanism
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent OTP Delivery Mechanisms

delete-password-generator

Delete Password Generators


delete-password-generator Arguments

--generator-name {name}

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

-f
--force

Description Ignore nonexistent Password Generators

delete-password-policy

Delete Password Policies


delete-password-policy Arguments

--policy-name {name}

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

-f
--force

Description Ignore nonexistent Password Policies

delete-password-storage-scheme

Delete Password Storage Schemes


delete-password-storage-scheme Arguments

--scheme-name {name}

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

-f
--force

Description Ignore nonexistent Password Storage Schemes

delete-password-validator

Delete Password Validators


delete-password-validator Arguments

--validator-name {name}

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

-f
--force

Description Ignore nonexistent Password Validators

delete-plugin

Delete Plugins


delete-plugin Arguments

--plugin-name {name}

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

-f
--force

Description Ignore nonexistent Plugins

delete-policy-configuration-key

Delete Policy Configuration Keys


delete-policy-configuration-key Arguments

--key-name {name}

Description The name of the Policy Configuration Key
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Policy Configuration Keys

delete-recurring-task

Delete Recurring Tasks


delete-recurring-task Arguments

--task-name {name}

Description The name of the Recurring Task
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Recurring Tasks

delete-recurring-task-chain

Delete Recurring Task Chains


delete-recurring-task-chain Arguments

--chain-name {name}

Description The name of the Recurring Task Chain
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Recurring Task Chains

delete-replication-assurance-policy

Delete Replication Assurance Policies


delete-replication-assurance-policy Arguments

--policy-name {name}

Description The name of the Replication Assurance Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Replication Assurance Policies

delete-request-criteria

Delete Request Criteria


delete-request-criteria Arguments

--criteria-name {name}

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

-f
--force

Description Ignore nonexistent Request Criteria

delete-rest-resource-type

Delete REST Resource Types


delete-rest-resource-type Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent REST Resource Types

delete-result-code-map

Delete Result Code Maps


delete-result-code-map Arguments

--map-name {name}

Description The name of the Result Code Map
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Result Code Maps

delete-result-criteria

Delete Result Criteria


delete-result-criteria Arguments

--criteria-name {name}

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

-f
--force

Description Ignore nonexistent Result Criteria

delete-root-dn-user

Delete Root DN Users


delete-root-dn-user Arguments

--user-name {name}

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

-f
--force

Description Ignore nonexistent Root DN Users

delete-sasl-mechanism-handler

Delete SASL Mechanism Handlers


delete-sasl-mechanism-handler Arguments

--handler-name {name}

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

-f
--force

Description Ignore nonexistent SASL Mechanism Handlers

delete-scim-attribute

Delete SCIM Attributes


delete-scim-attribute Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

-f
--force

Description Ignore nonexistent SCIM Attributes

delete-scim-attribute-mapping

Delete SCIM Attribute Mappings


delete-scim-attribute-mapping Arguments

--type-name {name}

Description The name of the LDAP Mapping SCIM Resource Type
Required No
Multi-Valued No

--mapping-name {name}

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

-f
--force

Description Ignore nonexistent SCIM Attribute Mappings

delete-scim-resource-type

Delete SCIM Resource Types


delete-scim-resource-type Arguments

--type-name {name}

Description The name of the SCIM Resource Type
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Resource Types

delete-scim-schema

Delete SCIM Schemas


delete-scim-schema Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Schemas

delete-scim-subattribute

Delete SCIM Subattributes


delete-scim-subattribute Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--subattribute-name {name}

Description The name of the SCIM Subattribute
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent SCIM Subattributes

delete-search-entry-criteria

Delete Search Entry Criteria


delete-search-entry-criteria Arguments

--criteria-name {name}

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

-f
--force

Description Ignore nonexistent Search Entry Criteria

delete-search-reference-criteria

Delete Search Reference Criteria


delete-search-reference-criteria Arguments

--criteria-name {name}

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

-f
--force

Description Ignore nonexistent Search Reference Criteria

delete-sensitive-attribute

Delete Sensitive Attributes


delete-sensitive-attribute Arguments

--attribute-name {name}

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

-f
--force

Description Ignore nonexistent Sensitive Attributes

delete-server-group

Delete Server Groups


delete-server-group Arguments

--group-name {name}

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

-f
--force

Description Ignore nonexistent Server Groups

delete-soft-delete-policy

Delete Soft Delete Policies


delete-soft-delete-policy Arguments

--policy-name {name}

Description The name of the Soft Delete Policy
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Soft Delete Policies

delete-topology-admin-user

Delete Topology Admin Users


delete-topology-admin-user Arguments

--user-name {name}

Description The name of the Topology Admin User
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Topology Admin Users

delete-trust-manager-provider

Delete Trust Manager Providers


delete-trust-manager-provider Arguments

--provider-name {name}

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

-f
--force

Description Ignore nonexistent Trust Manager Providers

delete-trusted-certificate

Delete Trusted Certificates


delete-trusted-certificate Arguments

--certificate-name {name}

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

-f
--force

Description Ignore nonexistent Trusted Certificates

delete-uncached-attribute-criteria

Delete Uncached Attribute Criteria


delete-uncached-attribute-criteria Arguments

--criteria-name {name}

Description The name of the Uncached Attribute Criteria
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Uncached Attribute Criteria

delete-uncached-entry-criteria

Delete Uncached Entry Criteria


delete-uncached-entry-criteria Arguments

--criteria-name {name}

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

-f
--force

Description Ignore nonexistent Uncached Entry Criteria

delete-vault-authentication-method

Delete Vault Authentication Methods


delete-vault-authentication-method Arguments

--method-name {name}

Description The name of the Vault Authentication Method
Required No
Multi-Valued No

-f
--force

Description Ignore nonexistent Vault Authentication Methods

delete-velocity-context-provider

Delete Velocity Context Providers


delete-velocity-context-provider Arguments

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

Delete Velocity Template Loaders


delete-velocity-template-loader Arguments

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

Delete Virtual Attributes


delete-virtual-attribute Arguments

--name {name}

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

-f
--force

Description Ignore nonexistent Virtual Attributes

delete-web-application-extension

Delete Web Application Extensions


delete-web-application-extension Arguments

--extension-name {name}

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

-f
--force

Description Ignore nonexistent Web Application Extensions

get-access-control-handler-prop

Show Access Control Handler properties


get-access-control-handler-prop Arguments

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-access-token-validator-prop

Show Access Token Validator properties


get-access-token-validator-prop Arguments

--validator-name {name}

Description The name of the Access Token Validator
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Access Token Validator or one of its subcomponents External Access Token Validator, Mock Access Token Validator, Third Party Access Token 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-account-status-notification-handler-prop

Show Account Status Notification Handler properties


get-account-status-notification-handler-prop Arguments

--handler-name {name}

Description The name of the Account Status Notification Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Account Status Notification Handler or one of its subcomponents Error Log Account Status Notification Handler, Scripted Account Status Notification Handler, Multi Part Email Account Status Notification Handler, SMTP Account Status Notification Handler, Third Party Account Status Notification 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-alarm-manager-prop

Show Alarm Manager properties


get-alarm-manager-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Alarm 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-alert-handler-prop

Show Alert Handler properties


get-alert-handler-prop Arguments

--handler-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Alert Handler or one of its subcomponents Error Log Alert Handler, Exec Alert Handler, Scripted Alert Handler, JMX Alert Handler, SMTP Alert Handler, SNMP Alert Handler, SNMP Sub Agent Alert Handler, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-attribute-syntax-prop

Show Attribute Syntax properties


get-attribute-syntax-prop Arguments

--syntax-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Attribute Syntax or one of its subcomponents Attribute Type Description Attribute Syntax, Bit String Attribute Syntax, Boolean Attribute Syntax, Directory String Attribute Syntax, Distinguished Name Attribute Syntax, Generalized Time Attribute Syntax, Hex String Attribute Syntax, Integer Attribute Syntax, JSON Object Attribute Syntax, LDAP URL Attribute Syntax, Name And Optional UID Attribute Syntax, Telephone Number Attribute Syntax, UUID Attribute Syntax, User Password Attribute Syntax 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-backend-prop

Show Backend properties


get-backend-prop Arguments

--backend-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Backend or one of its subcomponents Notification Backend, Backup Backend, Canned Response Backend, Changelog Backend, Config File Handler Backend, Encryption Settings Backend, JE Backend, LDIF Backend, Memory Backend, Metrics Backend, Monitor Backend, Schema Backend, Task Backend, Trust Store 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-certificate-mapper-prop

Show Certificate Mapper properties


get-certificate-mapper-prop Arguments

--mapper-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Certificate Mapper or one of its subcomponents Fingerprint Certificate Mapper, Scripted Certificate Mapper, Subject Attribute To User Attribute Certificate Mapper, Subject DN To User Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-change-subscription-handler-prop

Show Change Subscription Handler properties


get-change-subscription-handler-prop Arguments

--handler-name {name}

Description The name of the Change Subscription Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Change Subscription Handler or one of its subcomponents Scripted Change Subscription Handler, Logging Change Subscription Handler, Third Party Change Subscription 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-change-subscription-prop

Show Change Subscription properties


get-change-subscription-prop Arguments

--subscription-name {name}

Description The name of the Change Subscription
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Change Subscription 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-cipher-secret-key-prop

Show Cipher Secret Key properties


get-cipher-secret-key-prop Arguments

--instance-name {name}

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

--key-name {name}

Description The name of the Cipher Secret Key
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-cipher-stream-provider-prop

Show Cipher Stream Provider properties


get-cipher-stream-provider-prop Arguments

--provider-name {name}

Description The name of the Cipher Stream Provider
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, Default Cipher Stream Provider, File Based Cipher Stream Provider, Third Party Cipher Stream Provider, Vault Cipher Stream Provider, Wait For Passphrase Cipher Stream 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-client-connection-policy-prop

Show Client Connection Policy properties


get-client-connection-policy-prop Arguments

--policy-name {name}

Description The name of the Client Connection Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Client Connection 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-connection-criteria-prop

Show Connection Criteria properties


get-connection-criteria-prop Arguments

--criteria-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Connection Criteria or one of its subcomponents Aggregate Connection Criteria, Simple Connection Criteria, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-connection-handler-prop

Show Connection Handler properties


get-connection-handler-prop Arguments

--handler-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Connection Handler or one of its subcomponents HTTP Connection Handler, JMX Connection Handler, LDAP Connection Handler, LDIF 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-consent-definition-localization-prop

Show Consent Definition Localization properties


get-consent-definition-localization-prop Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--localization-name {name}

Description The name of the Consent Definition Localization
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Consent Definition Localization 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-consent-definition-prop

Show Consent Definition properties


get-consent-definition-prop Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Consent Definition 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-consent-service-prop

Show Consent Service properties


get-consent-service-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Consent Service 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-constructed-attribute-prop

Show Constructed Attribute properties


get-constructed-attribute-prop Arguments

--attribute-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Constructed Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-crypto-manager-prop

Show Crypto Manager properties


get-crypto-manager-prop Arguments

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-custom-logged-stats-prop

Show Custom Logged Stats properties


get-custom-logged-stats-prop Arguments

--plugin-name {name}

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

--stats-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-data-security-auditor-prop

Show Data Security Auditor properties


get-data-security-auditor-prop Arguments

--auditor-name {name}

Description The name of the Data Security Auditor
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Data Security Auditor or one of its subcomponents Access Control Data Security Auditor, Disabled Account Data Security Auditor, Expired Password Data Security Auditor, Locked Account Data Security Auditor, Multiple Password Data Security Auditor, Privilege Data Security Auditor, Weakly Encoded Password Data Security Auditor 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-debug-target-prop

Show Debug Target properties


get-debug-target-prop Arguments

--publisher-name {name}

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

--target-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-delegated-admin-attribute-category-prop

Show Delegated Admin Attribute Category properties


get-delegated-admin-attribute-category-prop Arguments

--display-name {name}

Description The name of the Delegated Admin Attribute Category
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Delegated Admin Attribute Category 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-delegated-admin-attribute-prop

Show Delegated Admin Attribute properties


get-delegated-admin-attribute-prop Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--attribute-type {name}

Description The name of the Delegated Admin Attribute
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Delegated Admin Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-delegated-admin-resource-rights-prop

Show Delegated Admin Resource Rights properties


get-delegated-admin-resource-rights-prop Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--rest-resource-type {name}

Description The name of the Delegated Admin Resource Rights
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Delegated Admin Resource Rights 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-delegated-admin-rights-prop

Show Delegated Admin Rights properties


get-delegated-admin-rights-prop Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Delegated Admin Rights 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-dn-map-prop

Show DN Map properties


get-dn-map-prop Arguments

--map-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-entry-cache-prop

Show Entry Cache properties


get-entry-cache-prop Arguments

--cache-name {name}

Description The name of the Entry Cache
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Entry Cache or one of its subcomponents FIFO Entry Cache, File System Entry Cache, Soft Reference Entry Cache 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-extended-operation-handler-prop

Show Extended Operation Handler properties


get-extended-operation-handler-prop Arguments

--handler-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Extended Operation Handler or one of its subcomponents Administrative Session Extended Operation Handler, Backup Compatibility Extended Operation Handler, Batched Transactions Extended Operation Handler, Cancel Extended Operation Handler, Deliver OTP Extended Operation Handler, Deliver Password Reset Token Extended Operation Handler, Export Reversible Passwords Extended Operation Handler, Generate Password Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Get Configuration Extended Operation Handler, Get Connection ID Extended Operation Handler, Get Password Quality Requirements Extended Operation Handler, Get Supported OTP Delivery Mechanisms Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Interactive Transactions Extended Operation Handler, Multi Update Extended Operation Handler, Notification Subscription Extended Operation Handler, Password Modify Extended Operation Handler, Password Policy State Extended Operation Handler, Single Use Tokens Extended Operation Handler, Start TLS Extended Operation Handler, Stream Directory Values Extended Operation Handler, Stream Proxy Values Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Synchronize Encryption Settings Extended Operation Handler, Third Party Extended Operation Handler, Third Party Proxied Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Who Am I Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-external-server-prop

Show External Server properties


get-external-server-prop Arguments

--server-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for External Server or one of its subcomponents HTTP External Server, LDAP External Server, JDBC External Server, Kafka Cluster External Server, Mock External Server, SCIM External Server, SMTP 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-gauge-data-source-prop

Show Gauge Data Source properties


get-gauge-data-source-prop Arguments

--source-name {name}

Description The name of the Gauge Data Source
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Gauge Data Source or one of its subcomponents Indicator Gauge Data Source, Numeric Gauge Data Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-gauge-prop

Show Gauge properties


get-gauge-prop Arguments

--gauge-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-global-configuration-prop

Show Global Configuration properties


get-global-configuration-prop Arguments

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-group-implementation-prop

Show Group Implementation properties


get-group-implementation-prop Arguments

--implementation-name {name}

Description The name of the Group Implementation
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Group Implementation or one of its subcomponents Dynamic Group Implementation, Static Group Implementation, Virtual Static Group Implementation 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-http-configuration-prop

Show HTTP Configuration properties


get-http-configuration-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for HTTP 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-http-servlet-cross-origin-policy-prop

Show HTTP Servlet Cross Origin Policy properties


get-http-servlet-cross-origin-policy-prop Arguments

--policy-name {name}

Description The name of the HTTP Servlet Cross Origin Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Cross Origin 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-http-servlet-extension-prop

Show HTTP Servlet Extension properties


get-http-servlet-extension-prop Arguments

--extension-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Extension or one of its subcomponents Availability State HTTP Servlet Extension, Config HTTP Servlet Extension, Consent HTTP Servlet Extension, Delegated Admin HTTP Servlet Extension, Directory REST API HTTP Servlet Extension, File Server HTTP Servlet Extension, Gateway HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Metrics HTTP Servlet Extension, Open Banking HTTP Servlet Extension, PDP Endpoint HTTP Servlet Extension, Quickstart HTTP Servlet Extension, SCIM2 HTTP Servlet Extension, Sideband API HTTP Servlet Extension, Standard HTTP Servlet Extension, Third Party HTTP Servlet Extension, Velocity 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-identity-mapper-prop

Show Identity Mapper properties


get-identity-mapper-prop Arguments

--mapper-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Identity Mapper or one of its subcomponents Exact Match Identity Mapper, Scripted Identity Mapper, Regular Expression 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-inter-server-authentication-info-prop

Show Inter Server Authentication Info properties


get-inter-server-authentication-info-prop Arguments

--instance-name {name}

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

--listener-name {name}

Description The name of the Server Instance Listener
Required No
Multi-Valued No

--info-name {name}

Description The name of the Inter Server Authentication Info
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Inter Server Authentication Info or one of its subcomponents Certificate Inter Server Authentication Info, Password Inter Server Authentication Info 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-json-attribute-constraints-prop

Show JSON Attribute Constraints properties


get-json-attribute-constraints-prop Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for JSON Attribute Constraints 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-json-field-constraints-prop

Show JSON Field Constraints properties


get-json-field-constraints-prop Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--json-field {name}

Description The name of the JSON Field Constraints
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for JSON Field Constraints 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-key-manager-provider-prop

Show Key Manager Provider properties


get-key-manager-provider-prop Arguments

--provider-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Key Manager Provider or one of its subcomponents File Based Key Manager Provider, PKCS11 Key Manager Provider, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-key-pair-prop

Show Key Pair properties


get-key-pair-prop Arguments

--pair-name {name}

Description The name of the Key Pair
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Key Pair 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-ldap-sdk-debug-logger-prop

Show LDAP SDK Debug Logger properties


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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-license-prop

Show License properties


get-license-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for License 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-local-db-composite-index-prop

Show Local DB Composite Index properties


get-local-db-composite-index-prop Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB Composite Index
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Local DB Composite Index 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-local-db-index-prop

Show Local DB Index properties


get-local-db-index-prop Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB Index
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Local DB Index 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-local-db-vlv-index-prop

Show Local DB VLV Index properties


get-local-db-vlv-index-prop Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB VLV Index
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Local DB VLV Index 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-location-prop

Show Location properties


get-location-prop Arguments

--location-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-log-field-mapping-prop

Show Log Field Mapping properties


get-log-field-mapping-prop Arguments

--mapping-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Log Field Mapping or one of its subcomponents Access Log Field Mapping, Error 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-log-file-rotation-listener-prop

Show Log File Rotation Listener properties


get-log-file-rotation-listener-prop Arguments

--listener-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Log File Rotation Listener or one of its subcomponents Copy Log File Rotation Listener, Summarize Log File Rotation Listener, Third Party Log File Rotation Listener 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-log-publisher-prop

Show Log Publisher properties


get-log-publisher-prop Arguments

--publisher-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Error Log Publisher, Policy Decision Log Publisher, Sync Log Publisher, Trace 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-log-retention-policy-prop

Show Log Retention Policy properties


get-log-retention-policy-prop Arguments

--policy-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Log Retention Policy or one of its subcomponents File Count Log Retention Policy, Free Disk Space Log Retention Policy, Never Delete Log Retention Policy, Size Limit Log Retention Policy, Time Limit 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-log-rotation-policy-prop

Show Log Rotation Policy properties


get-log-rotation-policy-prop Arguments

--policy-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Log Rotation Policy or one of its subcomponents Fixed Time Log Rotation Policy, Never Rotate Log Rotation Policy, Size Limit Log Rotation Policy, Time Limit 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-mac-secret-key-prop

Show Mac Secret Key properties


get-mac-secret-key-prop Arguments

--instance-name {name}

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

--key-name {name}

Description The name of the Mac Secret Key
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-matching-rule-prop

Show Matching Rule properties


get-matching-rule-prop Arguments

--rule-name {name}

Description The name of the Matching Rule
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Matching Rule or one of its subcomponents Approximate Matching Rule, Equality Matching Rule, Ordering Matching Rule, Substring Matching Rule 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-monitor-provider-prop

Show Monitor Provider properties


get-monitor-provider-prop Arguments

--provider-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Entry Cache Monitor Provider, Host System Monitor Provider, Memory Usage Monitor Provider, SSL Context Monitor Provider, Stack Trace Monitor Provider, System Info Monitor Provider, Third Party Monitor Provider, Version 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-monitoring-endpoint-prop

Show Monitoring Endpoint properties


get-monitoring-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Monitoring Endpoint
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Monitoring Endpoint or one of its subcomponents StatsD Monitoring Endpoint 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-notification-manager-prop

Show Notification Manager properties


get-notification-manager-prop Arguments

--manager-name {name}

Description The name of the Notification Manager
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Notification Manager or one of its subcomponents Third Party Notification 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-oauth-token-handler-prop

Show OAuth Token Handler properties


get-oauth-token-handler-prop Arguments

--handler-name {name}

Description The name of the OAuth Token Handler
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for OAuth Token Handler or one of its subcomponents Scripted Oauth Token Handler, Third Party Oauth Token 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-obscured-value-prop

Show Obscured Value properties


get-obscured-value-prop Arguments

--value-name {name}

Description The name of the Obscured Value
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Obscured Value 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-otp-delivery-mechanism-prop

Show OTP Delivery Mechanism properties


get-otp-delivery-mechanism-prop Arguments

--mechanism-name {name}

Description The name of the OTP Delivery Mechanism
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for OTP Delivery Mechanism or one of its subcomponents Email OTP Delivery Mechanism, Third Party OTP Delivery Mechanism, Twilio OTP Delivery Mechanism 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-password-generator-prop

Show Password Generator properties


get-password-generator-prop Arguments

--generator-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Password Generator or one of its subcomponents Scripted Password Generator, Passphrase Password Generator, Random Password Generator, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-password-policy-prop

Show Password Policy properties


get-password-policy-prop Arguments

--policy-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-password-storage-scheme-prop

Show Password Storage Scheme properties


get-password-storage-scheme-prop Arguments

--scheme-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Password Storage Scheme or one of its subcomponents AES Password Storage Scheme, Argon2 Password Storage Scheme, Base64 Password Storage Scheme, Bcrypt Password Storage Scheme, Blowfish Password Storage Scheme, Clear Password Storage Scheme, Crypt Password Storage Scheme, MD5 Password Storage Scheme, PBKDF2 Password Storage Scheme, RC4 Password Storage Scheme, SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted SHA256 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA512 Password Storage Scheme, Scrypt Password Storage Scheme, Third Party Enhanced Password Storage Scheme, Third Party Password Storage Scheme, Triple DES 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-password-validator-prop

Show Password Validator properties


get-password-validator-prop Arguments

--validator-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Password Validator or one of its subcomponents Attribute Value Password Validator, Character Set Password Validator, Dictionary Password Validator, Scripted Password Validator, Haystack Password Validator, Length Based Password Validator, Pwned Passwords Password Validator, Regular Expression Password Validator, Repeated Characters Password Validator, Similarity Based Password Validator, Third Party Password Validator, Unique Characters 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-plugin-prop

Show Plugin properties


get-plugin-prop Arguments

--plugin-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Plugin or one of its subcomponents Attribute Mapper Plugin, Change Subscription Notification Plugin, Changelog Password Encryption Plugin, Purge Expired Data Plugin, DN Mapper Plugin, Delay Plugin, Encrypt Attribute Values Plugin, Entry UUID Plugin, Global Referential Integrity Plugin, Globally Unique Attribute Plugin, Scripted Plugin, Internal Search Rate Plugin, LDAP Attribute Description List Plugin, LDAP Result Code Tracker Plugin, Last Access Time Plugin, Last Mod Plugin, Monitor History Plugin, Pass Through Authentication Plugin, Password Policy Import Plugin, Periodic GC Plugin, Stats Plugin, Ping One For Customers Pass Through Authentication Plugin, Profiler Plugin, Pre Update Config Plugin, Processing Time Histogram Plugin, Referential Integrity Plugin, Referral On Update Plugin, SNMP Master Agent Plugin, SNMP Subagent Plugin, Search Shutdown Plugin, Seven Bit Clean Plugin, Simple To External Bind Plugin, Sub Operation Timing Plugin, Third Party Plugin, Unique Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-plugin-root-prop

Show Plugin Root properties


get-plugin-root-prop Arguments

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-policy-configuration-key-prop

Show Policy Configuration Key properties


get-policy-configuration-key-prop Arguments

--key-name {name}

Description The name of the Policy Configuration Key
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Policy Configuration Key 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-recurring-task-chain-prop

Show Recurring Task Chain properties


get-recurring-task-chain-prop Arguments

--chain-name {name}

Description The name of the Recurring Task Chain
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task Chain 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-recurring-task-prop

Show Recurring Task properties


get-recurring-task-prop Arguments

--task-name {name}

Description The name of the Recurring Task
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task or one of its subcomponents Backup Recurring Task, Delay Recurring Task, Enter Lockdown Mode Recurring Task, Exec Recurring Task, File Retention Recurring Task, LDIF Export Recurring Task, Leave Lockdown Mode Recurring Task, Statically Defined Recurring Task, Third Party Recurring Task 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-replication-assurance-policy-prop

Show Replication Assurance Policy properties


get-replication-assurance-policy-prop Arguments

--policy-name {name}

Description The name of the Replication Assurance Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Replication Assurance 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-replication-domain-prop

Show Replication Domain properties


get-replication-domain-prop Arguments

--provider-name {name}

Description The name of the Replication Synchronization Provider
Required No
Multi-Valued No

--domain-name {name}

Description The name of the Replication Domain
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Replication Domain 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-replication-server-prop

Show Replication Server properties


get-replication-server-prop Arguments

--provider-name {name}

Description The name of the Replication Synchronization Provider
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Replication 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-request-criteria-prop

Show Request Criteria properties


get-request-criteria-prop Arguments

--criteria-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Request Criteria or one of its subcomponents Aggregate Request Criteria, Root DSE Request Criteria, Simple Request Criteria, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-rest-resource-type-prop

Show REST Resource Type properties


get-rest-resource-type-prop Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for REST Resource Type or one of its subcomponents Group REST Resource Type, User REST Resource Type 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-result-code-map-prop

Show Result Code Map properties


get-result-code-map-prop Arguments

--map-name {name}

Description The name of the Result Code Map
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-result-criteria-prop

Show Result Criteria properties


get-result-criteria-prop Arguments

--criteria-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Replication Assurance Result Criteria, Simple Result Criteria, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-root-dn-prop

Show Root DN properties


get-root-dn-prop Arguments

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-root-dn-user-prop

Show Root DN User properties


get-root-dn-user-prop Arguments

--user-name {name}

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

--property {property}

Description The name of a property to be displayed
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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-root-dse-backend-prop

Show Root DSE Backend properties


get-root-dse-backend-prop Arguments

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-sasl-mechanism-handler-prop

Show SASL Mechanism Handler properties


get-sasl-mechanism-handler-prop Arguments

--handler-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for SASL Mechanism Handler or one of its subcomponents Anonymous SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler, External SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Plain SASL Mechanism Handler, Third Party SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, UnboundID Delivered OTP SASL Mechanism Handler, UnboundID External Auth SASL Mechanism Handler, UnboundID Inter Server SASL Mechanism Handler, UnboundID Ms Chap V2 SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Yubikey OTP 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-scim-attribute-mapping-prop

Show SCIM Attribute Mapping properties


get-scim-attribute-mapping-prop Arguments

--type-name {name}

Description The name of the LDAP Mapping SCIM Resource Type
Required No
Multi-Valued No

--mapping-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

--tab-delimited

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-scim-attribute-prop

Show SCIM Attribute properties


get-scim-attribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-scim-resource-type-prop

Show SCIM Resource Type properties


get-scim-resource-type-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Resource Type or one of its subcomponents Mapping SCIM Resource Type, Pass Through SCIM Resource Type 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-scim-schema-prop

Show SCIM Schema properties


get-scim-schema-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Schema 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-scim-subattribute-prop

Show SCIM Subattribute properties


get-scim-subattribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--subattribute-name {name}

Description The name of the SCIM Subattribute
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Subattribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-search-entry-criteria-prop

Show Search Entry Criteria properties


get-search-entry-criteria-prop Arguments

--criteria-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Search Entry Criteria or one of its subcomponents Aggregate Search Entry Criteria, Simple Search Entry Criteria, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-search-reference-criteria-prop

Show Search Reference Criteria properties


get-search-reference-criteria-prop Arguments

--criteria-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Search Reference Criteria or one of its subcomponents Aggregate Search Reference Criteria, Simple Search Reference Criteria, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-sensitive-attribute-prop

Show Sensitive Attribute properties


get-sensitive-attribute-prop Arguments

--attribute-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Sensitive Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-server-group-prop

Show Server Group properties


get-server-group-prop Arguments

--group-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Server Group 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-server-instance-listener-prop

Show Server Instance Listener properties


get-server-instance-listener-prop Arguments

--instance-name {name}

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

--listener-name {name}

Description The name of the Server Instance Listener
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance Listener or one of its subcomponents HTTP Server Instance Listener, LDAP Server Instance Listener 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-server-instance-prop

Show Server Instance properties


get-server-instance-prop Arguments

--instance-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance or one of its subcomponents Directory Server Instance, Governance Server Instance, Metrics Engine Server Instance, Proxy Server Instance, Sync Server Instance 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-soft-delete-policy-prop

Show Soft Delete Policy properties


get-soft-delete-policy-prop Arguments

--policy-name {name}

Description The name of the Soft Delete Policy
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Soft Delete 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-synchronization-provider-prop

Show Synchronization Provider properties


get-synchronization-provider-prop Arguments

--provider-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Synchronization Provider or one of its subcomponents Replication Synchronization 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-topology-admin-user-prop

Show Topology Admin User properties


get-topology-admin-user-prop Arguments

--user-name {name}

Description The name of the Topology Admin User
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed
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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-trust-manager-provider-prop

Show Trust Manager Provider properties


get-trust-manager-provider-prop Arguments

--provider-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Trust Manager Provider or one of its subcomponents Blind Trust Manager Provider, File Based Trust Manager Provider, JVM Default Trust Manager Provider, Third Party 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-trusted-certificate-prop

Show Trusted Certificate properties


get-trusted-certificate-prop Arguments

--certificate-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Trusted Certificate 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-uncached-attribute-criteria-prop

Show Uncached Attribute Criteria properties


get-uncached-attribute-criteria-prop Arguments

--criteria-name {name}

Description The name of the Uncached Attribute Criteria
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Uncached Attribute Criteria or one of its subcomponents Default Uncached Attribute Criteria, Scripted Uncached Attribute Criteria, Simple Uncached Attribute Criteria, Third Party Uncached Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-uncached-entry-criteria-prop

Show Uncached Entry Criteria properties


get-uncached-entry-criteria-prop Arguments

--criteria-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Uncached Entry Criteria or one of its subcomponents Default Uncached Entry Criteria, Filter Based Uncached Entry Criteria, Scripted Uncached Entry Criteria, Last Access Time Uncached Entry Criteria, Third Party Uncached 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-vault-authentication-method-prop

Show Vault Authentication Method properties


get-vault-authentication-method-prop Arguments

--method-name {name}

Description The name of the Vault Authentication Method
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Vault Authentication Method or one of its subcomponents App Role Vault Authentication Method, Static Token Vault Authentication Method, User Pass Vault Authentication Method 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-velocity-context-provider-prop

Show Velocity Context Provider properties


get-velocity-context-provider-prop Arguments

--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 Third Party Velocity Context Provider, Velocity Tools 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-velocity-template-loader-prop

Show Velocity Template Loader properties


get-velocity-template-loader-prop Arguments

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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-virtual-attribute-prop

Show Virtual Attribute properties


get-virtual-attribute-prop Arguments

--name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Virtual Attribute or one of its subcomponents Config Model Virtual Attribute, Constructed Virtual Attribute, Current Time Virtual Attribute, Entry Checksum Virtual Attribute, Entry DN Virtual Attribute, Entry UUID Virtual Attribute, Expand Timestamp Virtual Attribute, File Based Virtual Attribute, Scripted Virtual Attribute, Has Subordinates Virtual Attribute, Identify References Virtual Attribute, Instance Name Virtual Attribute, Is Member Of Virtual Attribute, Large Attribute Virtual Attribute, Member Of Server Group Virtual Attribute, Member Virtual Attribute, Mirror Virtual Attribute, Num Subordinates Virtual Attribute, Replication State Detail Virtual Attribute, Short Unique ID Virtual Attribute, Subschema Subentry Virtual Attribute, Third Party Virtual Attribute, User Defined Virtual Attribute 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-web-application-extension-prop

Show Web Application Extension properties


get-web-application-extension-prop Arguments

--extension-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Web Application Extension or one of its subcomponents Console 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

get-work-queue-prop

Show Work Queue properties


get-work-queue-prop Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Work Queue or one of its subcomponents Caller Invoked Work Queue, Canned Response Work Queue, High Throughput Work Queue, Traditional Work Queue, Wait Notify 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

--suppress-undefined-properties

Description Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option

list-access-token-validators

List existing Access Token Validators


list-access-token-validators Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Access Token Validator or one of its subcomponents External Access Token Validator, Mock Access Token Validator, Third Party Access Token Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-account-status-notification-handlers

List existing Account Status Notification Handlers


list-account-status-notification-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Account Status Notification Handler or one of its subcomponents Error Log Account Status Notification Handler, Scripted Account Status Notification Handler, Multi Part Email Account Status Notification Handler, SMTP Account Status Notification Handler, Third Party Account Status Notification Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-alert-handlers

List existing Alert Handlers


list-alert-handlers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-attribute-syntaxes

List existing Attribute Syntaxes


list-backends

List existing Backends


list-backends Arguments

--property {property}

Description The name of a property to be displayed.

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

list-certificate-mappers

List existing Certificate Mappers


list-certificate-mappers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-change-subscription-handlers

List existing Change Subscription Handlers


list-change-subscription-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Change Subscription Handler or one of its subcomponents Scripted Change Subscription Handler, Logging Change Subscription Handler, Third Party Change Subscription Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-change-subscriptions

List existing Change Subscriptions


list-change-subscriptions Arguments

--property {property}

Description The name of a property to be displayed.

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

list-cipher-secret-keys

List existing Cipher Secret Keys


list-cipher-secret-keys Arguments

--instance-name {name}

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

--property {property}

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

list-cipher-stream-providers

List existing Cipher Stream Providers


list-cipher-stream-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, Default Cipher Stream Provider, File Based Cipher Stream Provider, Third Party Cipher Stream Provider, Vault Cipher Stream Provider, Wait For Passphrase Cipher Stream Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-client-connection-policies

List existing Client Connection Policies


list-client-connection-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

list-connection-criteria

List existing Connection Criteria


list-connection-criteria Arguments

--property {property}

Description The name of a property to be displayed.

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

list-connection-handlers

List existing Connection Handlers


list-connection-handlers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-consent-definition-localizations

List existing Consent Definition Localizations


list-consent-definition-localizations Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Consent Definition Localization in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-consent-definitions

List existing Consent Definitions


list-consent-definitions Arguments

--property {property}

Description The name of a property to be displayed.

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

list-constructed-attributes

List existing Constructed Attributes


list-constructed-attributes Arguments

--property {property}

Description The name of a property to be displayed.

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

list-custom-logged-stats

List existing Custom Logged Stats


list-custom-logged-stats Arguments

--plugin-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

list-data-security-auditors

List existing Data Security Auditors


list-data-security-auditors Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Data Security Auditor or one of its subcomponents Access Control Data Security Auditor, Disabled Account Data Security Auditor, Expired Password Data Security Auditor, Locked Account Data Security Auditor, Multiple Password Data Security Auditor, Privilege Data Security Auditor, Weakly Encoded Password Data Security Auditor in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-debug-targets

List existing Debug Targets


list-debug-targets Arguments

--publisher-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

list-delegated-admin-attribute-categories

List existing Delegated Admin Attribute Categories


list-delegated-admin-attribute-categories Arguments

--property {property}

Description The name of a property to be displayed.

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

list-delegated-admin-attributes

List existing Delegated Admin Attributes


list-delegated-admin-attributes Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

list-delegated-admin-resource-rights

List existing Delegated Admin Resource Rights


list-delegated-admin-resource-rights Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Delegated Admin Resource Rights in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-delegated-admin-rights

List existing Delegated Admin Rights


list-delegated-admin-rights Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Delegated Admin Rights in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-dn-maps

List existing DN Maps


list-dn-maps Arguments

--property {property}

Description The name of a property to be displayed.

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

list-entry-caches

List existing Entry Caches


list-entry-caches Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Entry Cache or one of its subcomponents FIFO Entry Cache, File System Entry Cache, Soft Reference Entry Cache in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-extended-operation-handlers

List existing Extended Operation Handlers


list-extended-operation-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Extended Operation Handler or one of its subcomponents Administrative Session Extended Operation Handler, Backup Compatibility Extended Operation Handler, Batched Transactions Extended Operation Handler, Cancel Extended Operation Handler, Deliver OTP Extended Operation Handler, Deliver Password Reset Token Extended Operation Handler, Export Reversible Passwords Extended Operation Handler, Generate Password Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Get Configuration Extended Operation Handler, Get Connection ID Extended Operation Handler, Get Password Quality Requirements Extended Operation Handler, Get Supported OTP Delivery Mechanisms Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Interactive Transactions Extended Operation Handler, Multi Update Extended Operation Handler, Notification Subscription Extended Operation Handler, Password Modify Extended Operation Handler, Password Policy State Extended Operation Handler, Single Use Tokens Extended Operation Handler, Start TLS Extended Operation Handler, Stream Directory Values Extended Operation Handler, Stream Proxy Values Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Synchronize Encryption Settings Extended Operation Handler, Third Party Extended Operation Handler, Third Party Proxied Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Who Am I Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-external-servers

List existing External Servers


list-external-servers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-gauge-data-sources

List existing Gauge Data Sources


list-gauge-data-sources Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Gauge Data Source or one of its subcomponents Indicator Gauge Data Source, Numeric Gauge Data Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-gauges

List existing Gauges


list-gauges Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-group-implementations

List existing Group Implementations


list-group-implementations Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Group Implementation or one of its subcomponents Dynamic Group Implementation, Static Group Implementation, Virtual Static Group Implementation in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-http-servlet-cross-origin-policies

List existing HTTP Servlet Cross Origin Policies


list-http-servlet-cross-origin-policies Arguments

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Cross Origin Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-http-servlet-extensions

List existing HTTP Servlet Extensions


list-http-servlet-extensions Arguments

--property {property}

Description The name of a property to be displayed.

See properties for HTTP Servlet Extension or one of its subcomponents Availability State HTTP Servlet Extension, Config HTTP Servlet Extension, Consent HTTP Servlet Extension, Delegated Admin HTTP Servlet Extension, Directory REST API HTTP Servlet Extension, File Server HTTP Servlet Extension, Gateway HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Metrics HTTP Servlet Extension, Open Banking HTTP Servlet Extension, PDP Endpoint HTTP Servlet Extension, Quickstart HTTP Servlet Extension, SCIM2 HTTP Servlet Extension, Sideband API HTTP Servlet Extension, Standard HTTP Servlet Extension, Third Party HTTP Servlet Extension, Velocity HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-identity-mappers

List existing Identity Mappers


list-identity-mappers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-inter-server-authentication-info

List existing Inter Server Authentication Info


list-inter-server-authentication-info Arguments

--instance-name {name}

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

--listener-name {name}

Description The name of the Server Instance Listener
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for Inter Server Authentication Info or one of its subcomponents Certificate Inter Server Authentication Info, Password Inter Server Authentication Info in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-json-attribute-constraints

List existing JSON Attribute Constraints


list-json-attribute-constraints Arguments

--property {property}

Description The name of a property to be displayed.

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

list-json-field-constraints

List existing JSON Field Constraints


list-json-field-constraints Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

See properties for JSON Field Constraints in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-key-manager-providers

List existing Key Manager Providers


list-key-manager-providers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-key-pairs

List existing Key Pairs


list-key-pairs Arguments

--property {property}

Description The name of a property to be displayed.

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

list-local-db-composite-indexes

List existing Local DB Composite Indexes


list-local-db-composite-indexes Arguments

--backend-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Local DB Composite Index in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-local-db-indexes

List existing Local DB Indexes


list-local-db-indexes Arguments

--backend-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Local DB Index in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-local-db-vlv-indexes

List existing Local DB VLV Indexes


list-local-db-vlv-indexes Arguments

--backend-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Local DB VLV Index in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-locations

List existing Locations


list-locations Arguments

--property {property}

Description The name of a property to be displayed.

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

list-log-field-mappings

List existing Log Field Mappings


list-log-field-mappings Arguments

--property {property}

Description The name of a property to be displayed.

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

list-log-file-rotation-listeners

List existing Log File Rotation Listeners


list-log-file-rotation-listeners Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Log File Rotation Listener or one of its subcomponents Copy Log File Rotation Listener, Summarize Log File Rotation Listener, Third Party Log File Rotation Listener in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-log-publishers

List existing Log Publishers


list-log-publishers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-log-retention-policies

List existing Log Retention Policies


list-log-retention-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

list-log-rotation-policies

List existing Log Rotation Policies


list-log-rotation-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

list-mac-secret-keys

List existing Mac Secret Keys


list-mac-secret-keys Arguments

--instance-name {name}

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

--property {property}

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

list-matching-rules

List existing Matching Rules


list-matching-rules Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Matching Rule or one of its subcomponents Approximate Matching Rule, Equality Matching Rule, Ordering Matching Rule, Substring Matching Rule in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-monitor-providers

List existing Monitor Providers


list-monitor-providers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-monitoring-endpoints

List existing Monitoring Endpoints


list-monitoring-endpoints Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Monitoring Endpoint or one of its subcomponents StatsD Monitoring Endpoint in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-notification-managers

List existing Notification Managers


list-notification-managers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Notification Manager or one of its subcomponents Third Party Notification Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-oauth-token-handlers

List existing OAuth Token Handlers


list-oauth-token-handlers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for OAuth Token Handler or one of its subcomponents Scripted Oauth Token Handler, Third Party Oauth Token Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-obscured-values

List existing Obscured Values


list-obscured-values Arguments

--property {property}

Description The name of a property to be displayed.

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

list-otp-delivery-mechanisms

List existing OTP Delivery Mechanisms


list-otp-delivery-mechanisms Arguments

--property {property}

Description The name of a property to be displayed.

See properties for OTP Delivery Mechanism or one of its subcomponents Email OTP Delivery Mechanism, Third Party OTP Delivery Mechanism, Twilio OTP Delivery Mechanism in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-password-generators

List existing Password Generators


list-password-generators Arguments

--property {property}

Description The name of a property to be displayed.

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

list-password-policies

List existing Password Policies


list-password-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

list-password-storage-schemes

List existing Password Storage Schemes


list-password-storage-schemes Arguments

--property {property}

Description The name of a property to be displayed.

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

list-password-validators

List existing Password Validators


list-plugins

List existing Plugins


list-plugins Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Plugin or one of its subcomponents Attribute Mapper Plugin, Change Subscription Notification Plugin, Changelog Password Encryption Plugin, Purge Expired Data Plugin, DN Mapper Plugin, Delay Plugin, Encrypt Attribute Values Plugin, Entry UUID Plugin, Global Referential Integrity Plugin, Globally Unique Attribute Plugin, Scripted Plugin, Internal Search Rate Plugin, LDAP Attribute Description List Plugin, LDAP Result Code Tracker Plugin, Last Access Time Plugin, Last Mod Plugin, Monitor History Plugin, Pass Through Authentication Plugin, Password Policy Import Plugin, Periodic GC Plugin, Stats Plugin, Ping One For Customers Pass Through Authentication Plugin, Profiler Plugin, Pre Update Config Plugin, Processing Time Histogram Plugin, Referential Integrity Plugin, Referral On Update Plugin, SNMP Master Agent Plugin, SNMP Subagent Plugin, Search Shutdown Plugin, Seven Bit Clean Plugin, Simple To External Bind Plugin, Sub Operation Timing Plugin, Third Party Plugin, Unique Attribute Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-policy-configuration-keys

List existing Policy Configuration Keys


list-policy-configuration-keys Arguments

--property {property}

Description The name of a property to be displayed.

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

list-properties

Describes managed objects and their properties


list-properties Arguments

-c {category}
--category {category}

Description The category of components whose properties should be described. 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-recurring-task-chains

List existing Recurring Task Chains


list-recurring-task-chains Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task Chain in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-recurring-tasks

List existing Recurring Tasks


list-recurring-tasks Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Recurring Task or one of its subcomponents Backup Recurring Task, Delay Recurring Task, Enter Lockdown Mode Recurring Task, Exec Recurring Task, File Retention Recurring Task, LDIF Export Recurring Task, Leave Lockdown Mode Recurring Task, Statically Defined Recurring Task, Third Party Recurring Task in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-replication-assurance-policies

List existing Replication Assurance Policies


list-replication-assurance-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

list-replication-domains

List existing Replication Domains


list-replication-domains Arguments

--provider-name {name}

Description The name of the Replication Synchronization Provider
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

list-request-criteria

List existing Request Criteria


list-request-criteria Arguments

--property {property}

Description The name of a property to be displayed.

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

list-rest-resource-types

List existing REST Resource Types


list-rest-resource-types Arguments

--property {property}

Description The name of a property to be displayed.

See properties for REST Resource Type or one of its subcomponents Group REST Resource Type, User REST Resource Type in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-result-code-maps

List existing Result Code Maps


list-result-code-maps Arguments

--property {property}

Description The name of a property to be displayed.

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

list-result-criteria

List existing Result Criteria


list-result-criteria Arguments

--property {property}

Description The name of a property to be displayed.

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

list-root-dn-users

List existing Root DN Users


list-root-dn-users Arguments

--property {property}

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

list-sasl-mechanism-handlers

List existing SASL Mechanism Handlers


list-sasl-mechanism-handlers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-scim-attribute-mappings

List existing SCIM Attribute Mappings


list-scim-attribute-mappings Arguments

--type-name {name}

Description The name of the LDAP Mapping SCIM Resource Type
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

list-scim-attributes

List existing SCIM Attributes


list-scim-attributes Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--property {property}

Description The name of a property to be displayed.

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

list-scim-resource-types

List existing SCIM Resource Types


list-scim-resource-types Arguments

--property {property}

Description The name of a property to be displayed.

See properties for SCIM Resource Type or one of its subcomponents Mapping SCIM Resource Type, Pass Through SCIM Resource Type in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-scim-schemas

List existing SCIM Schemas


list-scim-schemas Arguments

--property {property}

Description The name of a property to be displayed.

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

list-scim-subattributes

List existing SCIM Subattributes


list-scim-subattributes Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--property {property}

Description The name of a property to be displayed.

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

list-search-entry-criteria

List existing Search Entry Criteria


list-search-entry-criteria Arguments

--property {property}

Description The name of a property to be displayed.

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

list-search-reference-criteria

List existing Search Reference Criteria


list-search-reference-criteria Arguments

--property {property}

Description The name of a property to be displayed.

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

list-sensitive-attributes

List existing Sensitive Attributes


list-sensitive-attributes Arguments

--property {property}

Description The name of a property to be displayed.

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

list-server-groups

List existing Server Groups


list-server-groups Arguments

--property {property}

Description The name of a property to be displayed.

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

list-server-instance-listeners

List existing Server Instance Listeners


list-server-instance-listeners Arguments

--instance-name {name}

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

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance Listener or one of its subcomponents HTTP Server Instance Listener, LDAP Server Instance Listener in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-server-instances

List existing Server Instances


list-server-instances Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Server Instance or one of its subcomponents Directory Server Instance, Governance Server Instance, Metrics Engine Server Instance, Proxy Server Instance, Sync Server Instance in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-soft-delete-policies

List existing Soft Delete Policies


list-soft-delete-policies Arguments

--property {property}

Description The name of a property to be displayed.

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

list-synchronization-providers

List existing Synchronization Providers


list-synchronization-providers Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Synchronization Provider or one of its subcomponents Replication Synchronization Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-topology-admin-users

List existing Topology Admin Users


list-topology-admin-users Arguments

--property {property}

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

list-trust-manager-providers

List existing Trust Manager Providers


list-trust-manager-providers Arguments

--property {property}

Description The name of a property to be displayed.

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

list-trusted-certificates

List existing Trusted Certificates


list-trusted-certificates Arguments

--property {property}

Description The name of a property to be displayed.

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

list-uncached-attribute-criteria

List existing Uncached Attribute Criteria


list-uncached-attribute-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Uncached Attribute Criteria or one of its subcomponents Default Uncached Attribute Criteria, Scripted Uncached Attribute Criteria, Simple Uncached Attribute Criteria, Third Party Uncached Attribute Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-uncached-entry-criteria

List existing Uncached Entry Criteria


list-uncached-entry-criteria Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Uncached Entry Criteria or one of its subcomponents Default Uncached Entry Criteria, Filter Based Uncached Entry Criteria, Scripted Uncached Entry Criteria, Last Access Time Uncached Entry Criteria, Third Party Uncached Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-vault-authentication-methods

List existing Vault Authentication Methods


list-vault-authentication-methods Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Vault Authentication Method or one of its subcomponents App Role Vault Authentication Method, Static Token Vault Authentication Method, User Pass Vault Authentication Method in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-velocity-context-providers

List existing Velocity Context Providers


list-velocity-context-providers Arguments

--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 Third Party Velocity Context Provider, Velocity Tools Velocity Context Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-velocity-template-loaders

List existing Velocity Template Loaders


list-velocity-template-loaders Arguments

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

list-virtual-attributes

List existing Virtual Attributes


list-virtual-attributes Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Virtual Attribute or one of its subcomponents Config Model Virtual Attribute, Constructed Virtual Attribute, Current Time Virtual Attribute, Entry Checksum Virtual Attribute, Entry DN Virtual Attribute, Entry UUID Virtual Attribute, Expand Timestamp Virtual Attribute, File Based Virtual Attribute, Scripted Virtual Attribute, Has Subordinates Virtual Attribute, Identify References Virtual Attribute, Instance Name Virtual Attribute, Is Member Of Virtual Attribute, Large Attribute Virtual Attribute, Member Of Server Group Virtual Attribute, Member Virtual Attribute, Mirror Virtual Attribute, Num Subordinates Virtual Attribute, Replication State Detail Virtual Attribute, Short Unique ID Virtual Attribute, Subschema Subentry Virtual Attribute, Third Party Virtual Attribute, User Defined Virtual Attribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

list-web-application-extensions

List existing Web Application Extensions


list-web-application-extensions Arguments

--property {property}

Description The name of a property to be displayed.

See properties for Web Application Extension or one of its subcomponents Console Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

set-access-control-handler-prop

Modify Access Control Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-access-control-handler-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-access-token-validator-prop

Modify Access Token Validator properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-access-token-validator-prop Arguments

--validator-name {name}

Description The name of the Access Token Validator
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Token Validator or one of its subcomponents External Access Token Validator, Mock Access Token Validator, Third Party Access Token Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-account-status-notification-handler-prop

Modify Account Status Notification Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-account-status-notification-handler-prop Arguments

--handler-name {name}

Description The name of the Account Status Notification Handler
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Account Status Notification Handler or one of its subcomponents Error Log Account Status Notification Handler, Scripted Account Status Notification Handler, Multi Part Email Account Status Notification Handler, SMTP Account Status Notification Handler, Third Party Account Status Notification Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-alarm-manager-prop

Modify Alarm Manager properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-alarm-manager-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Alarm Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-alert-handler-prop

Modify Alert Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-alert-handler-prop Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Error Log Alert Handler, Exec Alert Handler, Scripted Alert Handler, JMX Alert Handler, SMTP Alert Handler, SNMP Alert Handler, SNMP Sub Agent Alert Handler, Third Party Alert Handler, Twilio Alert Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-attribute-syntax-prop

Modify Attribute Syntax properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-attribute-syntax-prop Arguments

--syntax-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--reset {property}

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

See properties for Attribute Syntax or one of its subcomponents Attribute Type Description Attribute Syntax, Bit String Attribute Syntax, Boolean Attribute Syntax, Directory String Attribute Syntax, Distinguished Name Attribute Syntax, Generalized Time Attribute Syntax, Hex String Attribute Syntax, Integer Attribute Syntax, JSON Object Attribute Syntax, LDAP URL Attribute Syntax, Name And Optional UID Attribute Syntax, Telephone Number Attribute Syntax, UUID Attribute Syntax, User Password Attribute Syntax in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-backend-prop

Modify Backend properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-backend-prop Arguments

--backend-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Notification Backend, Backup Backend, Canned Response Backend, Changelog Backend, Config File Handler Backend, Encryption Settings Backend, JE Backend, LDIF Backend, Memory Backend, Metrics Backend, Monitor Backend, Schema Backend, Task Backend, Trust Store Backend in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-certificate-mapper-prop

Modify Certificate Mapper properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-certificate-mapper-prop Arguments

--mapper-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Fingerprint Certificate Mapper, Scripted Certificate Mapper, Subject Attribute To User Attribute Certificate Mapper, Subject DN To User Attribute Certificate Mapper, Subject Equals DN Certificate Mapper, Third Party Certificate Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-change-subscription-handler-prop

Modify Change Subscription Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-change-subscription-handler-prop Arguments

--handler-name {name}

Description The name of the Change Subscription Handler
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Change Subscription Handler or one of its subcomponents Scripted Change Subscription Handler, Logging Change Subscription Handler, Third Party Change Subscription Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-change-subscription-prop

Modify Change Subscription properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-change-subscription-prop Arguments

--subscription-name {name}

Description The name of the Change Subscription
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Change Subscription in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-cipher-secret-key-prop

Modify Cipher Secret Key properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-cipher-secret-key-prop Arguments

--instance-name {name}

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

--key-name {name}

Description The name of the Cipher Secret Key
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-cipher-stream-provider-prop

Modify Cipher Stream Provider properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-cipher-stream-provider-prop Arguments

--provider-name {name}

Description The name of the Cipher Stream Provider
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, Default Cipher Stream Provider, File Based Cipher Stream Provider, Third Party Cipher Stream Provider, Vault Cipher Stream Provider, Wait For Passphrase Cipher Stream Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-client-connection-policy-prop

Modify Client Connection Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-client-connection-policy-prop Arguments

--policy-name {name}

Description The name of the Client Connection Policy
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Client Connection Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-connection-criteria-prop

Modify Connection Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-connection-criteria-prop Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--reset {property}

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

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

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-connection-handler-prop

Modify Connection Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-connection-handler-prop Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 HTTP Connection Handler, JMX Connection Handler, LDAP Connection Handler, LDIF Connection Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-consent-definition-localization-prop

Modify Consent Definition Localization properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-consent-definition-localization-prop Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--localization-name {name}

Description The name of the Consent Definition Localization
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Consent Definition Localization in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-consent-definition-prop

Modify Consent Definition properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-consent-definition-prop Arguments

--definition-name {name}

Description The name of the Consent Definition
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Consent Definition in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-consent-service-prop

Modify Consent Service properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-consent-service-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Consent Service in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-constructed-attribute-prop

Modify Constructed Attribute properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-constructed-attribute-prop Arguments

--attribute-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Constructed Attribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-crypto-manager-prop

Modify Crypto Manager properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-crypto-manager-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-custom-logged-stats-prop

Modify Custom Logged Stats properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-custom-logged-stats-prop Arguments

--plugin-name {name}

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

--stats-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-data-security-auditor-prop

Modify Data Security Auditor properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-data-security-auditor-prop Arguments

--auditor-name {name}

Description The name of the Data Security Auditor
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Data Security Auditor or one of its subcomponents Access Control Data Security Auditor, Disabled Account Data Security Auditor, Expired Password Data Security Auditor, Locked Account Data Security Auditor, Multiple Password Data Security Auditor, Privilege Data Security Auditor, Weakly Encoded Password Data Security Auditor in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-debug-target-prop

Modify Debug Target properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-debug-target-prop Arguments

--publisher-name {name}

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

--target-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-delegated-admin-attribute-category-prop

Modify Delegated Admin Attribute Category properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-delegated-admin-attribute-category-prop Arguments

--display-name {name}

Description The name of the Delegated Admin Attribute Category
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Delegated Admin Attribute Category in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-delegated-admin-attribute-prop

Modify Delegated Admin Attribute properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-delegated-admin-attribute-prop Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--attribute-type {name}

Description The name of the Delegated Admin Attribute
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Delegated Admin Attribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-delegated-admin-resource-rights-prop

Modify Delegated Admin Resource Rights properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-delegated-admin-resource-rights-prop Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--rest-resource-type {name}

Description The name of the Delegated Admin Resource Rights
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Delegated Admin Resource Rights in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-delegated-admin-rights-prop

Modify Delegated Admin Rights properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-delegated-admin-rights-prop Arguments

--rights-name {name}

Description The name of the Delegated Admin Rights
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Delegated Admin Rights in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-dn-map-prop

Modify DN Map properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-dn-map-prop Arguments

--map-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--reset {property}

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

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

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-entry-cache-prop

Modify Entry Cache properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-entry-cache-prop Arguments

--cache-name {name}

Description The name of the Entry Cache
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Entry Cache or one of its subcomponents FIFO Entry Cache, File System Entry Cache, Soft Reference Entry Cache in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-extended-operation-handler-prop

Modify Extended Operation Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-extended-operation-handler-prop Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--reset {property}

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

See properties for Extended Operation Handler or one of its subcomponents Administrative Session Extended Operation Handler, Backup Compatibility Extended Operation Handler, Batched Transactions Extended Operation Handler, Cancel Extended Operation Handler, Deliver OTP Extended Operation Handler, Deliver Password Reset Token Extended Operation Handler, Export Reversible Passwords Extended Operation Handler, Generate Password Extended Operation Handler, Get Changelog Batch Extended Operation Handler, Get Configuration Extended Operation Handler, Get Connection ID Extended Operation Handler, Get Password Quality Requirements Extended Operation Handler, Get Supported OTP Delivery Mechanisms Extended Operation Handler, Get Symmetric Key Extended Operation Handler, Interactive Transactions Extended Operation Handler, Multi Update Extended Operation Handler, Notification Subscription Extended Operation Handler, Password Modify Extended Operation Handler, Password Policy State Extended Operation Handler, Single Use Tokens Extended Operation Handler, Start TLS Extended Operation Handler, Stream Directory Values Extended Operation Handler, Stream Proxy Values Extended Operation Handler, Subtree Accessibility Extended Operation Handler, Synchronize Encryption Settings Extended Operation Handler, Third Party Extended Operation Handler, Third Party Proxied Extended Operation Handler, Validate TOTP Password Extended Operation Handler, Who Am I Extended Operation Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-external-server-prop

Modify External Server properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-external-server-prop Arguments

--server-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 HTTP External Server, LDAP External Server, JDBC External Server, Kafka Cluster External Server, Mock External Server, SCIM External Server, SMTP External Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-gauge-data-source-prop

Modify Gauge Data Source properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-gauge-data-source-prop Arguments

--source-name {name}

Description The name of the Gauge Data Source
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Gauge Data Source or one of its subcomponents Indicator Gauge Data Source, Numeric Gauge Data Source in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-gauge-prop

Modify Gauge properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-gauge-prop Arguments

--gauge-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-global-configuration-prop

Modify Global Configuration properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-global-configuration-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-group-implementation-prop

Modify Group Implementation properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-group-implementation-prop Arguments

--implementation-name {name}

Description The name of the Group Implementation
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Group Implementation or one of its subcomponents Dynamic Group Implementation, Static Group Implementation, Virtual Static Group Implementation in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-http-configuration-prop

Modify HTTP Configuration properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-http-configuration-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Configuration in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-http-servlet-cross-origin-policy-prop

Modify HTTP Servlet Cross Origin Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-http-servlet-cross-origin-policy-prop Arguments

--policy-name {name}

Description The name of the HTTP Servlet Cross Origin Policy
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Cross Origin Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-http-servlet-extension-prop

Modify HTTP Servlet Extension properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-http-servlet-extension-prop Arguments

--extension-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Availability State HTTP Servlet Extension, Config HTTP Servlet Extension, Consent HTTP Servlet Extension, Delegated Admin HTTP Servlet Extension, Directory REST API HTTP Servlet Extension, File Server HTTP Servlet Extension, Gateway HTTP Servlet Extension, Scripted HTTP Servlet Extension, SCIM HTTP Servlet Extension, Metrics HTTP Servlet Extension, Open Banking HTTP Servlet Extension, PDP Endpoint HTTP Servlet Extension, Quickstart HTTP Servlet Extension, SCIM2 HTTP Servlet Extension, Sideband API HTTP Servlet Extension, Standard HTTP Servlet Extension, Third Party HTTP Servlet Extension, Velocity HTTP Servlet Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-identity-mapper-prop

Modify Identity Mapper properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-identity-mapper-prop Arguments

--mapper-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Exact Match Identity Mapper, Scripted Identity Mapper, Regular Expression Identity Mapper, Third Party Identity Mapper in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-inter-server-authentication-info-prop

Modify Inter Server Authentication Info properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-inter-server-authentication-info-prop Arguments

--instance-name {name}

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

--listener-name {name}

Description The name of the Server Instance Listener
Required No
Multi-Valued No

--info-name {name}

Description The name of the Inter Server Authentication Info
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Inter Server Authentication Info or one of its subcomponents Certificate Inter Server Authentication Info, Password Inter Server Authentication Info in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-json-attribute-constraints-prop

Modify JSON Attribute Constraints properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-json-attribute-constraints-prop Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 JSON Attribute Constraints in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-json-field-constraints-prop

Modify JSON Field Constraints properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-json-field-constraints-prop Arguments

--attribute-type {name}

Description The name of the JSON Attribute Constraints
Required No
Multi-Valued No

--json-field {name}

Description The name of the JSON Field Constraints
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 JSON Field Constraints in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-key-manager-provider-prop

Modify Key Manager Provider properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-key-manager-provider-prop Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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, PKCS11 Key Manager Provider, Third Party Key Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-key-pair-prop

Modify Key Pair properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-key-pair-prop Arguments

--pair-name {name}

Description The name of the Key Pair
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Pair in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-ldap-sdk-debug-logger-prop

Modify LDAP SDK Debug Logger properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-ldap-sdk-debug-logger-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-license-prop

Modify License properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-license-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 License in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-local-db-composite-index-prop

Modify Local DB Composite Index properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-local-db-composite-index-prop Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB Composite Index
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Local DB Composite Index in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-local-db-index-prop

Modify Local DB Index properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-local-db-index-prop Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB Index
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Local DB Index in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-local-db-vlv-index-prop

Modify Local DB VLV Index properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-local-db-vlv-index-prop Arguments

--backend-name {name}

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

--index-name {name}

Description The name of the Local DB VLV Index
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Local DB VLV Index in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-location-prop

Modify Location properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-location-prop Arguments

--location-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-log-field-mapping-prop

Modify Log Field Mapping properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-log-field-mapping-prop Arguments

--mapping-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Access Log Field Mapping, Error Log Field Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-log-file-rotation-listener-prop

Modify Log File Rotation Listener properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-log-file-rotation-listener-prop Arguments

--listener-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 File Rotation Listener or one of its subcomponents Copy Log File Rotation Listener, Summarize Log File Rotation Listener, Third Party Log File Rotation Listener in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-log-publisher-prop

Modify Log Publisher properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-log-publisher-prop Arguments

--publisher-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Access Log Publisher, HTTP Operation Log Publisher, Debug Log Publisher, Error Log Publisher, Policy Decision Log Publisher, Sync Log Publisher, Trace Log Publisher in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-log-retention-policy-prop

Modify Log Retention Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-log-retention-policy-prop Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 File Count Log Retention Policy, Free Disk Space Log Retention Policy, Never Delete Log Retention Policy, Size Limit Log Retention Policy, Time Limit Log Retention Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-log-rotation-policy-prop

Modify Log Rotation Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-log-rotation-policy-prop Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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, Never Rotate Log Rotation Policy, Size Limit Log Rotation Policy, Time Limit Log Rotation Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-mac-secret-key-prop

Modify Mac Secret Key properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-mac-secret-key-prop Arguments

--instance-name {name}

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

--key-name {name}

Description The name of the Mac Secret Key
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-matching-rule-prop

Modify Matching Rule properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-matching-rule-prop Arguments

--rule-name {name}

Description The name of the Matching Rule
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Matching Rule or one of its subcomponents Approximate Matching Rule, Equality Matching Rule, Ordering Matching Rule, Substring Matching Rule in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-monitor-provider-prop

Modify Monitor Provider properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-monitor-provider-prop Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Entry Cache Monitor Provider, Host System Monitor Provider, Memory Usage Monitor Provider, SSL Context Monitor Provider, Stack Trace Monitor Provider, System Info Monitor Provider, Third Party Monitor Provider, Version Monitor Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-monitoring-endpoint-prop

Modify Monitoring Endpoint properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-monitoring-endpoint-prop Arguments

--endpoint-name {name}

Description The name of the Monitoring Endpoint
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Endpoint or one of its subcomponents StatsD Monitoring Endpoint in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-notification-manager-prop

Modify Notification Manager properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-notification-manager-prop Arguments

--manager-name {name}

Description The name of the Notification Manager
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Notification Manager or one of its subcomponents Third Party Notification Manager in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-oauth-token-handler-prop

Modify OAuth Token Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-oauth-token-handler-prop Arguments

--handler-name {name}

Description The name of the OAuth Token Handler
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 OAuth Token Handler or one of its subcomponents Scripted Oauth Token Handler, Third Party Oauth Token Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-obscured-value-prop

Modify Obscured Value properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-obscured-value-prop Arguments

--value-name {name}

Description The name of the Obscured Value
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Obscured Value in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-otp-delivery-mechanism-prop

Modify OTP Delivery Mechanism properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-otp-delivery-mechanism-prop Arguments

--mechanism-name {name}

Description The name of the OTP Delivery Mechanism
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 OTP Delivery Mechanism or one of its subcomponents Email OTP Delivery Mechanism, Third Party OTP Delivery Mechanism, Twilio OTP Delivery Mechanism in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-password-generator-prop

Modify Password Generator properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-password-generator-prop Arguments

--generator-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Scripted Password Generator, Passphrase Password Generator, Random Password Generator, Third Party Password Generator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-password-policy-prop

Modify Password Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-password-policy-prop Arguments

--policy-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-password-storage-scheme-prop

Modify Password Storage Scheme properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-password-storage-scheme-prop Arguments

--scheme-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 AES Password Storage Scheme, Argon2 Password Storage Scheme, Base64 Password Storage Scheme, Bcrypt Password Storage Scheme, Blowfish Password Storage Scheme, Clear Password Storage Scheme, Crypt Password Storage Scheme, MD5 Password Storage Scheme, PBKDF2 Password Storage Scheme, RC4 Password Storage Scheme, SHA1 Password Storage Scheme, Salted MD5 Password Storage Scheme, Salted SHA1 Password Storage Scheme, Salted SHA256 Password Storage Scheme, Salted SHA384 Password Storage Scheme, Salted SHA512 Password Storage Scheme, Scrypt Password Storage Scheme, Third Party Enhanced Password Storage Scheme, Third Party Password Storage Scheme, Triple DES Password Storage Scheme in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-password-validator-prop

Modify Password Validator properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-password-validator-prop Arguments

--validator-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Attribute Value Password Validator, Character Set Password Validator, Dictionary Password Validator, Scripted Password Validator, Haystack Password Validator, Length Based Password Validator, Pwned Passwords Password Validator, Regular Expression Password Validator, Repeated Characters Password Validator, Similarity Based Password Validator, Third Party Password Validator, Unique Characters Password Validator in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-plugin-prop

Modify Plugin properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-plugin-prop Arguments

--plugin-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Attribute Mapper Plugin, Change Subscription Notification Plugin, Changelog Password Encryption Plugin, Purge Expired Data Plugin, DN Mapper Plugin, Delay Plugin, Encrypt Attribute Values Plugin, Entry UUID Plugin, Global Referential Integrity Plugin, Globally Unique Attribute Plugin, Scripted Plugin, Internal Search Rate Plugin, LDAP Attribute Description List Plugin, LDAP Result Code Tracker Plugin, Last Access Time Plugin, Last Mod Plugin, Monitor History Plugin, Pass Through Authentication Plugin, Password Policy Import Plugin, Periodic GC Plugin, Stats Plugin, Ping One For Customers Pass Through Authentication Plugin, Profiler Plugin, Pre Update Config Plugin, Processing Time Histogram Plugin, Referential Integrity Plugin, Referral On Update Plugin, SNMP Master Agent Plugin, SNMP Subagent Plugin, Search Shutdown Plugin, Seven Bit Clean Plugin, Simple To External Bind Plugin, Sub Operation Timing Plugin, Third Party Plugin, Unique Attribute Plugin in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-plugin-root-prop

Modify Plugin Root properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-plugin-root-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-policy-configuration-key-prop

Modify Policy Configuration Key properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-policy-configuration-key-prop Arguments

--key-name {name}

Description The name of the Policy Configuration Key
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Policy Configuration Key in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-recurring-task-chain-prop

Modify Recurring Task Chain properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-recurring-task-chain-prop Arguments

--chain-name {name}

Description The name of the Recurring Task Chain
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Recurring Task Chain in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-recurring-task-prop

Modify Recurring Task properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-recurring-task-prop Arguments

--task-name {name}

Description The name of the Recurring Task
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Recurring Task or one of its subcomponents Backup Recurring Task, Delay Recurring Task, Enter Lockdown Mode Recurring Task, Exec Recurring Task, File Retention Recurring Task, LDIF Export Recurring Task, Leave Lockdown Mode Recurring Task, Statically Defined Recurring Task, Third Party Recurring Task in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-replication-assurance-policy-prop

Modify Replication Assurance Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-replication-assurance-policy-prop Arguments

--policy-name {name}

Description The name of the Replication Assurance Policy
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Replication Assurance Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-replication-domain-prop

Modify Replication Domain properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-replication-domain-prop Arguments

--provider-name {name}

Description The name of the Replication Synchronization Provider
Required No
Multi-Valued No

--domain-name {name}

Description The name of the Replication Domain
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Replication Domain in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-replication-server-prop

Modify Replication Server properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-replication-server-prop Arguments

--provider-name {name}

Description The name of the Replication Synchronization Provider
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Replication Server in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-request-criteria-prop

Modify Request Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-request-criteria-prop Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Aggregate Request Criteria, Root DSE Request Criteria, Simple Request Criteria, Third Party Request Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-rest-resource-type-prop

Modify REST Resource Type properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-rest-resource-type-prop Arguments

--type-name {name}

Description The name of the REST Resource Type
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 REST Resource Type or one of its subcomponents Group REST Resource Type, User REST Resource Type in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-result-code-map-prop

Modify Result Code Map properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-result-code-map-prop Arguments

--map-name {name}

Description The name of the Result Code Map
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Code Map in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-result-criteria-prop

Modify Result Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-result-criteria-prop Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--reset {property}

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

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

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-root-dn-prop

Modify Root DN properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-root-dn-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-root-dn-user-prop

Modify Root DN User properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-root-dn-user-prop Arguments

--user-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-root-dse-backend-prop

Modify Root DSE Backend properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-root-dse-backend-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-sasl-mechanism-handler-prop

Modify SASL Mechanism Handler properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-sasl-mechanism-handler-prop Arguments

--handler-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Anonymous SASL Mechanism Handler, Cram MD5 SASL Mechanism Handler, Digest MD5 SASL Mechanism Handler, External SASL Mechanism Handler, GSSAPI SASL Mechanism Handler, Plain SASL Mechanism Handler, Third Party SASL Mechanism Handler, UnboundID Certificate Plus Password SASL Mechanism Handler, UnboundID Delivered OTP SASL Mechanism Handler, UnboundID External Auth SASL Mechanism Handler, UnboundID Inter Server SASL Mechanism Handler, UnboundID Ms Chap V2 SASL Mechanism Handler, UnboundID TOTP SASL Mechanism Handler, UnboundID Yubikey OTP SASL Mechanism Handler in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-scim-attribute-mapping-prop

Modify SCIM Attribute Mapping properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-scim-attribute-mapping-prop Arguments

--type-name {name}

Description The name of the LDAP Mapping SCIM Resource Type
Required No
Multi-Valued No

--mapping-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 SCIM Attribute Mapping in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-scim-attribute-prop

Modify SCIM Attribute properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-scim-attribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 SCIM Attribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-scim-resource-type-prop

Modify SCIM Resource Type properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-scim-resource-type-prop Arguments

--type-name {name}

Description The name of the SCIM Resource Type
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 SCIM Resource Type or one of its subcomponents Mapping SCIM Resource Type, Pass Through SCIM Resource Type in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-scim-schema-prop

Modify SCIM Schema properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-scim-schema-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 SCIM Schema in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-scim-subattribute-prop

Modify SCIM Subattribute properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-scim-subattribute-prop Arguments

--schema-name {name}

Description The name of the SCIM Schema
Required No
Multi-Valued No

--attribute-name {name}

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

--subattribute-name {name}

Description The name of the SCIM Subattribute
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 SCIM Subattribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-search-entry-criteria-prop

Modify Search Entry Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-search-entry-criteria-prop Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--reset {property}

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

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

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-search-reference-criteria-prop

Modify Search Reference Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-search-reference-criteria-prop Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Aggregate Search Reference Criteria, Simple Search Reference Criteria, Third Party Search Reference Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-sensitive-attribute-prop

Modify Sensitive Attribute properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-sensitive-attribute-prop Arguments

--attribute-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Sensitive Attribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-server-group-prop

Modify Server Group properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-server-group-prop Arguments

--group-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Group in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-server-instance-listener-prop

Modify Server Instance Listener properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-server-instance-listener-prop Arguments

--instance-name {name}

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

--listener-name {name}

Description The name of the Server Instance Listener
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Instance Listener or one of its subcomponents HTTP Server Instance Listener, LDAP Server Instance Listener in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-server-instance-prop

Modify Server Instance properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-server-instance-prop Arguments

--instance-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Instance or one of its subcomponents Directory Server Instance, Governance Server Instance, Metrics Engine Server Instance, Proxy Server Instance, Sync Server Instance in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-soft-delete-policy-prop

Modify Soft Delete Policy properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-soft-delete-policy-prop Arguments

--policy-name {name}

Description The name of the Soft Delete Policy
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Soft Delete Policy in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-synchronization-provider-prop

Modify Synchronization Provider properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-synchronization-provider-prop Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Synchronization Provider or one of its subcomponents Replication Synchronization Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-topology-admin-user-prop

Modify Topology Admin User properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-topology-admin-user-prop Arguments

--user-name {name}

Description The name of the Topology Admin User
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-trust-manager-provider-prop

Modify Trust Manager Provider properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-trust-manager-provider-prop Arguments

--provider-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Blind Trust Manager Provider, File Based Trust Manager Provider, JVM Default Trust Manager Provider, Third Party Trust Manager Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-trusted-certificate-prop

Modify Trusted Certificate properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-trusted-certificate-prop Arguments

--certificate-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Trusted Certificate in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-uncached-attribute-criteria-prop

Modify Uncached Attribute Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-uncached-attribute-criteria-prop Arguments

--criteria-name {name}

Description The name of the Uncached Attribute Criteria
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Uncached Attribute Criteria or one of its subcomponents Default Uncached Attribute Criteria, Scripted Uncached Attribute Criteria, Simple Uncached Attribute Criteria, Third Party Uncached Attribute Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-uncached-entry-criteria-prop

Modify Uncached Entry Criteria properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-uncached-entry-criteria-prop Arguments

--criteria-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Uncached Entry Criteria or one of its subcomponents Default Uncached Entry Criteria, Filter Based Uncached Entry Criteria, Scripted Uncached Entry Criteria, Last Access Time Uncached Entry Criteria, Third Party Uncached Entry Criteria in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-vault-authentication-method-prop

Modify Vault Authentication Method properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-vault-authentication-method-prop Arguments

--method-name {name}

Description The name of the Vault Authentication Method
Required No
Multi-Valued No

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Vault Authentication Method or one of its subcomponents App Role Vault Authentication Method, Static Token Vault Authentication Method, User Pass Vault Authentication Method in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-velocity-context-provider-prop

Modify Velocity Context Provider properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-velocity-context-provider-prop Arguments

--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} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Third Party Velocity Context Provider, Velocity Tools Velocity Context Provider in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-velocity-template-loader-prop

Modify Velocity Template Loader properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-velocity-template-loader-prop Arguments

--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} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-virtual-attribute-prop

Modify Virtual Attribute properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-virtual-attribute-prop Arguments

--name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Virtual Attribute or one of its subcomponents Config Model Virtual Attribute, Constructed Virtual Attribute, Current Time Virtual Attribute, Entry Checksum Virtual Attribute, Entry DN Virtual Attribute, Entry UUID Virtual Attribute, Expand Timestamp Virtual Attribute, File Based Virtual Attribute, Scripted Virtual Attribute, Has Subordinates Virtual Attribute, Identify References Virtual Attribute, Instance Name Virtual Attribute, Is Member Of Virtual Attribute, Large Attribute Virtual Attribute, Member Of Server Group Virtual Attribute, Member Virtual Attribute, Mirror Virtual Attribute, Num Subordinates Virtual Attribute, Replication State Detail Virtual Attribute, Short Unique ID Virtual Attribute, Subschema Subentry Virtual Attribute, Third Party Virtual Attribute, User Defined Virtual Attribute in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-web-application-extension-prop

Modify Web Application Extension properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-web-application-extension-prop Arguments

--extension-name {name}

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

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Console Web Application Extension in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

set-work-queue-prop

Modify Work Queue properties

When using dsconfig in non-interactive mode, --set, --add, and --remove option values can be specified in two ways: First, the name of the property and its value may be separated using a colon (:) in the command. For example, set the enabled property of an example configuration object with the following: dsconfig set-example-prop --example-name 'An Object' --set enabled:true Values can also be specified in a text file, where the property name in the command is followed by the less-than operator (<) and either an absolute path, or a path relative to the current directory, from which the value is read. This notation is useful for specifying complex property values such as XML, or when specifying passwords or other sensitive values. For example, set the password property to a value specified in a file in the /tmp directory of the host (use single or double quotes around the property-file string, according to your operating system): dsconfig set-example-prop --example-name 'An Object' --set 'password

set-work-queue-prop Arguments

--set {PROP:VALUE} or {PROP

Description Assign a value to a property, where PROP is the name of the property and VALUE is the single value to be assigned. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
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 Caller Invoked Work Queue, Canned Response Work Queue, High Throughput Work Queue, Traditional Work Queue, Wait Notify Work Queue in the Server Configuration Reference.
Required No
Multi-Valued Yes

--add {PROP:VALUE} or {PROP

Description Add a single value to a property, where PROP is the name of the property and VALUE is the single value to be added. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

--remove {PROP:VALUE} or {PROP

Description Remove a single value from a property, where PROP is the name of the property and VALUE is the single value to be removed. Alternatively, the value can be read from a text file with the less-than (<) operator, where FILE is a path to a text file containing the value. See the help above for usage information and examples
Required No
Multi-Valued Yes

Arguments

-V
--version

Description Display Directory Server version information

-H
--help

Description Display general usage information

--help-ldap

Description Display help for using LDAP options

--help-sasl

Description Display help for using SASL options

--help-debug

Description Display help for using debug options
Advanced Yes

--advanced

Description Allow the configuration of advanced components and properties

-v
--verbose

Description Use verbose mode

-Q
--quiet

Description Use quiet mode

-n
--no-prompt

Description Use non-interactive mode. If data in the command is missing, you will not be prompted and the tool will fail

-F {batchFilePath}
--batch-file {batchFilePath}

Description Path to a file containing a sequence of dsconfig commands to run
Required No
Multi-Valued No

--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 --applyChangeTo argument is provided with the value server-group-force. Only applies if the batch file argument is also supplied

--dry-run

Description Validate configuration changes but do not apply them. This option can only be used along with the -F/--batch-file option

--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 single-server
server-group-force
server-group
Required No
Multi-Valued No

--offline

Description Interact with the local configuration while the server is offline. Not for use while the server is running

-r {reason}
--reason {reason}

Description A string describing the reason for the configuration change
Required No
Multi-Valued No

-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 Directory Server hostname or IP address
Default Value localhost
Required No
Multi-Valued No

-p {port}
--port {port}

Description Directory Server port number
Default Value 389
Required No
Multi-Valued No

-D {bindDN}
--bindDN {bindDN}

Description DN used to bind to the server
Default Value cn=Directory Manager
Required No
Multi-Valued No

-w {bindPassword}
--bindPassword {bindPassword}

Description Password used to bind to the server
Required No
Multi-Valued No

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

Description Bind password file
Required No
Multi-Valued No

-o {name=value}
--saslOption {name=value}

Description SASL bind options
Required No
Multi-Valued Yes

-X
--trustAll

Description Trust all server SSL certificates

-P {truststorePath}
--trustStorePath {truststorePath}

Description Certificate truststore path
Default Value /home/centos/workspace/Core-Release/build/package/PingDirectory/config/truststore
Required No
Multi-Valued No

-T {truststorePassword}
--trustStorePassword {truststorePassword}

Description Certificate truststore PIN
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description Certificate truststore PIN file
Required No
Multi-Valued No

-K {keystorePath}
--keyStorePath {keystorePath}

Description Certificate keystore path
Required No
Multi-Valued No

-W {keystorePassword}
--keyStorePassword {keystorePassword}

Description Certificate keystore PIN
Required No
Multi-Valued No

-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}

Description Certificate keystore 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 core

--help-database

Description Display subcommands relating to backends, indexing, and caching

--help-logging

Description Display subcommands relating to logging, monitoring, and notifications

--help-replication

Description Display subcommands relating to replication

--help-security

Description Display subcommands relating to security and authorization

--help-topology

Description Display subcommands relating to topology

--help-user-management

Description Display subcommands relating to authentication and password management

--help-web

Description Display subcommands relating to web services and applications

--help-subcommands

Description Display all subcommands