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.
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 --inheritedFor examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help
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
--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 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
--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: admin-alert | error-log | groovy-scripted | multi-part-email | smtp | third-party |
| Required | No |
| Multi-Valued | No |
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
--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 Azure 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
--method-name {name}
| Description | The name of the new Azure 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 Azure Authentication Method to create. The type value can be one of the following: client-secret | default | username-password |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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 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
--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 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
--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 | amazon-secrets-manager | azure-key-vault | conjur | file-based | pkcs11 | third-party | vault | wait-for-passphrase |
| Required | No |
| Multi-Valued | No |
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
--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 Conjur 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
--method-name {name}
| Description | The name of the new Conjur 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 Conjur Authentication Method to create. The type value can be one of the following: api-key |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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 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
--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 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
--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 Correlated LDAP Data Views
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
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the new Correlated LDAP Data View |
| 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
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
--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 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
--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 | account-usability-issues | account-validity-window | deprecated-password-storage-scheme | disabled-account | expired-password | filter | idle-account | locked-account | multiple-password | nonexistent-password-policy | privilege | third-party | weakly-encoded-password |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 |
-t {type}
--type {type}
| Description | The type of Delegated Admin Attribute to be created (Default: generic). The value for TYPE can be one of: certificate | generic | photo |
| Default Value | generic |
| Required | No |
| Multi-Valued | No |
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
--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 Correlated REST Resources
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
--type-name {name}
| Description | The name of the REST Resource Type |
| Required | No |
| Multi-Valued | No |
--resource-name {name}
| Description | The name of the new Delegated Admin Correlated REST Resource |
| 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
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
--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
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
--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 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
--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 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
--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 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
--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: collect-support-data | custom | deliver-otp | deliver-password-reset-token | export-reversible-passwords | replace-certificate | single-use-tokens | third-party | validate-totp-password |
| Required | No |
| Multi-Valued | No |
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
--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 | amazon-aws | conjur | http | http-proxy | jdbc | ldap | nokia-ds | nokia-proxy-server | opendj | oracle-unified-directory | ping-identity-ds | ping-identity-proxy-server | ping-one-http | smtp | syslog | vault |
| Required | No |
| Multi-Valued | No |
Create Failure Lockout Actions
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
--action-name {name}
| Description | The name of the new Failure Lockout Action |
| 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 Failure Lockout Action to create. The type value can be one of the following: delay-bind-response | lock-account | no-operation |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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 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
--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 | prometheus-monitoring | quickstart | third-party |
| Required | No |
| Multi-Valued | No |
Create ID 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
--validator-name {name}
| Description | The name of the new ID 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 ID Token Validator to create. The type value can be one of the following: openid-connect | ping-one |
| Required | No |
| Multi-Valued | No |
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
--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: aggregate | dn | exact-match | groovy-scripted | regular-expression | third-party |
| Required | No |
| Multi-Valued | No |
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
--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
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
--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 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
--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 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
--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 LDAP Correlation Attribute 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
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
--pair-name {name}
| Description | The name of the new LDAP Correlation Attribute 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 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
--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 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
--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 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
--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 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
--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 Behaviors
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
--behavior-name {name}
| Description | The name of the new Log Field Behavior |
| 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 Behavior to create. The type value can be one of the following: json-formatted-access | text-access |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 | upload-to-s3 |
| Required | No |
| Multi-Valued | No |
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
--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 | console-json-audit | console-json-http-operation | debug-access | detailed-http-operation | file-based-access | file-based-audit | file-based-debug | file-based-error | file-based-json-audit | file-based-json-http-operation | 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 | syslog-json-access | syslog-json-audit | syslog-json-error | syslog-json-http-operation | syslog-text-access | syslog-text-error | third-party-access | third-party-error | third-party-file-based-access | third-party-file-based-error | third-party-http-operation |
| Required | No |
| Multi-Valued | No |
Create Log Retention Policies
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
--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 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
--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 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
--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 | encryption-settings-database-accessibility | third-party |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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 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
--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 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
--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 Pass Through Authentication 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
--handler-name {name}
| Description | The name of the new Pass Through Authentication 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 Pass Through Authentication Handler to create. The type value can be one of the following: aggregate | ldap | ping-one | third-party |
| Required | No |
| Multi-Valued | No |
Create Passphrase 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
--provider-name {name}
| Description | The name of the new Passphrase 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 Passphrase Provider to create. The type value can be one of the following: amazon-secrets-manager | azure-key-vault | conjur | environment-variable | file-based | obscured-value | third-party | vault |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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: aes-256 | amazon-secrets-manager | argon2 | argon2d | argon2i | argon2id | azure-key-vault | bcrypt | conjur | crypt | pbkdf2 | scrypt | third-party | third-party-enhanced | vault |
| Required | No |
| Multi-Valued | No |
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
--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 | disallowed-characters | groovy-scripted | haystack | length-based | pwned-passwords | regular-expression | repeated-characters | similarity-based | third-party | unique-characters | utf-8 |
| Required | No |
| Multi-Valued | No |
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
--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 | coalesce-modifications | composed-attribute | custom | delay | dn-mapper | groovy-scripted | internal-search-rate | inverted-static-group-referential-integrity | modifiable-password-policy-state | pass-through-authentication | periodic-gc | periodic-stats-logger | ping-one-pass-through-authentication | pluggable-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 | traditional-static-group-support-for-inverted-static-groups | unique-attribute |
| Required | No |
| Multi-Valued | No |
Create Post LDIF Export Task Processors
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
--processor-name {name}
| Description | The name of the new Post LDIF Export Task Processor |
| 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 Post LDIF Export Task Processor to create. The type value can be one of the following: third-party | upload-to-s3 |
| Required | No |
| Multi-Valued | No |
Create Prometheus Monitor Attribute Metrics
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
--extension-name {name}
| Description | The name of the Prometheus Monitoring HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--metric-name {The metric name must start with a letter or underscore, and it must only contain letters, digits, and underscores.}
| Description | The name of the new Prometheus Monitor Attribute Metric which will also be used as the value of the 'metric-name' property. The name that will be used in the metric to be consumed by Prometheus. |
| 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 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
--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: audit-data-security | backup | collect-support-data | delay | enter-lockdown-mode | exec | file-retention | generate-server-profile | ldif-export | leave-lockdown-mode | statically-defined | third-party |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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
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
--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 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
--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 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
--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
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
--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 | successful-bind | third-party |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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: oauth-bearer | third-party | unboundid-delivered-otp | unboundid-ms-chap-v2 |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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 | mapping |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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
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
--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
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
--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 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
--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 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
--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 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
--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 Token Claim Validations
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
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
--validation-name {name}
| Description | The name of the new Token Claim Validation |
| 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 Token Claim Validation to create. The type value can be one of the following: boolean | string | string-array |
| Required | No |
| Multi-Valued | No |
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
--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 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
--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 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
--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
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
--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
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
--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 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
--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 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
--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 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
--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 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
--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 | dn-join | entry-dn | equality-join | groovy-scripted | identify-references | is-member-of | member | mirror | password-policy-state-json | reverse-dn-join | third-party | user-defined |
| Required | No |
| Multi-Valued | No |
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
--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 Validators
--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 Handlers
--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 Handlers
--handler-name {name}
| Description | The name of the Alert Handler |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Alert Handlers |
Delete Azure Authentication Methods
--method-name {name}
| Description | The name of the Azure Authentication Method |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Azure Authentication Methods |
Delete Backends
--backend-name {name}
| Description | The name of the Backend |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Backends |
Delete Certificate Mappers
--mapper-name {name}
| Description | The name of the Certificate Mapper |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Certificate Mappers |
Delete Change Subscriptions
--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 Handlers
--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 Providers
--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 Policies
--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 Conjur Authentication Methods
--method-name {name}
| Description | The name of the Conjur Authentication Method |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Conjur Authentication Methods |
Delete Connection Criteria
--criteria-name {name}
| Description | The name of the Connection Criteria |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Connection Criteria |
Delete Connection Handlers
--handler-name {name}
| Description | The name of the Connection Handler |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Connection Handlers |
Delete Consent Definitions
--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 Localizations
--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 Attributes
--attribute-name {name}
| Description | The name of the Constructed Attribute |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Constructed Attributes |
Delete Correlated LDAP Data Views
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Correlated LDAP Data Views |
Delete Custom Logged Stats
--plugin-name {name}
| Description | The name of the Periodic Stats Logger Plugin |
| Required | No |
| Multi-Valued | No |
--stats-name {name}
| Description | The name of the Custom Logged Stats |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Custom Logged Stats |
Delete Data Security Auditors
--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 Targets
--publisher-name {name}
| Description | The name of the Debug Log Publisher |
| Required | No |
| Multi-Valued | No |
--target-name {name}
| Description | The name of the Debug Target |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Debug Targets |
Delete Delegated Admin Attributes
--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 Categories
--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 Correlated REST Resources
--type-name {name}
| Description | The name of the REST Resource Type |
| Required | No |
| Multi-Valued | No |
--resource-name {name}
| Description | The name of the Delegated Admin Correlated REST Resource |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Delegated Admin Correlated REST Resources |
Delete Delegated Admin Resource Rights
--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
--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 Maps
--map-name {name}
| Description | The name of the DN Map |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent DN Maps |
Delete Entry Caches
--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 Handlers
--handler-name {name}
| Description | The name of the Extended Operation Handler |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Extended Operation Handlers |
Delete External Servers
--server-name {name}
| Description | The name of the External Server |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent External Servers |
Delete Failure Lockout Actions
--action-name {name}
| Description | The name of the Failure Lockout Action |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Failure Lockout Actions |
Delete Gauges
--gauge-name {name}
| Description | The name of the Gauge |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Gauges |
Delete Gauge Data Sources
--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 Policies
--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 Extensions
--extension-name {name}
| Description | The name of the HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent HTTP Servlet Extensions |
Delete ID Token Validators
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent ID Token Validators |
Delete Identity Mappers
--mapper-name {name}
| Description | The name of the Identity Mapper |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Identity Mappers |
Delete JSON Attribute Constraints
--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
--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 Providers
--provider-name {name}
| Description | The name of the Key Manager Provider |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Key Manager Providers |
Delete Key Pairs
--pair-name {name}
| Description | The name of the Key Pair |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Key Pairs |
Delete LDAP Correlation Attribute Pairs
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
--pair-name {name}
| Description | The name of the LDAP Correlation Attribute Pair |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent LDAP Correlation Attribute Pairs |
Delete Local DB Composite Indexes
--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 Indexes
--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 Indexes
--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 Locations
--location-name {name}
| Description | The name of the Location |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Locations |
Delete Log Field Behaviors
--behavior-name {name}
| Description | The name of the Log Field Behavior |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Log Field Behaviors |
Delete Log Field Mappings
--mapping-name {name}
| Description | The name of the Log Field Mapping |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Log Field Mappings |
Delete Log File Rotation Listeners
--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 Publishers
--publisher-name {name}
| Description | The name of the Log Publisher |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Log Publishers |
Delete Log Retention Policies
--policy-name {name}
| Description | The name of the Log Retention Policy |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Log Retention Policies |
Delete Log Rotation Policies
--policy-name {name}
| Description | The name of the Log Rotation Policy |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Log Rotation Policies |
Delete Monitor Providers
--provider-name {name}
| Description | The name of the Monitor Provider |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Monitor Providers |
Delete Monitoring Endpoints
--endpoint-name {name}
| Description | The name of the Monitoring Endpoint |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Monitoring Endpoints |
Delete Notification Managers
--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 Handlers
--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 Values
--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 Mechanisms
--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 Pass Through Authentication Handlers
--handler-name {name}
| Description | The name of the Pass Through Authentication Handler |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Pass Through Authentication Handlers |
Delete Passphrase Providers
--provider-name {name}
| Description | The name of the Passphrase Provider |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Passphrase Providers |
Delete Password Generators
--generator-name {name}
| Description | The name of the Password Generator |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Password Generators |
Delete Password Policies
--policy-name {name}
| Description | The name of the Password Policy |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Password Policies |
Delete Password Storage Schemes
--scheme-name {name}
| Description | The name of the Password Storage Scheme |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Password Storage Schemes |
Delete Password Validators
--validator-name {name}
| Description | The name of the Password Validator |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Password Validators |
Delete Plugins
--plugin-name {name}
| Description | The name of the Plugin |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Plugins |
Delete Post LDIF Export Task Processors
--processor-name {name}
| Description | The name of the Post LDIF Export Task Processor |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Post LDIF Export Task Processors |
Delete Prometheus Monitor Attribute Metrics
--extension-name {name}
| Description | The name of the Prometheus Monitoring HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--metric-name {name}
| Description | The name of the Prometheus Monitor Attribute Metric |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Prometheus Monitor Attribute Metrics |
Delete Recurring Tasks
--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 Chains
--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 Policies
--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
--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 Types
--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 Maps
--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
--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 Users
--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 Handlers
--handler-name {name}
| Description | The name of the SASL Mechanism Handler |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent SASL Mechanism Handlers |
Delete SCIM Attributes
--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 Mappings
--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 Types
--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 Schemas
--schema-name {name}
| Description | The name of the SCIM Schema |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent SCIM Schemas |
Delete SCIM Subattributes
--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
--criteria-name {name}
| Description | The name of the Search Entry Criteria |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Search Entry Criteria |
Delete Search Reference Criteria
--criteria-name {name}
| Description | The name of the Search Reference Criteria |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Search Reference Criteria |
Delete Sensitive Attributes
--attribute-name {name}
| Description | The name of the Sensitive Attribute |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Sensitive Attributes |
Delete Server Groups
--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 Policies
--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 Token Claim Validations
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
--validation-name {name}
| Description | The name of the Token Claim Validation |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Token Claim Validations |
Delete Topology Admin Users
--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 Providers
--provider-name {name}
| Description | The name of the Trust Manager Provider |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Trust Manager Providers |
Delete Trusted Certificates
--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
--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
--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 Methods
--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 Providers
--extension-name {name}
| Description | The name of the Velocity HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--provider-name {name}
| Description | The name of the Velocity Context Provider |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Velocity Context Providers |
Delete Velocity Template Loaders
--extension-name {name}
| Description | The name of the Velocity HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--loader-name {name}
| Description | The name of the Velocity Template Loader |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Velocity Template Loaders |
Delete Virtual Attributes
--name {name}
| Description | The name of the Virtual Attribute |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Virtual Attributes |
Delete Web Application Extensions
--extension-name {name}
| Description | The name of the Web Application Extension |
| Required | No |
| Multi-Valued | No |
-f
--force
| Description | Ignore nonexistent Web Application Extensions |
Show Access Control Handler properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Access Token Validator properties
--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 displayedSee properties for Access Token Validator or one of its subcomponents Bind Access Token Validator, External API Gateway Access Token Validator, 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 |
Show Account Status Notification Handler properties
--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 displayedSee properties for Account Status Notification Handler or one of its subcomponents Admin Alert Account Status Notification Handler, 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 |
Show Alarm Manager properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Alert Handler properties
--handler-name {name}
| Description | The name of the Alert Handler |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Alert Handler or one of its subcomponents Error Log Alert Handler, Exec Alert Handler, Scripted Alert Handler, JMX Alert Handler, Output 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 |
Show Attribute Syntax properties
--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 displayedSee 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 |
Show Azure Authentication Method properties
--method-name {name}
| Description | The name of the Azure Authentication Method |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Azure Authentication Method or one of its subcomponents Client Secret Azure Authentication Method, Default Azure Authentication Method, Username Password Azure 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 |
Show Backend properties
--backend-name {name}
| Description | The name of the Backend |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Certificate Mapper properties
--mapper-name {name}
| Description | The name of the Certificate Mapper |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Change Subscription Handler properties
--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 displayedSee 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 |
Show Change Subscription properties
--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 displayedSee 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 |
Show Cipher Secret Key properties
--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 |
Show Cipher Stream Provider properties
--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 displayedSee properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, Amazon Secrets Manager Cipher Stream Provider, Azure Key Vault Cipher Stream Provider, Conjur Cipher Stream Provider, Default Cipher Stream Provider, File Based Cipher Stream Provider, PKCS11 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 |
Show Client Connection Policy properties
--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 displayedSee 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 |
Show Conjur Authentication Method properties
--method-name {name}
| Description | The name of the Conjur Authentication Method |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Conjur Authentication Method or one of its subcomponents API Key Conjur 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 |
Show Connection Criteria properties
--criteria-name {name}
| Description | The name of the Connection Criteria |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Connection Handler properties
--handler-name {name}
| Description | The name of the Connection Handler |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Consent Definition Localization properties
--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 displayedSee 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 |
Show Consent Definition properties
--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 displayedSee 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 |
Show Consent Service properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Constructed Attribute properties
--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 displayedSee 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 |
Show Correlated LDAP Data View properties
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Correlated LDAP Data View 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 |
Show Crypto Manager properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Custom Logged Stats properties
--plugin-name {name}
| Description | The name of the Periodic Stats Logger Plugin |
| Required | No |
| Multi-Valued | No |
--stats-name {name}
| Description | The name of the Custom Logged Stats |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Data Security Auditor properties
--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 displayedSee properties for Data Security Auditor or one of its subcomponents Access Control Data Security Auditor, Account Usability Issues Data Security Auditor, Account Validity Window Data Security Auditor, Deprecated Password Storage Scheme Data Security Auditor, Disabled Account Data Security Auditor, Expired Password Data Security Auditor, Filter Data Security Auditor, Idle Account Data Security Auditor, Locked Account Data Security Auditor, Multiple Password Data Security Auditor, Nonexistent Password Policy Data Security Auditor, Privilege Data Security Auditor, Third Party 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 |
Show Debug Target properties
--publisher-name {name}
| Description | The name of the Debug Log Publisher |
| Required | No |
| Multi-Valued | No |
--target-name {name}
| Description | The name of the Debug Target |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Delegated Admin Attribute Category properties
--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 displayedSee 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 |
Show Delegated Admin Attribute properties
--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 displayedSee properties for Delegated Admin Attribute or one of its subcomponents Certificate Delegated Admin Attribute, Photo 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 |
Show Delegated Admin Correlated REST Resource properties
--type-name {name}
| Description | The name of the REST Resource Type |
| Required | No |
| Multi-Valued | No |
--resource-name {name}
| Description | The name of the Delegated Admin Correlated REST Resource |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Delegated Admin Correlated REST Resource 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 |
Show Delegated Admin Resource Rights properties
--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 displayedSee 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 |
Show Delegated Admin Rights properties
--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 displayedSee 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 |
Show DN Map properties
--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 displayedSee 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 |
Show Entry Cache properties
--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 displayedSee 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 |
Show Extended Operation Handler properties
--handler-name {name}
| Description | The name of the Extended Operation Handler |
| Required | No |
| Multi-Valued | No |
--property {property}
--tab-delimited
| Description | Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line |
--suppress-undefined-properties
| Description | Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option |
Show External Server properties
--server-name {name}
| Description | The name of the External Server |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for External Server or one of its subcomponents HTTP External Server, LDAP External Server, Amazon Aws External Server, Conjur External Server, HTTP Proxy External Server, JDBC External Server, Kafka Cluster External Server, Mock External Server, SCIM2 External Server, SCIM External Server, SMTP External Server, Syslog External Server, Vault 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 |
Show Failure Lockout Action properties
--action-name {name}
| Description | The name of the Failure Lockout Action |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Failure Lockout Action or one of its subcomponents Delay Bind Response Failure Lockout Action, Lock Account Failure Lockout Action, No Operation Failure Lockout Action 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 |
Show Gauge Data Source properties
--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 displayedSee 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 |
Show Gauge properties
--gauge-name {name}
| Description | The name of the Gauge |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Global Configuration properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Group Implementation properties
--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 displayedSee properties for Group Implementation or one of its subcomponents Dynamic Group Implementation, Inverted Static 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 |
Show HTTP Configuration properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show HTTP Servlet Cross Origin Policy properties
--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 displayedSee 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 |
Show HTTP Servlet Extension properties
--extension-name {name}
| Description | The name of the HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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, JSON PDP API HTTP Servlet Extension, SCIM HTTP Servlet Extension, Metrics HTTP Servlet Extension, Open Banking HTTP Servlet Extension, PDP Endpoint HTTP Servlet Extension, Prometheus Monitoring 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 |
Show ID Token Validator properties
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for ID Token Validator or one of its subcomponents OpenID Connect ID Token Validator, PingOne ID 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 |
Show Identity Mapper properties
--mapper-name {name}
| Description | The name of the Identity Mapper |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Identity Mapper or one of its subcomponents Aggregate Identity Mapper, DN Identity Mapper, 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 |
Show Inter Server Authentication Info properties
--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 displayedSee 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 |
Show JSON Attribute Constraints properties
--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 displayedSee 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 |
Show JSON Field Constraints properties
--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 displayedSee 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 |
Show Key Manager Provider properties
--provider-name {name}
| Description | The name of the Key Manager Provider |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Key Pair properties
--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 displayedSee 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 |
Show LDAP Correlation Attribute Pair properties
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
--pair-name {name}
| Description | The name of the LDAP Correlation Attribute Pair |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for LDAP Correlation Attribute 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 |
Show LDAP SDK Debug Logger properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show License properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Local DB Composite Index properties
--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 displayedSee 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 |
Show Local DB Index properties
--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 displayedSee 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 |
Show Local DB VLV Index properties
--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 displayedSee 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 |
Show Location properties
--location-name {name}
| Description | The name of the Location |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Log Field Behavior properties
--behavior-name {name}
| Description | The name of the Log Field Behavior |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Log Field Behavior or one of its subcomponents JSON Formatted Access Log Field Behavior, Text Access Log Field Behavior 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 |
Show Log Field Mapping properties
--mapping-name {name}
| Description | The name of the Log Field Mapping |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Log Field Syntax properties
--syntax-name {name}
| Description | The name of the Log Field Syntax |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Log Field Syntax or one of its subcomponents Attribute Based Log Field Syntax, JSON Log Field 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 |
Show Log File Rotation Listener properties
--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 displayedSee 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, Upload To S3 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 |
Show Log Publisher properties
--publisher-name {name}
| Description | The name of the Log Publisher |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Error Log Publisher, Sync Log Publisher, Debug Log Publisher, Policy Decision Log Publisher, Policy Query 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 |
Show Log Retention Policy properties
--policy-name {name}
| Description | The name of the Log Retention Policy |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Log Rotation Policy properties
--policy-name {name}
| Description | The name of the Log Rotation Policy |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Mac Secret Key properties
--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 |
Show Matching Rule properties
--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 displayedSee 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 |
Show Monitor Provider properties
--provider-name {name}
| Description | The name of the Monitor Provider |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Encryption Settings Database Accessibility Monitor Provider, Entry Cache Monitor Provider, General 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 |
Show Monitoring Endpoint properties
--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 displayedSee 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 |
Show Notification Manager properties
--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 displayedSee 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 |
Show OAuth Token Handler properties
--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 displayedSee 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 |
Show Obscured Value properties
--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 displayedSee 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 |
Show OTP Delivery Mechanism properties
--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 displayedSee 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 |
Show Pass Through Authentication Handler properties
--handler-name {name}
| Description | The name of the Pass Through Authentication Handler |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Pass Through Authentication Handler or one of its subcomponents Aggregate Pass Through Authentication Handler, LDAP Pass Through Authentication Handler, PingOne Pass Through Authentication Handler, Third Party Pass Through Authentication 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 |
Show Passphrase Provider properties
--provider-name {name}
| Description | The name of the Passphrase Provider |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Passphrase Provider or one of its subcomponents Amazon Secrets Manager Passphrase Provider, Azure Key Vault Passphrase Provider, Conjur Passphrase Provider, Environment Variable Passphrase Provider, File Based Passphrase Provider, Obscured Value Passphrase Provider, Third Party Passphrase Provider, Vault Passphrase 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 |
Show Password Generator properties
--generator-name {name}
| Description | The name of the Password Generator |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Password Policy properties
--policy-name {name}
| Description | The name of the Password Policy |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Password Storage Scheme properties
--scheme-name {name}
| Description | The name of the Password Storage Scheme |
| Required | No |
| Multi-Valued | No |
--property {property}
--tab-delimited
| Description | Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line |
--suppress-undefined-properties
| Description | Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option |
Show Password Validator properties
--validator-name {name}
| Description | The name of the Password Validator |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Password Validator or one of its subcomponents Attribute Value Password Validator, Character Set Password Validator, Dictionary Password Validator, Disallowed Characters 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, Utf 8 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 |
Show Plugin properties
--plugin-name {name}
| Description | The name of the Plugin |
| Required | No |
| Multi-Valued | No |
--property {property}
--tab-delimited
| Description | Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line |
--suppress-undefined-properties
| Description | Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option |
Show Plugin Root properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Post LDIF Export Task Processor properties
--processor-name {name}
| Description | The name of the Post LDIF Export Task Processor |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Post LDIF Export Task Processor or one of its subcomponents Third Party Post LDIF Export Task Processor, Upload To S3 Post LDIF Export Task Processor 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 |
Show Prometheus Monitor Attribute Metric properties
--extension-name {name}
| Description | The name of the Prometheus Monitoring HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--metric-name {name}
| Description | The name of the Prometheus Monitor Attribute Metric |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Prometheus Monitor Attribute Metric 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 |
Show Recurring Task Chain properties
--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 displayedSee 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 |
Show Recurring Task properties
--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 displayedSee properties for Recurring Task or one of its subcomponents Audit Data Security Recurring Task, Backup Recurring Task, Collect Support Data Recurring Task, Delay Recurring Task, Enter Lockdown Mode Recurring Task, Exec Recurring Task, File Retention Recurring Task, Generate Server Profile 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 |
Show Replication Assurance Policy properties
--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 displayedSee 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 |
Show Replication Domain properties
--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 displayedSee 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 |
Show Replication Server properties
--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 displayedSee 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 |
Show Request Criteria properties
--criteria-name {name}
| Description | The name of the Request Criteria |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show REST Resource Type properties
--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 displayedSee 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 |
Show Result Code Map properties
--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 displayedSee 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 |
Show Result Criteria properties
--criteria-name {name}
| Description | The name of the Result Criteria |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Replication Assurance Result Criteria, Simple Result Criteria, Successful Bind 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 |
Show Root DN properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Root DN User properties
--user-name {name}
| Description | The name of the Root DN User |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayed |
| 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 |
Show Root DSE Backend properties
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show SASL Mechanism Handler properties
--handler-name {name}
| Description | The name of the SASL Mechanism Handler |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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, OAuth Bearer SASL Mechanism Handler, Ping Identity Inter Server 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 |
Show SCIM Attribute Mapping properties
--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 displayedSee 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 |
Show SCIM Attribute properties
--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 displayedSee 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 |
Show SCIM Resource Type properties
--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 displayedSee 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 |
Show SCIM Schema properties
--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 displayedSee 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 |
Show SCIM Subattribute properties
--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 displayedSee 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 |
Show Search Entry Criteria properties
--criteria-name {name}
| Description | The name of the Search Entry Criteria |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Search Reference Criteria properties
--criteria-name {name}
| Description | The name of the Search Reference Criteria |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Sensitive Attribute properties
--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 displayedSee 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 |
Show Server Group properties
--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 displayedSee 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 |
Show Server Instance Listener properties
--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 displayedSee 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 |
Show Server Instance properties
--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 displayedSee properties for Server Instance or one of its subcomponents Authorize Server Instance, Directory 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 |
Show Soft Delete Policy properties
--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 displayedSee 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 |
Show Synchronization Provider properties
--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 displayedSee 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 |
Show Token Claim Validation properties
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
--validation-name {name}
| Description | The name of the Token Claim Validation |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Token Claim Validation or one of its subcomponents Boolean Token Claim Validation, String Array Token Claim Validation, String Token Claim Validation 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 |
Show Topology Admin User properties
--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 |
Show Trust Manager Provider properties
--provider-name {name}
| Description | The name of the Trust Manager Provider |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Trusted Certificate properties
--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 displayedSee 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 |
Show Uncached Attribute Criteria properties
--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 displayedSee 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 |
Show Uncached Entry Criteria properties
--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 displayedSee 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 |
Show Vault Authentication Method properties
--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 displayedSee 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 |
Show Velocity Context Provider properties
--extension-name {name}
| Description | The name of the Velocity HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--provider-name {name}
| Description | The name of the Velocity Context Provider |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Velocity Template Loader properties
--extension-name {name}
| Description | The name of the Velocity HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--loader-name {name}
| Description | The name of the Velocity Template Loader |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Virtual Attribute properties
--name {name}
| Description | The name of the Virtual Attribute |
| Required | No |
| Multi-Valued | No |
--property {property}
--tab-delimited
| Description | Indicates that properties with multiple values should provide the values all on one line separated by tabs instead of providing each value on a separate line |
--suppress-undefined-properties
| Description | Do not display properties that have no default, nor currently configured value, unless specifically requested by the --property option |
Show Web Application Extension properties
--extension-name {name}
| Description | The name of the Web Application Extension |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 |
Show Work Queue properties
--property {property}
| Description | The name of a property to be displayedSee 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 existing Access Token Validators
--property {property}
| Description | The name of a property to be displayedSee properties for Access Token Validator or one of its subcomponents Bind Access Token Validator, External API Gateway Access Token Validator, External Access Token Validator, Mock Access Token Validator, Third Party Access Token Validator in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Account Status Notification Handlers
--property {property}
| Description | The name of a property to be displayedSee properties for Account Status Notification Handler or one of its subcomponents Admin Alert Account Status Notification Handler, 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 existing Alert Handlers
--property {property}
| Description | The name of a property to be displayedSee properties for Alert Handler or one of its subcomponents Error Log Alert Handler, Exec Alert Handler, Scripted Alert Handler, JMX Alert Handler, Output 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 existing Attribute Syntaxes
--property {property}
| Description | The name of a property to be displayedSee 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 |
List existing Azure Authentication Methods
--property {property}
| Description | The name of a property to be displayedSee properties for Azure Authentication Method or one of its subcomponents Client Secret Azure Authentication Method, Default Azure Authentication Method, Username Password Azure Authentication Method in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Backends
--property {property}
| Description | The name of a property to be displayedSee 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 existing Certificate Mappers
--property {property}
| Description | The name of a property to be displayedSee 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 existing Change Subscription Handlers
--property {property}
| Description | The name of a property to be displayedSee 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 existing Change Subscriptions
--property {property}
| Description | The name of a property to be displayedSee properties for Change Subscription in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Cipher Secret Keys
--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 existing Cipher Stream Providers
--property {property}
| Description | The name of a property to be displayedSee properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, Amazon Secrets Manager Cipher Stream Provider, Azure Key Vault Cipher Stream Provider, Conjur Cipher Stream Provider, Default Cipher Stream Provider, File Based Cipher Stream Provider, PKCS11 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 existing Client Connection Policies
--property {property}
| Description | The name of a property to be displayedSee properties for Client Connection Policy in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Conjur Authentication Methods
--property {property}
| Description | The name of a property to be displayedSee properties for Conjur Authentication Method or one of its subcomponents API Key Conjur Authentication Method in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Connection Criteria
--property {property}
| Description | The name of a property to be displayedSee 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 existing Connection Handlers
--property {property}
| Description | The name of a property to be displayedSee 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 existing Consent Definition Localizations
--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 displayedSee properties for Consent Definition Localization in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Consent Definitions
--property {property}
| Description | The name of a property to be displayedSee properties for Consent Definition in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Constructed Attributes
--property {property}
| Description | The name of a property to be displayedSee properties for Constructed Attribute in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Correlated LDAP Data Views
--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 displayedSee properties for Correlated LDAP Data View in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Custom Logged Stats
--plugin-name {name}
| Description | The name of the Periodic Stats Logger Plugin |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Custom Logged Stats in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Data Security Auditors
--property {property}
| Description | The name of a property to be displayedSee properties for Data Security Auditor or one of its subcomponents Access Control Data Security Auditor, Account Usability Issues Data Security Auditor, Account Validity Window Data Security Auditor, Deprecated Password Storage Scheme Data Security Auditor, Disabled Account Data Security Auditor, Expired Password Data Security Auditor, Filter Data Security Auditor, Idle Account Data Security Auditor, Locked Account Data Security Auditor, Multiple Password Data Security Auditor, Nonexistent Password Policy Data Security Auditor, Privilege Data Security Auditor, Third Party Data Security Auditor, Weakly Encoded Password Data Security Auditor in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Debug Targets
--publisher-name {name}
| Description | The name of the Debug Log Publisher |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Debug Target in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Delegated Admin Attribute Categories
--property {property}
| Description | The name of a property to be displayedSee properties for Delegated Admin Attribute Category in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Delegated Admin Attributes
--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 displayedSee properties for Delegated Admin Attribute or one of its subcomponents Certificate Delegated Admin Attribute, Photo Delegated Admin Attribute in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Delegated Admin Correlated REST Resources
--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 displayedSee properties for Delegated Admin Correlated REST Resource in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Delegated Admin Resource Rights
--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 displayedSee properties for Delegated Admin Resource Rights in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Delegated Admin Rights
--property {property}
| Description | The name of a property to be displayedSee properties for Delegated Admin Rights in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing DN Maps
--property {property}
| Description | The name of a property to be displayedSee properties for DN Map in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Entry Caches
--property {property}
| Description | The name of a property to be displayedSee 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 existing Extended Operation Handlers
--property {property}
List existing External Servers
--property {property}
| Description | The name of a property to be displayedSee properties for External Server or one of its subcomponents HTTP External Server, LDAP External Server, Amazon Aws External Server, Conjur External Server, HTTP Proxy External Server, JDBC External Server, Kafka Cluster External Server, Mock External Server, SCIM2 External Server, SCIM External Server, SMTP External Server, Syslog External Server, Vault External Server in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Failure Lockout Actions
--property {property}
| Description | The name of a property to be displayedSee properties for Failure Lockout Action or one of its subcomponents Delay Bind Response Failure Lockout Action, Lock Account Failure Lockout Action, No Operation Failure Lockout Action in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Gauge Data Sources
--property {property}
| Description | The name of a property to be displayedSee 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 existing Gauges
--property {property}
| Description | The name of a property to be displayedSee properties for Gauge or one of its subcomponents Indicator Gauge, Numeric Gauge in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Group Implementations
--property {property}
| Description | The name of a property to be displayedSee properties for Group Implementation or one of its subcomponents Dynamic Group Implementation, Inverted Static Group Implementation, Static Group Implementation, Virtual Static Group Implementation in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing HTTP Servlet Cross Origin Policies
--property {property}
| Description | The name of a property to be displayedSee properties for HTTP Servlet Cross Origin Policy in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing HTTP Servlet Extensions
--property {property}
| Description | The name of a property to be displayedSee 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, JSON PDP API HTTP Servlet Extension, SCIM HTTP Servlet Extension, Metrics HTTP Servlet Extension, Open Banking HTTP Servlet Extension, PDP Endpoint HTTP Servlet Extension, Prometheus Monitoring 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 existing ID Token Validators
--property {property}
| Description | The name of a property to be displayedSee properties for ID Token Validator or one of its subcomponents OpenID Connect ID Token Validator, PingOne ID Token Validator in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Identity Mappers
--property {property}
| Description | The name of a property to be displayedSee properties for Identity Mapper or one of its subcomponents Aggregate Identity Mapper, DN Identity Mapper, 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 existing Inter Server Authentication Info
--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 displayedSee 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 existing JSON Attribute Constraints
--property {property}
| Description | The name of a property to be displayedSee properties for JSON Attribute Constraints in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing JSON Field Constraints
--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 displayedSee properties for JSON Field Constraints in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Key Manager Providers
--property {property}
| Description | The name of a property to be displayedSee 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 existing Key Pairs
--property {property}
| Description | The name of a property to be displayedSee properties for Key Pair in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing LDAP Correlation Attribute Pairs
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for LDAP Correlation Attribute Pair in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Local DB Composite Indexes
--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 displayedSee properties for Local DB Composite Index in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Local DB Indexes
--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 displayedSee properties for Local DB Index in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Local DB VLV Indexes
--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 displayedSee properties for Local DB VLV Index in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Locations
--property {property}
| Description | The name of a property to be displayedSee properties for Location in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Log Field Behaviors
--property {property}
| Description | The name of a property to be displayedSee properties for Log Field Behavior or one of its subcomponents JSON Formatted Access Log Field Behavior, Text Access Log Field Behavior in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Log Field Mappings
--property {property}
| Description | The name of a property to be displayedSee 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 existing Log Field Syntaxes
--property {property}
| Description | The name of a property to be displayedSee properties for Log Field Syntax or one of its subcomponents Attribute Based Log Field Syntax, JSON Log Field Syntax in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Log File Rotation Listeners
--property {property}
| Description | The name of a property to be displayedSee 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, Upload To S3 Log File Rotation Listener in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Log Publishers
--property {property}
| Description | The name of a property to be displayedSee properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Error Log Publisher, Sync Log Publisher, Debug Log Publisher, Policy Decision Log Publisher, Policy Query Log Publisher, Trace Log Publisher in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Log Retention Policies
--property {property}
| Description | The name of a property to be displayedSee 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 existing Log Rotation Policies
--property {property}
| Description | The name of a property to be displayedSee 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 existing Mac Secret Keys
--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 existing Matching Rules
--property {property}
| Description | The name of a property to be displayedSee 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 existing Monitor Providers
--property {property}
| Description | The name of a property to be displayedSee properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Encryption Settings Database Accessibility Monitor Provider, Entry Cache Monitor Provider, General 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 existing Monitoring Endpoints
--property {property}
| Description | The name of a property to be displayedSee properties for Monitoring Endpoint or one of its subcomponents StatsD Monitoring Endpoint in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Notification Managers
--property {property}
| Description | The name of a property to be displayedSee properties for Notification Manager or one of its subcomponents Third Party Notification Manager in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing OAuth Token Handlers
--property {property}
| Description | The name of a property to be displayedSee 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 existing Obscured Values
--property {property}
| Description | The name of a property to be displayedSee properties for Obscured Value in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing OTP Delivery Mechanisms
--property {property}
| Description | The name of a property to be displayedSee 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 existing Pass Through Authentication Handlers
--property {property}
| Description | The name of a property to be displayedSee properties for Pass Through Authentication Handler or one of its subcomponents Aggregate Pass Through Authentication Handler, LDAP Pass Through Authentication Handler, PingOne Pass Through Authentication Handler, Third Party Pass Through Authentication Handler in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Passphrase Providers
--property {property}
| Description | The name of a property to be displayedSee properties for Passphrase Provider or one of its subcomponents Amazon Secrets Manager Passphrase Provider, Azure Key Vault Passphrase Provider, Conjur Passphrase Provider, Environment Variable Passphrase Provider, File Based Passphrase Provider, Obscured Value Passphrase Provider, Third Party Passphrase Provider, Vault Passphrase Provider in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Password Generators
--property {property}
| Description | The name of a property to be displayedSee 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 existing Password Policies
--property {property}
| Description | The name of a property to be displayedSee properties for Password Policy in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Password Storage Schemes
--property {property}
List existing Password Validators
--property {property}
| Description | The name of a property to be displayedSee properties for Password Validator or one of its subcomponents Attribute Value Password Validator, Character Set Password Validator, Dictionary Password Validator, Disallowed Characters 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, Utf 8 Password Validator in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Plugins
--property {property}
List existing Post LDIF Export Task Processors
--property {property}
| Description | The name of a property to be displayedSee properties for Post LDIF Export Task Processor or one of its subcomponents Third Party Post LDIF Export Task Processor, Upload To S3 Post LDIF Export Task Processor in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Prometheus Monitor Attribute Metrics
--extension-name {name}
| Description | The name of the Prometheus Monitoring HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Prometheus Monitor Attribute Metric in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
Describes managed objects and their properties
-c {category}
--category {category}
| Description | The category of components whose properties should be described. The list of categories is available in the 'Component' column in the output of 'dsconfig list-properties' |
| Required | No |
| Multi-Valued | No |
-t {type}
--type {type}
| Description | The type of components whose properties should be described. The value for TYPE must be one of the component types associated with the CATEGORY specified using the '--category' option. The list of categories is available in the 'Type' column in the output of 'dsconfig list-properties' |
| Required | No |
| Multi-Valued | No |
--inherited
| Description | Modifies the display output to show the inherited properties of components |
--complexity {level}
| Description | Specifies the maximum complexity level for items to display. Allowed values (in order of increasing complexity) are 'basic', 'standard', 'advanced', and 'expert'. Advanced properties will be shown when a value of 'advanced' or 'expert' is provided |
| Allowed Values |
basic standard advanced expert |
| Default Value | standard |
| Required | No |
| Multi-Valued | No |
--includeDescription
| Description | Indicates that the description for each property should be included in the output. This may create very long lines |
--property {property}
| Description | The name of a property to be displayed |
| Required | No |
| Multi-Valued | Yes |
List existing Recurring Task Chains
--property {property}
| Description | The name of a property to be displayedSee properties for Recurring Task Chain in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Recurring Tasks
--property {property}
| Description | The name of a property to be displayedSee properties for Recurring Task or one of its subcomponents Audit Data Security Recurring Task, Backup Recurring Task, Collect Support Data Recurring Task, Delay Recurring Task, Enter Lockdown Mode Recurring Task, Exec Recurring Task, File Retention Recurring Task, Generate Server Profile 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 existing Replication Assurance Policies
--property {property}
| Description | The name of a property to be displayedSee properties for Replication Assurance Policy in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Replication Domains
--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 displayedSee properties for Replication Domain in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Request Criteria
--property {property}
| Description | The name of a property to be displayedSee 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 existing REST Resource Types
--property {property}
| Description | The name of a property to be displayedSee 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 existing Result Code Maps
--property {property}
| Description | The name of a property to be displayedSee properties for Result Code Map in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Result Criteria
--property {property}
| Description | The name of a property to be displayedSee properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Replication Assurance Result Criteria, Simple Result Criteria, Successful Bind Result Criteria, Third Party Result Criteria in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Root DN Users
--property {property}
| Description | The name of a property to be displayed |
| Required | No |
| Multi-Valued | Yes |
List existing SASL Mechanism Handlers
--property {property}
| Description | The name of a property to be displayedSee 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, OAuth Bearer SASL Mechanism Handler, Ping Identity Inter Server 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 existing SCIM Attribute Mappings
--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 displayedSee properties for SCIM Attribute Mapping in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing SCIM Attributes
--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 displayedSee properties for SCIM Attribute in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing SCIM Resource Types
--property {property}
| Description | The name of a property to be displayedSee 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 existing SCIM Schemas
--property {property}
| Description | The name of a property to be displayedSee properties for SCIM Schema in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing SCIM Subattributes
--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 displayedSee properties for SCIM Subattribute in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Search Entry Criteria
--property {property}
| Description | The name of a property to be displayedSee 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 existing Search Reference Criteria
--property {property}
| Description | The name of a property to be displayedSee 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 existing Sensitive Attributes
--property {property}
| Description | The name of a property to be displayedSee properties for Sensitive Attribute in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Server Groups
--property {property}
| Description | The name of a property to be displayedSee properties for Server Group in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Server Instance Listeners
--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 displayedSee 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 existing Server Instances
--property {property}
| Description | The name of a property to be displayedSee properties for Server Instance or one of its subcomponents Authorize Server Instance, Directory Server Instance, Metrics Engine Server Instance, Proxy Server Instance, Sync Server Instance in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Soft Delete Policies
--property {property}
| Description | The name of a property to be displayedSee properties for Soft Delete Policy in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Synchronization Providers
--property {property}
| Description | The name of a property to be displayedSee properties for Synchronization Provider or one of its subcomponents Replication Synchronization Provider in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Token Claim Validations
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Token Claim Validation or one of its subcomponents Boolean Token Claim Validation, String Array Token Claim Validation, String Token Claim Validation in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Topology Admin Users
--property {property}
| Description | The name of a property to be displayed |
| Required | No |
| Multi-Valued | Yes |
List existing Trust Manager Providers
--property {property}
| Description | The name of a property to be displayedSee 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 existing Trusted Certificates
--property {property}
| Description | The name of a property to be displayedSee properties for Trusted Certificate in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Uncached Attribute Criteria
--property {property}
| Description | The name of a property to be displayedSee 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 existing Uncached Entry Criteria
--property {property}
| Description | The name of a property to be displayedSee 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 existing Vault Authentication Methods
--property {property}
| Description | The name of a property to be displayedSee 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 existing Velocity Context Providers
--extension-name {name}
| Description | The name of the Velocity HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee 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 existing Velocity Template Loaders
--extension-name {name}
| Description | The name of the Velocity HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--property {property}
| Description | The name of a property to be displayedSee properties for Velocity Template Loader in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
List existing Virtual Attributes
--property {property}
List existing Web Application Extensions
--property {property}
| Description | The name of a property to be displayedSee properties for Web Application Extension or one of its subcomponents Console Web Application Extension in the Server Configuration Reference. |
| Required | No |
| Multi-Valued | Yes |
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 {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 resetSee 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 |
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
--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 resetSee properties for Access Token Validator or one of its subcomponents Bind Access Token Validator, External API Gateway Access Token Validator, 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 |
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
--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 resetSee properties for Account Status Notification Handler or one of its subcomponents Admin Alert Account Status Notification Handler, 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 |
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 {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 resetSee 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 |
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
--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 resetSee properties for Alert Handler or one of its subcomponents Error Log Alert Handler, Exec Alert Handler, Scripted Alert Handler, JMX Alert Handler, Output 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 |
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
--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 resetSee 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 |
Modify Azure 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
--method-name {name}
| Description | The name of the Azure 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 resetSee properties for Azure Authentication Method or one of its subcomponents Client Secret Azure Authentication Method, Default Azure Authentication Method, Username Password Azure 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 |
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
--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 resetSee properties for Cipher Stream Provider or one of its subcomponents Amazon Key Management Service Cipher Stream Provider, Amazon Secrets Manager Cipher Stream Provider, Azure Key Vault Cipher Stream Provider, Conjur Cipher Stream Provider, Default Cipher Stream Provider, File Based Cipher Stream Provider, PKCS11 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 |
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
--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 resetSee 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 |
Modify Conjur 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
--method-name {name}
| Description | The name of the Conjur 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 resetSee properties for Conjur Authentication Method or one of its subcomponents API Key Conjur 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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 {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 resetSee 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 |
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
--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 resetSee 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 |
Modify Correlated LDAP Data View 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
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| 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 resetSee properties for Correlated LDAP Data View 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 |
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 {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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee properties for Data Security Auditor or one of its subcomponents Access Control Data Security Auditor, Account Usability Issues Data Security Auditor, Account Validity Window Data Security Auditor, Deprecated Password Storage Scheme Data Security Auditor, Disabled Account Data Security Auditor, Expired Password Data Security Auditor, Filter Data Security Auditor, Idle Account Data Security Auditor, Locked Account Data Security Auditor, Multiple Password Data Security Auditor, Nonexistent Password Policy Data Security Auditor, Privilege Data Security Auditor, Third Party 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee properties for Delegated Admin Attribute or one of its subcomponents Certificate Delegated Admin Attribute, Photo 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 |
Modify Delegated Admin Correlated REST Resource 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
--type-name {name}
| Description | The name of the REST Resource Type |
| Required | No |
| Multi-Valued | No |
--resource-name {name}
| Description | The name of the Delegated Admin Correlated REST Resource |
| 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 resetSee properties for Delegated Admin Correlated REST Resource 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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}
--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 |
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
--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 resetSee properties for External Server or one of its subcomponents HTTP External Server, LDAP External Server, Amazon Aws External Server, Conjur External Server, HTTP Proxy External Server, JDBC External Server, Kafka Cluster External Server, Mock External Server, SCIM2 External Server, SCIM External Server, SMTP External Server, Syslog External Server, Vault 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 |
Modify Failure Lockout Action 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
--action-name {name}
| Description | The name of the Failure Lockout Action |
| 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 resetSee properties for Failure Lockout Action or one of its subcomponents Delay Bind Response Failure Lockout Action, Lock Account Failure Lockout Action, No Operation Failure Lockout Action 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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 {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 resetSee 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 |
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
--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 resetSee properties for Group Implementation or one of its subcomponents Dynamic Group Implementation, Inverted Static 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 |
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 {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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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, JSON PDP API HTTP Servlet Extension, SCIM HTTP Servlet Extension, Metrics HTTP Servlet Extension, Open Banking HTTP Servlet Extension, PDP Endpoint HTTP Servlet Extension, Prometheus Monitoring 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 |
Modify ID 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
--validator-name {name}
| Description | The name of the ID 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 resetSee properties for ID Token Validator or one of its subcomponents OpenID Connect ID Token Validator, PingOne ID 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 |
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
--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 resetSee properties for Identity Mapper or one of its subcomponents Aggregate Identity Mapper, DN Identity Mapper, 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
Modify LDAP Correlation Attribute 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
--type-name {name}
| Description | The name of the SCIM Resource Type |
| Required | No |
| Multi-Valued | No |
--view-name {name}
| Description | The name of the Correlated LDAP Data View |
| Required | No |
| Multi-Valued | No |
--pair-name {name}
| Description | The name of the LDAP Correlation Attribute 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 resetSee properties for LDAP Correlation Attribute 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 |
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 {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 resetSee 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 |
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 {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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
Modify Log Field Behavior 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
--behavior-name {name}
| Description | The name of the Log Field Behavior |
| 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 resetSee properties for Log Field Behavior or one of its subcomponents JSON Formatted Access Log Field Behavior, Text Access Log Field Behavior 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 |
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
--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 resetSee 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 |
Modify Log Field 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
--syntax-name {name}
| Description | The name of the Log Field 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 resetSee properties for Log Field Syntax or one of its subcomponents Attribute Based Log Field Syntax, JSON Log Field 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 |
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
--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 resetSee 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, Upload To S3 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 |
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
--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 resetSee properties for Log Publisher or one of its subcomponents Access Log Publisher, HTTP Operation Log Publisher, Error Log Publisher, Sync Log Publisher, Debug Log Publisher, Policy Decision Log Publisher, Policy Query 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 |
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
--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 resetSee 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 |
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
--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 resetSee properties for Monitor Provider or one of its subcomponents Active Operations Monitor Provider, Client Connection Monitor Provider, Disk Space Usage Monitor Provider, Encryption Settings Database Accessibility Monitor Provider, Entry Cache Monitor Provider, General 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
Modify Pass Through Authentication 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
--handler-name {name}
| Description | The name of the Pass Through Authentication 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 resetSee properties for Pass Through Authentication Handler or one of its subcomponents Aggregate Pass Through Authentication Handler, LDAP Pass Through Authentication Handler, PingOne Pass Through Authentication Handler, Third Party Pass Through Authentication 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 |
Modify Passphrase 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
--provider-name {name}
| Description | The name of the Passphrase 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 resetSee properties for Passphrase Provider or one of its subcomponents Amazon Secrets Manager Passphrase Provider, Azure Key Vault Passphrase Provider, Conjur Passphrase Provider, Environment Variable Passphrase Provider, File Based Passphrase Provider, Obscured Value Passphrase Provider, Third Party Passphrase Provider, Vault Passphrase 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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}
--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 |
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
--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 resetSee properties for Password Validator or one of its subcomponents Attribute Value Password Validator, Character Set Password Validator, Dictionary Password Validator, Disallowed Characters 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, Utf 8 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 |
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
--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}
--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 |
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 {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 resetSee 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 |
Modify Post LDIF Export Task Processor 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
--processor-name {name}
| Description | The name of the Post LDIF Export Task Processor |
| 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 resetSee properties for Post LDIF Export Task Processor or one of its subcomponents Third Party Post LDIF Export Task Processor, Upload To S3 Post LDIF Export Task Processor 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 |
Modify Prometheus Monitor Attribute Metric 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
--extension-name {name}
| Description | The name of the Prometheus Monitoring HTTP Servlet Extension |
| Required | No |
| Multi-Valued | No |
--metric-name {name}
| Description | The name of the Prometheus Monitor Attribute Metric |
| 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 resetSee properties for Prometheus Monitor Attribute Metric 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 |
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
--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 resetSee 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 |
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
--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 resetSee properties for Recurring Task or one of its subcomponents Audit Data Security Recurring Task, Backup Recurring Task, Collect Support Data Recurring Task, Delay Recurring Task, Enter Lockdown Mode Recurring Task, Exec Recurring Task, File Retention Recurring Task, Generate Server Profile 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee properties for Result Criteria or one of its subcomponents Aggregate Result Criteria, Replication Assurance Result Criteria, Simple Result Criteria, Successful Bind 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 |
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 {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 resetSee 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 |
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
--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 |
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 {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 resetSee 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 |
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
--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 resetSee 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, OAuth Bearer SASL Mechanism Handler, Ping Identity Inter Server 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee properties for Server Instance or one of its subcomponents Authorize Server Instance, Directory 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
Modify Token Claim Validation 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
--validator-name {name}
| Description | The name of the ID Token Validator |
| Required | No |
| Multi-Valued | No |
--validation-name {name}
| Description | The name of the Token Claim Validation |
| 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 resetSee properties for Token Claim Validation or one of its subcomponents Boolean Token Claim Validation, String Array Token Claim Validation, String Token Claim Validation 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 |
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
--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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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 resetSee 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 |
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
--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}
--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 |
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
--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 resetSee 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 |
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 {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 resetSee 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 |
-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 |
--writePreSetupHeader
| Description | When operating in offline mode, write a header at the top of the LDIF file that allows setup to proceed even though changes have been applied. This is primarily intended only for the case in which the server is to be set up with a pre-existing encryption settings database and it is necessary to apply configuration changes for the cipher stream provider before invoking setup |
-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-Pipeline/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 |
--trustStoreFormat {trustStoreFormat}
| Description | Certificate truststore format |
| 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 |
--keyStoreFormat {keyStoreFormat}
| Description | Certificate keystore format |
| 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 |